diff --git a/ecs/api-ref/ALL_META.TXT.json b/docs/ecs/api-ref/ALL_META.TXT.json similarity index 100% rename from ecs/api-ref/ALL_META.TXT.json rename to docs/ecs/api-ref/ALL_META.TXT.json diff --git a/ecs/api-ref/CLASS.TXT.json b/docs/ecs/api-ref/CLASS.TXT.json similarity index 100% rename from ecs/api-ref/CLASS.TXT.json rename to docs/ecs/api-ref/CLASS.TXT.json diff --git a/ecs/api-ref/PARAMETERS.txt b/docs/ecs/api-ref/PARAMETERS.txt similarity index 100% rename from ecs/api-ref/PARAMETERS.txt rename to docs/ecs/api-ref/PARAMETERS.txt diff --git a/ecs/api-ref/en-us_topic_0000001207303618.html b/docs/ecs/api-ref/en-us_topic_0000001207303618.html similarity index 100% rename from ecs/api-ref/en-us_topic_0000001207303618.html rename to docs/ecs/api-ref/en-us_topic_0000001207303618.html diff --git a/ecs/api-ref/en-us_topic_0000001207623588.html b/docs/ecs/api-ref/en-us_topic_0000001207623588.html similarity index 100% rename from ecs/api-ref/en-us_topic_0000001207623588.html rename to docs/ecs/api-ref/en-us_topic_0000001207623588.html diff --git a/ecs/api-ref/en-us_topic_0000001207783562.html b/docs/ecs/api-ref/en-us_topic_0000001207783562.html similarity index 100% rename from ecs/api-ref/en-us_topic_0000001207783562.html rename to docs/ecs/api-ref/en-us_topic_0000001207783562.html diff --git a/ecs/api-ref/en-us_topic_0000001252143577.html b/docs/ecs/api-ref/en-us_topic_0000001252143577.html similarity index 100% rename from ecs/api-ref/en-us_topic_0000001252143577.html rename to docs/ecs/api-ref/en-us_topic_0000001252143577.html diff --git a/ecs/api-ref/en-us_topic_0000001252263549.html b/docs/ecs/api-ref/en-us_topic_0000001252263549.html similarity index 100% rename from ecs/api-ref/en-us_topic_0000001252263549.html rename to docs/ecs/api-ref/en-us_topic_0000001252263549.html diff --git a/ecs/api-ref/en-us_topic_0020212207.html b/docs/ecs/api-ref/en-us_topic_0020212207.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212207.html rename to docs/ecs/api-ref/en-us_topic_0020212207.html diff --git a/ecs/api-ref/en-us_topic_0020212648.html b/docs/ecs/api-ref/en-us_topic_0020212648.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212648.html rename to docs/ecs/api-ref/en-us_topic_0020212648.html diff --git a/ecs/api-ref/en-us_topic_0020212649.html b/docs/ecs/api-ref/en-us_topic_0020212649.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212649.html rename to docs/ecs/api-ref/en-us_topic_0020212649.html diff --git a/ecs/api-ref/en-us_topic_0020212650.html b/docs/ecs/api-ref/en-us_topic_0020212650.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212650.html rename to docs/ecs/api-ref/en-us_topic_0020212650.html diff --git a/ecs/api-ref/en-us_topic_0020212651.html b/docs/ecs/api-ref/en-us_topic_0020212651.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212651.html rename to docs/ecs/api-ref/en-us_topic_0020212651.html diff --git a/ecs/api-ref/en-us_topic_0020212652.html b/docs/ecs/api-ref/en-us_topic_0020212652.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212652.html rename to docs/ecs/api-ref/en-us_topic_0020212652.html diff --git a/ecs/api-ref/en-us_topic_0020212653.html b/docs/ecs/api-ref/en-us_topic_0020212653.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212653.html rename to docs/ecs/api-ref/en-us_topic_0020212653.html diff --git a/ecs/api-ref/en-us_topic_0020212655.html b/docs/ecs/api-ref/en-us_topic_0020212655.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212655.html rename to docs/ecs/api-ref/en-us_topic_0020212655.html diff --git a/ecs/api-ref/en-us_topic_0020212656.html b/docs/ecs/api-ref/en-us_topic_0020212656.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212656.html rename to docs/ecs/api-ref/en-us_topic_0020212656.html diff --git a/ecs/api-ref/en-us_topic_0020212657.html b/docs/ecs/api-ref/en-us_topic_0020212657.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212657.html rename to docs/ecs/api-ref/en-us_topic_0020212657.html diff --git a/ecs/api-ref/en-us_topic_0020212658.html b/docs/ecs/api-ref/en-us_topic_0020212658.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212658.html rename to docs/ecs/api-ref/en-us_topic_0020212658.html diff --git a/ecs/api-ref/en-us_topic_0020212659.html b/docs/ecs/api-ref/en-us_topic_0020212659.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212659.html rename to docs/ecs/api-ref/en-us_topic_0020212659.html diff --git a/ecs/api-ref/en-us_topic_0020212660.html b/docs/ecs/api-ref/en-us_topic_0020212660.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212660.html rename to docs/ecs/api-ref/en-us_topic_0020212660.html diff --git a/ecs/api-ref/en-us_topic_0020212661.html b/docs/ecs/api-ref/en-us_topic_0020212661.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212661.html rename to docs/ecs/api-ref/en-us_topic_0020212661.html diff --git a/ecs/api-ref/en-us_topic_0020212662.html b/docs/ecs/api-ref/en-us_topic_0020212662.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212662.html rename to docs/ecs/api-ref/en-us_topic_0020212662.html diff --git a/ecs/api-ref/en-us_topic_0020212663.html b/docs/ecs/api-ref/en-us_topic_0020212663.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212663.html rename to docs/ecs/api-ref/en-us_topic_0020212663.html diff --git a/ecs/api-ref/en-us_topic_0020212664.html b/docs/ecs/api-ref/en-us_topic_0020212664.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212664.html rename to docs/ecs/api-ref/en-us_topic_0020212664.html diff --git a/ecs/api-ref/en-us_topic_0020212665.html b/docs/ecs/api-ref/en-us_topic_0020212665.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212665.html rename to docs/ecs/api-ref/en-us_topic_0020212665.html diff --git a/ecs/api-ref/en-us_topic_0020212666.html b/docs/ecs/api-ref/en-us_topic_0020212666.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212666.html rename to docs/ecs/api-ref/en-us_topic_0020212666.html diff --git a/ecs/api-ref/en-us_topic_0020212667.html b/docs/ecs/api-ref/en-us_topic_0020212667.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212667.html rename to docs/ecs/api-ref/en-us_topic_0020212667.html diff --git a/ecs/api-ref/en-us_topic_0020212668.html b/docs/ecs/api-ref/en-us_topic_0020212668.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212668.html rename to docs/ecs/api-ref/en-us_topic_0020212668.html diff --git a/ecs/api-ref/en-us_topic_0020212671.html b/docs/ecs/api-ref/en-us_topic_0020212671.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212671.html rename to docs/ecs/api-ref/en-us_topic_0020212671.html diff --git a/ecs/api-ref/en-us_topic_0020212672.html b/docs/ecs/api-ref/en-us_topic_0020212672.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212672.html rename to docs/ecs/api-ref/en-us_topic_0020212672.html diff --git a/ecs/api-ref/en-us_topic_0020212673.html b/docs/ecs/api-ref/en-us_topic_0020212673.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212673.html rename to docs/ecs/api-ref/en-us_topic_0020212673.html diff --git a/ecs/api-ref/en-us_topic_0020212674.html b/docs/ecs/api-ref/en-us_topic_0020212674.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212674.html rename to docs/ecs/api-ref/en-us_topic_0020212674.html diff --git a/ecs/api-ref/en-us_topic_0020212675.html b/docs/ecs/api-ref/en-us_topic_0020212675.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212675.html rename to docs/ecs/api-ref/en-us_topic_0020212675.html diff --git a/ecs/api-ref/en-us_topic_0020212676.html b/docs/ecs/api-ref/en-us_topic_0020212676.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212676.html rename to docs/ecs/api-ref/en-us_topic_0020212676.html diff --git a/ecs/api-ref/en-us_topic_0020212677.html b/docs/ecs/api-ref/en-us_topic_0020212677.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212677.html rename to docs/ecs/api-ref/en-us_topic_0020212677.html diff --git a/ecs/api-ref/en-us_topic_0020212678.html b/docs/ecs/api-ref/en-us_topic_0020212678.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212678.html rename to docs/ecs/api-ref/en-us_topic_0020212678.html diff --git a/ecs/api-ref/en-us_topic_0020212679.html b/docs/ecs/api-ref/en-us_topic_0020212679.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212679.html rename to docs/ecs/api-ref/en-us_topic_0020212679.html diff --git a/ecs/api-ref/en-us_topic_0020212680.html b/docs/ecs/api-ref/en-us_topic_0020212680.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212680.html rename to docs/ecs/api-ref/en-us_topic_0020212680.html diff --git a/ecs/api-ref/en-us_topic_0020212688.html b/docs/ecs/api-ref/en-us_topic_0020212688.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212688.html rename to docs/ecs/api-ref/en-us_topic_0020212688.html diff --git a/ecs/api-ref/en-us_topic_0020212689.html b/docs/ecs/api-ref/en-us_topic_0020212689.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212689.html rename to docs/ecs/api-ref/en-us_topic_0020212689.html diff --git a/ecs/api-ref/en-us_topic_0020212690.html b/docs/ecs/api-ref/en-us_topic_0020212690.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212690.html rename to docs/ecs/api-ref/en-us_topic_0020212690.html diff --git a/ecs/api-ref/en-us_topic_0020212691.html b/docs/ecs/api-ref/en-us_topic_0020212691.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212691.html rename to docs/ecs/api-ref/en-us_topic_0020212691.html diff --git a/ecs/api-ref/en-us_topic_0020212692.html b/docs/ecs/api-ref/en-us_topic_0020212692.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020212692.html rename to docs/ecs/api-ref/en-us_topic_0020212692.html diff --git a/ecs/api-ref/en-us_topic_0020805967.html b/docs/ecs/api-ref/en-us_topic_0020805967.html similarity index 100% rename from ecs/api-ref/en-us_topic_0020805967.html rename to docs/ecs/api-ref/en-us_topic_0020805967.html diff --git a/ecs/api-ref/en-us_topic_0022067588.html b/docs/ecs/api-ref/en-us_topic_0022067588.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067588.html rename to docs/ecs/api-ref/en-us_topic_0022067588.html diff --git a/ecs/api-ref/en-us_topic_0022067713.html b/docs/ecs/api-ref/en-us_topic_0022067713.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067713.html rename to docs/ecs/api-ref/en-us_topic_0022067713.html diff --git a/ecs/api-ref/en-us_topic_0022067714.html b/docs/ecs/api-ref/en-us_topic_0022067714.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067714.html rename to docs/ecs/api-ref/en-us_topic_0022067714.html diff --git a/ecs/api-ref/en-us_topic_0022067715.html b/docs/ecs/api-ref/en-us_topic_0022067715.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067715.html rename to docs/ecs/api-ref/en-us_topic_0022067715.html diff --git a/ecs/api-ref/en-us_topic_0022067716.html b/docs/ecs/api-ref/en-us_topic_0022067716.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067716.html rename to docs/ecs/api-ref/en-us_topic_0022067716.html diff --git a/ecs/api-ref/en-us_topic_0022067717.html b/docs/ecs/api-ref/en-us_topic_0022067717.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067717.html rename to docs/ecs/api-ref/en-us_topic_0022067717.html diff --git a/ecs/api-ref/en-us_topic_0022067718.html b/docs/ecs/api-ref/en-us_topic_0022067718.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067718.html rename to docs/ecs/api-ref/en-us_topic_0022067718.html diff --git a/ecs/api-ref/en-us_topic_0022067719.html b/docs/ecs/api-ref/en-us_topic_0022067719.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022067719.html rename to docs/ecs/api-ref/en-us_topic_0022067719.html diff --git a/ecs/api-ref/en-us_topic_0022225397.html b/docs/ecs/api-ref/en-us_topic_0022225397.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022225397.html rename to docs/ecs/api-ref/en-us_topic_0022225397.html diff --git a/ecs/api-ref/en-us_topic_0022225398.html b/docs/ecs/api-ref/en-us_topic_0022225398.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022225398.html rename to docs/ecs/api-ref/en-us_topic_0022225398.html diff --git a/ecs/api-ref/en-us_topic_0022472987.html b/docs/ecs/api-ref/en-us_topic_0022472987.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022472987.html rename to docs/ecs/api-ref/en-us_topic_0022472987.html diff --git a/ecs/api-ref/en-us_topic_0022472988.html b/docs/ecs/api-ref/en-us_topic_0022472988.html similarity index 100% rename from ecs/api-ref/en-us_topic_0022472988.html rename to docs/ecs/api-ref/en-us_topic_0022472988.html diff --git a/ecs/api-ref/en-us_topic_0024734483.html b/docs/ecs/api-ref/en-us_topic_0024734483.html similarity index 100% rename from ecs/api-ref/en-us_topic_0024734483.html rename to docs/ecs/api-ref/en-us_topic_0024734483.html diff --git a/ecs/api-ref/en-us_topic_0025560296.html b/docs/ecs/api-ref/en-us_topic_0025560296.html similarity index 100% rename from ecs/api-ref/en-us_topic_0025560296.html rename to docs/ecs/api-ref/en-us_topic_0025560296.html diff --git a/ecs/api-ref/en-us_topic_0025560298.html b/docs/ecs/api-ref/en-us_topic_0025560298.html similarity index 100% rename from ecs/api-ref/en-us_topic_0025560298.html rename to docs/ecs/api-ref/en-us_topic_0025560298.html diff --git a/ecs/api-ref/en-us_topic_0025560299.html b/docs/ecs/api-ref/en-us_topic_0025560299.html similarity index 100% rename from ecs/api-ref/en-us_topic_0025560299.html rename to docs/ecs/api-ref/en-us_topic_0025560299.html diff --git a/ecs/api-ref/en-us_topic_0025567413.html b/docs/ecs/api-ref/en-us_topic_0025567413.html similarity index 100% rename from ecs/api-ref/en-us_topic_0025567413.html rename to docs/ecs/api-ref/en-us_topic_0025567413.html diff --git a/ecs/api-ref/en-us_topic_0028714261.html b/docs/ecs/api-ref/en-us_topic_0028714261.html similarity index 100% rename from ecs/api-ref/en-us_topic_0028714261.html rename to docs/ecs/api-ref/en-us_topic_0028714261.html diff --git a/ecs/api-ref/en-us_topic_0028714262.html b/docs/ecs/api-ref/en-us_topic_0028714262.html similarity index 100% rename from ecs/api-ref/en-us_topic_0028714262.html rename to docs/ecs/api-ref/en-us_topic_0028714262.html diff --git a/ecs/api-ref/en-us_topic_0028714263.html b/docs/ecs/api-ref/en-us_topic_0028714263.html similarity index 100% rename from ecs/api-ref/en-us_topic_0028714263.html rename to docs/ecs/api-ref/en-us_topic_0028714263.html diff --git a/ecs/api-ref/en-us_topic_0031167350.html b/docs/ecs/api-ref/en-us_topic_0031167350.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031167350.html rename to docs/ecs/api-ref/en-us_topic_0031167350.html diff --git a/ecs/api-ref/en-us_topic_0031167513.html b/docs/ecs/api-ref/en-us_topic_0031167513.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031167513.html rename to docs/ecs/api-ref/en-us_topic_0031167513.html diff --git a/ecs/api-ref/en-us_topic_0031167514.html b/docs/ecs/api-ref/en-us_topic_0031167514.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031167514.html rename to docs/ecs/api-ref/en-us_topic_0031167514.html diff --git a/ecs/api-ref/en-us_topic_0031169058.html b/docs/ecs/api-ref/en-us_topic_0031169058.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031169058.html rename to docs/ecs/api-ref/en-us_topic_0031169058.html diff --git a/ecs/api-ref/en-us_topic_0031169059.html b/docs/ecs/api-ref/en-us_topic_0031169059.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031169059.html rename to docs/ecs/api-ref/en-us_topic_0031169059.html diff --git a/ecs/api-ref/en-us_topic_0031169828.html b/docs/ecs/api-ref/en-us_topic_0031169828.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031169828.html rename to docs/ecs/api-ref/en-us_topic_0031169828.html diff --git a/ecs/api-ref/en-us_topic_0031176553.html b/docs/ecs/api-ref/en-us_topic_0031176553.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031176553.html rename to docs/ecs/api-ref/en-us_topic_0031176553.html diff --git a/ecs/api-ref/en-us_topic_0031176554.html b/docs/ecs/api-ref/en-us_topic_0031176554.html similarity index 100% rename from ecs/api-ref/en-us_topic_0031176554.html rename to docs/ecs/api-ref/en-us_topic_0031176554.html diff --git a/ecs/api-ref/en-us_topic_0065792792.html b/docs/ecs/api-ref/en-us_topic_0065792792.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065792792.html rename to docs/ecs/api-ref/en-us_topic_0065792792.html diff --git a/ecs/api-ref/en-us_topic_0065792793.html b/docs/ecs/api-ref/en-us_topic_0065792793.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065792793.html rename to docs/ecs/api-ref/en-us_topic_0065792793.html diff --git a/ecs/api-ref/en-us_topic_0065792794.html b/docs/ecs/api-ref/en-us_topic_0065792794.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065792794.html rename to docs/ecs/api-ref/en-us_topic_0065792794.html diff --git a/ecs/api-ref/en-us_topic_0065817680.html b/docs/ecs/api-ref/en-us_topic_0065817680.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817680.html rename to docs/ecs/api-ref/en-us_topic_0065817680.html diff --git a/ecs/api-ref/en-us_topic_0065817681.html b/docs/ecs/api-ref/en-us_topic_0065817681.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817681.html rename to docs/ecs/api-ref/en-us_topic_0065817681.html diff --git a/ecs/api-ref/en-us_topic_0065817682.html b/docs/ecs/api-ref/en-us_topic_0065817682.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817682.html rename to docs/ecs/api-ref/en-us_topic_0065817682.html diff --git a/ecs/api-ref/en-us_topic_0065817683.html b/docs/ecs/api-ref/en-us_topic_0065817683.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817683.html rename to docs/ecs/api-ref/en-us_topic_0065817683.html diff --git a/ecs/api-ref/en-us_topic_0065817684.html b/docs/ecs/api-ref/en-us_topic_0065817684.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817684.html rename to docs/ecs/api-ref/en-us_topic_0065817684.html diff --git a/ecs/api-ref/en-us_topic_0065817686.html b/docs/ecs/api-ref/en-us_topic_0065817686.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817686.html rename to docs/ecs/api-ref/en-us_topic_0065817686.html diff --git a/ecs/api-ref/en-us_topic_0065817688.html b/docs/ecs/api-ref/en-us_topic_0065817688.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817688.html rename to docs/ecs/api-ref/en-us_topic_0065817688.html diff --git a/ecs/api-ref/en-us_topic_0065817689.html b/docs/ecs/api-ref/en-us_topic_0065817689.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817689.html rename to docs/ecs/api-ref/en-us_topic_0065817689.html diff --git a/ecs/api-ref/en-us_topic_0065817690.html b/docs/ecs/api-ref/en-us_topic_0065817690.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817690.html rename to docs/ecs/api-ref/en-us_topic_0065817690.html diff --git a/ecs/api-ref/en-us_topic_0065817691.html b/docs/ecs/api-ref/en-us_topic_0065817691.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817691.html rename to docs/ecs/api-ref/en-us_topic_0065817691.html diff --git a/ecs/api-ref/en-us_topic_0065817692.html b/docs/ecs/api-ref/en-us_topic_0065817692.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817692.html rename to docs/ecs/api-ref/en-us_topic_0065817692.html diff --git a/ecs/api-ref/en-us_topic_0065817693.html b/docs/ecs/api-ref/en-us_topic_0065817693.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817693.html rename to docs/ecs/api-ref/en-us_topic_0065817693.html diff --git a/ecs/api-ref/en-us_topic_0065817694.html b/docs/ecs/api-ref/en-us_topic_0065817694.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817694.html rename to docs/ecs/api-ref/en-us_topic_0065817694.html diff --git a/ecs/api-ref/en-us_topic_0065817695.html b/docs/ecs/api-ref/en-us_topic_0065817695.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817695.html rename to docs/ecs/api-ref/en-us_topic_0065817695.html diff --git a/ecs/api-ref/en-us_topic_0065817696.html b/docs/ecs/api-ref/en-us_topic_0065817696.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817696.html rename to docs/ecs/api-ref/en-us_topic_0065817696.html diff --git a/ecs/api-ref/en-us_topic_0065817697.html b/docs/ecs/api-ref/en-us_topic_0065817697.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817697.html rename to docs/ecs/api-ref/en-us_topic_0065817697.html diff --git a/ecs/api-ref/en-us_topic_0065817698.html b/docs/ecs/api-ref/en-us_topic_0065817698.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817698.html rename to docs/ecs/api-ref/en-us_topic_0065817698.html diff --git a/ecs/api-ref/en-us_topic_0065817699.html b/docs/ecs/api-ref/en-us_topic_0065817699.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817699.html rename to docs/ecs/api-ref/en-us_topic_0065817699.html diff --git a/ecs/api-ref/en-us_topic_0065817700.html b/docs/ecs/api-ref/en-us_topic_0065817700.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817700.html rename to docs/ecs/api-ref/en-us_topic_0065817700.html diff --git a/ecs/api-ref/en-us_topic_0065817701.html b/docs/ecs/api-ref/en-us_topic_0065817701.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817701.html rename to docs/ecs/api-ref/en-us_topic_0065817701.html diff --git a/ecs/api-ref/en-us_topic_0065817702.html b/docs/ecs/api-ref/en-us_topic_0065817702.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817702.html rename to docs/ecs/api-ref/en-us_topic_0065817702.html diff --git a/ecs/api-ref/en-us_topic_0065817703.html b/docs/ecs/api-ref/en-us_topic_0065817703.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817703.html rename to docs/ecs/api-ref/en-us_topic_0065817703.html diff --git a/ecs/api-ref/en-us_topic_0065817704.html b/docs/ecs/api-ref/en-us_topic_0065817704.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817704.html rename to docs/ecs/api-ref/en-us_topic_0065817704.html diff --git a/ecs/api-ref/en-us_topic_0065817705.html b/docs/ecs/api-ref/en-us_topic_0065817705.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817705.html rename to docs/ecs/api-ref/en-us_topic_0065817705.html diff --git a/ecs/api-ref/en-us_topic_0065817706.html b/docs/ecs/api-ref/en-us_topic_0065817706.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817706.html rename to docs/ecs/api-ref/en-us_topic_0065817706.html diff --git a/ecs/api-ref/en-us_topic_0065817707.html b/docs/ecs/api-ref/en-us_topic_0065817707.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817707.html rename to docs/ecs/api-ref/en-us_topic_0065817707.html diff --git a/ecs/api-ref/en-us_topic_0065817708.html b/docs/ecs/api-ref/en-us_topic_0065817708.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817708.html rename to docs/ecs/api-ref/en-us_topic_0065817708.html diff --git a/ecs/api-ref/en-us_topic_0065817709.html b/docs/ecs/api-ref/en-us_topic_0065817709.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817709.html rename to docs/ecs/api-ref/en-us_topic_0065817709.html diff --git a/ecs/api-ref/en-us_topic_0065817710.html b/docs/ecs/api-ref/en-us_topic_0065817710.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817710.html rename to docs/ecs/api-ref/en-us_topic_0065817710.html diff --git a/ecs/api-ref/en-us_topic_0065817711.html b/docs/ecs/api-ref/en-us_topic_0065817711.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817711.html rename to docs/ecs/api-ref/en-us_topic_0065817711.html diff --git a/ecs/api-ref/en-us_topic_0065817712.html b/docs/ecs/api-ref/en-us_topic_0065817712.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817712.html rename to docs/ecs/api-ref/en-us_topic_0065817712.html diff --git a/ecs/api-ref/en-us_topic_0065817713.html b/docs/ecs/api-ref/en-us_topic_0065817713.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817713.html rename to docs/ecs/api-ref/en-us_topic_0065817713.html diff --git a/ecs/api-ref/en-us_topic_0065817714.html b/docs/ecs/api-ref/en-us_topic_0065817714.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817714.html rename to docs/ecs/api-ref/en-us_topic_0065817714.html diff --git a/ecs/api-ref/en-us_topic_0065817716.html b/docs/ecs/api-ref/en-us_topic_0065817716.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817716.html rename to docs/ecs/api-ref/en-us_topic_0065817716.html diff --git a/ecs/api-ref/en-us_topic_0065817717.html b/docs/ecs/api-ref/en-us_topic_0065817717.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817717.html rename to docs/ecs/api-ref/en-us_topic_0065817717.html diff --git a/ecs/api-ref/en-us_topic_0065817718.html b/docs/ecs/api-ref/en-us_topic_0065817718.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817718.html rename to docs/ecs/api-ref/en-us_topic_0065817718.html diff --git a/ecs/api-ref/en-us_topic_0065817719.html b/docs/ecs/api-ref/en-us_topic_0065817719.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817719.html rename to docs/ecs/api-ref/en-us_topic_0065817719.html diff --git a/ecs/api-ref/en-us_topic_0065817720.html b/docs/ecs/api-ref/en-us_topic_0065817720.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817720.html rename to docs/ecs/api-ref/en-us_topic_0065817720.html diff --git a/ecs/api-ref/en-us_topic_0065817721.html b/docs/ecs/api-ref/en-us_topic_0065817721.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817721.html rename to docs/ecs/api-ref/en-us_topic_0065817721.html diff --git a/ecs/api-ref/en-us_topic_0065817722.html b/docs/ecs/api-ref/en-us_topic_0065817722.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817722.html rename to docs/ecs/api-ref/en-us_topic_0065817722.html diff --git a/ecs/api-ref/en-us_topic_0065817723.html b/docs/ecs/api-ref/en-us_topic_0065817723.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817723.html rename to docs/ecs/api-ref/en-us_topic_0065817723.html diff --git a/ecs/api-ref/en-us_topic_0065817728.html b/docs/ecs/api-ref/en-us_topic_0065817728.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065817728.html rename to docs/ecs/api-ref/en-us_topic_0065817728.html diff --git a/ecs/api-ref/en-us_topic_0065820816.html b/docs/ecs/api-ref/en-us_topic_0065820816.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820816.html rename to docs/ecs/api-ref/en-us_topic_0065820816.html diff --git a/ecs/api-ref/en-us_topic_0065820817.html b/docs/ecs/api-ref/en-us_topic_0065820817.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820817.html rename to docs/ecs/api-ref/en-us_topic_0065820817.html diff --git a/ecs/api-ref/en-us_topic_0065820818.html b/docs/ecs/api-ref/en-us_topic_0065820818.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820818.html rename to docs/ecs/api-ref/en-us_topic_0065820818.html diff --git a/ecs/api-ref/en-us_topic_0065820819.html b/docs/ecs/api-ref/en-us_topic_0065820819.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820819.html rename to docs/ecs/api-ref/en-us_topic_0065820819.html diff --git a/ecs/api-ref/en-us_topic_0065820820.html b/docs/ecs/api-ref/en-us_topic_0065820820.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820820.html rename to docs/ecs/api-ref/en-us_topic_0065820820.html diff --git a/ecs/api-ref/en-us_topic_0065820821.html b/docs/ecs/api-ref/en-us_topic_0065820821.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820821.html rename to docs/ecs/api-ref/en-us_topic_0065820821.html diff --git a/ecs/api-ref/en-us_topic_0065820822.html b/docs/ecs/api-ref/en-us_topic_0065820822.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820822.html rename to docs/ecs/api-ref/en-us_topic_0065820822.html diff --git a/ecs/api-ref/en-us_topic_0065820823.html b/docs/ecs/api-ref/en-us_topic_0065820823.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820823.html rename to docs/ecs/api-ref/en-us_topic_0065820823.html diff --git a/ecs/api-ref/en-us_topic_0065820824.html b/docs/ecs/api-ref/en-us_topic_0065820824.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820824.html rename to docs/ecs/api-ref/en-us_topic_0065820824.html diff --git a/ecs/api-ref/en-us_topic_0065820825.html b/docs/ecs/api-ref/en-us_topic_0065820825.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820825.html rename to docs/ecs/api-ref/en-us_topic_0065820825.html diff --git a/ecs/api-ref/en-us_topic_0065820826.html b/docs/ecs/api-ref/en-us_topic_0065820826.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820826.html rename to docs/ecs/api-ref/en-us_topic_0065820826.html diff --git a/ecs/api-ref/en-us_topic_0065820827.html b/docs/ecs/api-ref/en-us_topic_0065820827.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065820827.html rename to docs/ecs/api-ref/en-us_topic_0065820827.html diff --git a/ecs/api-ref/en-us_topic_0065827313.html b/docs/ecs/api-ref/en-us_topic_0065827313.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065827313.html rename to docs/ecs/api-ref/en-us_topic_0065827313.html diff --git a/ecs/api-ref/en-us_topic_0065962596.html b/docs/ecs/api-ref/en-us_topic_0065962596.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065962596.html rename to docs/ecs/api-ref/en-us_topic_0065962596.html diff --git a/ecs/api-ref/en-us_topic_0065962597.html b/docs/ecs/api-ref/en-us_topic_0065962597.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065962597.html rename to docs/ecs/api-ref/en-us_topic_0065962597.html diff --git a/ecs/api-ref/en-us_topic_0065962598.html b/docs/ecs/api-ref/en-us_topic_0065962598.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065962598.html rename to docs/ecs/api-ref/en-us_topic_0065962598.html diff --git a/ecs/api-ref/en-us_topic_0065962599.html b/docs/ecs/api-ref/en-us_topic_0065962599.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065962599.html rename to docs/ecs/api-ref/en-us_topic_0065962599.html diff --git a/ecs/api-ref/en-us_topic_0065962600.html b/docs/ecs/api-ref/en-us_topic_0065962600.html similarity index 100% rename from ecs/api-ref/en-us_topic_0065962600.html rename to docs/ecs/api-ref/en-us_topic_0065962600.html diff --git a/ecs/api-ref/en-us_topic_0067161469.html b/docs/ecs/api-ref/en-us_topic_0067161469.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067161469.html rename to docs/ecs/api-ref/en-us_topic_0067161469.html diff --git a/ecs/api-ref/en-us_topic_0067161717.html b/docs/ecs/api-ref/en-us_topic_0067161717.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067161717.html rename to docs/ecs/api-ref/en-us_topic_0067161717.html diff --git a/ecs/api-ref/en-us_topic_0067298110.html b/docs/ecs/api-ref/en-us_topic_0067298110.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067298110.html rename to docs/ecs/api-ref/en-us_topic_0067298110.html diff --git a/ecs/api-ref/en-us_topic_0067600148.html b/docs/ecs/api-ref/en-us_topic_0067600148.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067600148.html rename to docs/ecs/api-ref/en-us_topic_0067600148.html diff --git a/ecs/api-ref/en-us_topic_0067876349.html b/docs/ecs/api-ref/en-us_topic_0067876349.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067876349.html rename to docs/ecs/api-ref/en-us_topic_0067876349.html diff --git a/ecs/api-ref/en-us_topic_0067876971.html b/docs/ecs/api-ref/en-us_topic_0067876971.html similarity index 100% rename from ecs/api-ref/en-us_topic_0067876971.html rename to docs/ecs/api-ref/en-us_topic_0067876971.html diff --git a/ecs/api-ref/en-us_topic_0068473331.html b/docs/ecs/api-ref/en-us_topic_0068473331.html similarity index 100% rename from ecs/api-ref/en-us_topic_0068473331.html rename to docs/ecs/api-ref/en-us_topic_0068473331.html diff --git a/ecs/api-ref/en-us_topic_0077847902.html b/docs/ecs/api-ref/en-us_topic_0077847902.html similarity index 100% rename from ecs/api-ref/en-us_topic_0077847902.html rename to docs/ecs/api-ref/en-us_topic_0077847902.html diff --git a/ecs/api-ref/en-us_topic_0081529857.html b/docs/ecs/api-ref/en-us_topic_0081529857.html similarity index 100% rename from ecs/api-ref/en-us_topic_0081529857.html rename to docs/ecs/api-ref/en-us_topic_0081529857.html diff --git a/ecs/api-ref/en-us_topic_0081950549.html b/docs/ecs/api-ref/en-us_topic_0081950549.html similarity index 100% rename from ecs/api-ref/en-us_topic_0081950549.html rename to docs/ecs/api-ref/en-us_topic_0081950549.html diff --git a/ecs/api-ref/en-us_topic_0081950550.html b/docs/ecs/api-ref/en-us_topic_0081950550.html similarity index 100% rename from ecs/api-ref/en-us_topic_0081950550.html rename to docs/ecs/api-ref/en-us_topic_0081950550.html diff --git a/ecs/api-ref/en-us_topic_0090187679.html b/docs/ecs/api-ref/en-us_topic_0090187679.html similarity index 100% rename from ecs/api-ref/en-us_topic_0090187679.html rename to docs/ecs/api-ref/en-us_topic_0090187679.html diff --git a/ecs/api-ref/en-us_topic_0090187680.html b/docs/ecs/api-ref/en-us_topic_0090187680.html similarity index 100% rename from ecs/api-ref/en-us_topic_0090187680.html rename to docs/ecs/api-ref/en-us_topic_0090187680.html diff --git a/ecs/api-ref/en-us_topic_0090187681.html b/docs/ecs/api-ref/en-us_topic_0090187681.html similarity index 100% rename from ecs/api-ref/en-us_topic_0090187681.html rename to docs/ecs/api-ref/en-us_topic_0090187681.html diff --git a/ecs/api-ref/en-us_topic_0101860613.html b/docs/ecs/api-ref/en-us_topic_0101860613.html similarity index 100% rename from ecs/api-ref/en-us_topic_0101860613.html rename to docs/ecs/api-ref/en-us_topic_0101860613.html diff --git a/ecs/api-ref/en-us_topic_0101860614.html b/docs/ecs/api-ref/en-us_topic_0101860614.html similarity index 100% rename from ecs/api-ref/en-us_topic_0101860614.html rename to docs/ecs/api-ref/en-us_topic_0101860614.html diff --git a/ecs/api-ref/en-us_topic_0102606095.html b/docs/ecs/api-ref/en-us_topic_0102606095.html similarity index 100% rename from ecs/api-ref/en-us_topic_0102606095.html rename to docs/ecs/api-ref/en-us_topic_0102606095.html diff --git a/ecs/api-ref/en-us_topic_0103071509.html b/docs/ecs/api-ref/en-us_topic_0103071509.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071509.html rename to docs/ecs/api-ref/en-us_topic_0103071509.html diff --git a/ecs/api-ref/en-us_topic_0103071510.html b/docs/ecs/api-ref/en-us_topic_0103071510.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071510.html rename to docs/ecs/api-ref/en-us_topic_0103071510.html diff --git a/ecs/api-ref/en-us_topic_0103071511.html b/docs/ecs/api-ref/en-us_topic_0103071511.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071511.html rename to docs/ecs/api-ref/en-us_topic_0103071511.html diff --git a/ecs/api-ref/en-us_topic_0103071513.html b/docs/ecs/api-ref/en-us_topic_0103071513.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071513.html rename to docs/ecs/api-ref/en-us_topic_0103071513.html diff --git a/ecs/api-ref/en-us_topic_0103071514.html b/docs/ecs/api-ref/en-us_topic_0103071514.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071514.html rename to docs/ecs/api-ref/en-us_topic_0103071514.html diff --git a/ecs/api-ref/en-us_topic_0103071515.html b/docs/ecs/api-ref/en-us_topic_0103071515.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071515.html rename to docs/ecs/api-ref/en-us_topic_0103071515.html diff --git a/ecs/api-ref/en-us_topic_0103071516.html b/docs/ecs/api-ref/en-us_topic_0103071516.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071516.html rename to docs/ecs/api-ref/en-us_topic_0103071516.html diff --git a/ecs/api-ref/en-us_topic_0103071517.html b/docs/ecs/api-ref/en-us_topic_0103071517.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071517.html rename to docs/ecs/api-ref/en-us_topic_0103071517.html diff --git a/ecs/api-ref/en-us_topic_0103071519.html b/docs/ecs/api-ref/en-us_topic_0103071519.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071519.html rename to docs/ecs/api-ref/en-us_topic_0103071519.html diff --git a/ecs/api-ref/en-us_topic_0103071520.html b/docs/ecs/api-ref/en-us_topic_0103071520.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071520.html rename to docs/ecs/api-ref/en-us_topic_0103071520.html diff --git a/ecs/api-ref/en-us_topic_0103071521.html b/docs/ecs/api-ref/en-us_topic_0103071521.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071521.html rename to docs/ecs/api-ref/en-us_topic_0103071521.html diff --git a/ecs/api-ref/en-us_topic_0103071522.html b/docs/ecs/api-ref/en-us_topic_0103071522.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103071522.html rename to docs/ecs/api-ref/en-us_topic_0103071522.html diff --git a/ecs/api-ref/en-us_topic_0103072347.html b/docs/ecs/api-ref/en-us_topic_0103072347.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103072347.html rename to docs/ecs/api-ref/en-us_topic_0103072347.html diff --git a/ecs/api-ref/en-us_topic_0103072348.html b/docs/ecs/api-ref/en-us_topic_0103072348.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103072348.html rename to docs/ecs/api-ref/en-us_topic_0103072348.html diff --git a/ecs/api-ref/en-us_topic_0103072349.html b/docs/ecs/api-ref/en-us_topic_0103072349.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103072349.html rename to docs/ecs/api-ref/en-us_topic_0103072349.html diff --git a/ecs/api-ref/en-us_topic_0103072350.html b/docs/ecs/api-ref/en-us_topic_0103072350.html similarity index 100% rename from ecs/api-ref/en-us_topic_0103072350.html rename to docs/ecs/api-ref/en-us_topic_0103072350.html diff --git a/ecs/api-ref/en-us_topic_0108433460.html b/docs/ecs/api-ref/en-us_topic_0108433460.html similarity index 100% rename from ecs/api-ref/en-us_topic_0108433460.html rename to docs/ecs/api-ref/en-us_topic_0108433460.html diff --git a/ecs/api-ref/en-us_topic_0108433461.html b/docs/ecs/api-ref/en-us_topic_0108433461.html similarity index 100% rename from ecs/api-ref/en-us_topic_0108433461.html rename to docs/ecs/api-ref/en-us_topic_0108433461.html diff --git a/ecs/api-ref/en-us_topic_0110472767.html b/docs/ecs/api-ref/en-us_topic_0110472767.html similarity index 100% rename from ecs/api-ref/en-us_topic_0110472767.html rename to docs/ecs/api-ref/en-us_topic_0110472767.html diff --git a/ecs/api-ref/en-us_topic_0111860831.html b/docs/ecs/api-ref/en-us_topic_0111860831.html similarity index 100% rename from ecs/api-ref/en-us_topic_0111860831.html rename to docs/ecs/api-ref/en-us_topic_0111860831.html diff --git a/ecs/api-ref/en-us_topic_0111860833.html b/docs/ecs/api-ref/en-us_topic_0111860833.html similarity index 100% rename from ecs/api-ref/en-us_topic_0111860833.html rename to docs/ecs/api-ref/en-us_topic_0111860833.html diff --git a/ecs/api-ref/en-us_topic_0112708160.html b/docs/ecs/api-ref/en-us_topic_0112708160.html similarity index 100% rename from ecs/api-ref/en-us_topic_0112708160.html rename to docs/ecs/api-ref/en-us_topic_0112708160.html diff --git a/ecs/api-ref/en-us_topic_0124385011.html b/docs/ecs/api-ref/en-us_topic_0124385011.html similarity index 100% rename from ecs/api-ref/en-us_topic_0124385011.html rename to docs/ecs/api-ref/en-us_topic_0124385011.html diff --git a/ecs/api-ref/en-us_topic_0124385012.html b/docs/ecs/api-ref/en-us_topic_0124385012.html similarity index 100% rename from ecs/api-ref/en-us_topic_0124385012.html rename to docs/ecs/api-ref/en-us_topic_0124385012.html diff --git a/ecs/api-ref/en-us_topic_0124385014.html b/docs/ecs/api-ref/en-us_topic_0124385014.html similarity index 100% rename from ecs/api-ref/en-us_topic_0124385014.html rename to docs/ecs/api-ref/en-us_topic_0124385014.html diff --git a/ecs/api-ref/en-us_topic_0124385015.html b/docs/ecs/api-ref/en-us_topic_0124385015.html similarity index 100% rename from ecs/api-ref/en-us_topic_0124385015.html rename to docs/ecs/api-ref/en-us_topic_0124385015.html diff --git a/ecs/api-ref/en-us_topic_0124385016.html b/docs/ecs/api-ref/en-us_topic_0124385016.html similarity index 100% rename from ecs/api-ref/en-us_topic_0124385016.html rename to docs/ecs/api-ref/en-us_topic_0124385016.html diff --git a/ecs/api-ref/en-us_topic_0132778339.html b/docs/ecs/api-ref/en-us_topic_0132778339.html similarity index 100% rename from ecs/api-ref/en-us_topic_0132778339.html rename to docs/ecs/api-ref/en-us_topic_0132778339.html diff --git a/ecs/api-ref/en-us_topic_0132905656.html b/docs/ecs/api-ref/en-us_topic_0132905656.html similarity index 100% rename from ecs/api-ref/en-us_topic_0132905656.html rename to docs/ecs/api-ref/en-us_topic_0132905656.html diff --git a/ecs/api-ref/en-us_topic_0133622595.html b/docs/ecs/api-ref/en-us_topic_0133622595.html similarity index 100% rename from ecs/api-ref/en-us_topic_0133622595.html rename to docs/ecs/api-ref/en-us_topic_0133622595.html diff --git a/ecs/api-ref/en-us_topic_0133622596.html b/docs/ecs/api-ref/en-us_topic_0133622596.html similarity index 100% rename from ecs/api-ref/en-us_topic_0133622596.html rename to docs/ecs/api-ref/en-us_topic_0133622596.html diff --git a/ecs/api-ref/en-us_topic_0142195138.html b/docs/ecs/api-ref/en-us_topic_0142195138.html similarity index 100% rename from ecs/api-ref/en-us_topic_0142195138.html rename to docs/ecs/api-ref/en-us_topic_0142195138.html diff --git a/ecs/api-ref/en-us_topic_0142195139.html b/docs/ecs/api-ref/en-us_topic_0142195139.html similarity index 100% rename from ecs/api-ref/en-us_topic_0142195139.html rename to docs/ecs/api-ref/en-us_topic_0142195139.html diff --git a/ecs/api-ref/en-us_topic_0142763126.html b/docs/ecs/api-ref/en-us_topic_0142763126.html similarity index 100% rename from ecs/api-ref/en-us_topic_0142763126.html rename to docs/ecs/api-ref/en-us_topic_0142763126.html diff --git a/ecs/api-ref/en-us_topic_0161097717.html b/docs/ecs/api-ref/en-us_topic_0161097717.html similarity index 100% rename from ecs/api-ref/en-us_topic_0161097717.html rename to docs/ecs/api-ref/en-us_topic_0161097717.html diff --git a/ecs/api-ref/en-us_topic_0161097718.html b/docs/ecs/api-ref/en-us_topic_0161097718.html similarity index 100% rename from ecs/api-ref/en-us_topic_0161097718.html rename to docs/ecs/api-ref/en-us_topic_0161097718.html diff --git a/ecs/api-ref/en-us_topic_0161097719.html b/docs/ecs/api-ref/en-us_topic_0161097719.html similarity index 100% rename from ecs/api-ref/en-us_topic_0161097719.html rename to docs/ecs/api-ref/en-us_topic_0161097719.html diff --git a/ecs/api-ref/en-us_topic_0161341998.html b/docs/ecs/api-ref/en-us_topic_0161341998.html similarity index 100% rename from ecs/api-ref/en-us_topic_0161341998.html rename to docs/ecs/api-ref/en-us_topic_0161341998.html diff --git a/ecs/api-ref/en-us_topic_0167809633.html b/docs/ecs/api-ref/en-us_topic_0167809633.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167809633.html rename to docs/ecs/api-ref/en-us_topic_0167809633.html diff --git a/ecs/api-ref/en-us_topic_0167809634.html b/docs/ecs/api-ref/en-us_topic_0167809634.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167809634.html rename to docs/ecs/api-ref/en-us_topic_0167809634.html diff --git a/ecs/api-ref/en-us_topic_0167811962.html b/docs/ecs/api-ref/en-us_topic_0167811962.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167811962.html rename to docs/ecs/api-ref/en-us_topic_0167811962.html diff --git a/ecs/api-ref/en-us_topic_0167811963.html b/docs/ecs/api-ref/en-us_topic_0167811963.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167811963.html rename to docs/ecs/api-ref/en-us_topic_0167811963.html diff --git a/ecs/api-ref/en-us_topic_0167811964.html b/docs/ecs/api-ref/en-us_topic_0167811964.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167811964.html rename to docs/ecs/api-ref/en-us_topic_0167811964.html diff --git a/ecs/api-ref/en-us_topic_0167811966.html b/docs/ecs/api-ref/en-us_topic_0167811966.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167811966.html rename to docs/ecs/api-ref/en-us_topic_0167811966.html diff --git a/ecs/api-ref/en-us_topic_0167811967.html b/docs/ecs/api-ref/en-us_topic_0167811967.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167811967.html rename to docs/ecs/api-ref/en-us_topic_0167811967.html diff --git a/ecs/api-ref/en-us_topic_0167816247.html b/docs/ecs/api-ref/en-us_topic_0167816247.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167816247.html rename to docs/ecs/api-ref/en-us_topic_0167816247.html diff --git a/ecs/api-ref/en-us_topic_0167957246.html b/docs/ecs/api-ref/en-us_topic_0167957246.html similarity index 100% rename from ecs/api-ref/en-us_topic_0167957246.html rename to docs/ecs/api-ref/en-us_topic_0167957246.html diff --git a/ecs/api-ref/en-us_topic_0169494074.html b/docs/ecs/api-ref/en-us_topic_0169494074.html similarity index 100% rename from ecs/api-ref/en-us_topic_0169494074.html rename to docs/ecs/api-ref/en-us_topic_0169494074.html diff --git a/ecs/api-ref/en-us_topic_0170710254.html b/docs/ecs/api-ref/en-us_topic_0170710254.html similarity index 100% rename from ecs/api-ref/en-us_topic_0170710254.html rename to docs/ecs/api-ref/en-us_topic_0170710254.html diff --git a/ecs/api-ref/en-us_topic_0175308115.html b/docs/ecs/api-ref/en-us_topic_0175308115.html similarity index 100% rename from ecs/api-ref/en-us_topic_0175308115.html rename to docs/ecs/api-ref/en-us_topic_0175308115.html diff --git a/ecs/api-ref/en-us_topic_0175597846.html b/docs/ecs/api-ref/en-us_topic_0175597846.html similarity index 100% rename from ecs/api-ref/en-us_topic_0175597846.html rename to docs/ecs/api-ref/en-us_topic_0175597846.html diff --git a/ecs/api-ref/en-us_topic_0175597847.html b/docs/ecs/api-ref/en-us_topic_0175597847.html similarity index 100% rename from ecs/api-ref/en-us_topic_0175597847.html rename to docs/ecs/api-ref/en-us_topic_0175597847.html diff --git a/ecs/api-ref/en-us_topic_0178420672.html b/docs/ecs/api-ref/en-us_topic_0178420672.html similarity index 100% rename from ecs/api-ref/en-us_topic_0178420672.html rename to docs/ecs/api-ref/en-us_topic_0178420672.html diff --git a/ecs/api-ref/en-us_topic_0184167662.html b/docs/ecs/api-ref/en-us_topic_0184167662.html similarity index 100% rename from ecs/api-ref/en-us_topic_0184167662.html rename to docs/ecs/api-ref/en-us_topic_0184167662.html diff --git a/ecs/api-ref/en-us_topic_0184192952.html b/docs/ecs/api-ref/en-us_topic_0184192952.html similarity index 100% rename from ecs/api-ref/en-us_topic_0184192952.html rename to docs/ecs/api-ref/en-us_topic_0184192952.html diff --git a/ecs/api-ref/en-us_topic_0267425395.html b/docs/ecs/api-ref/en-us_topic_0267425395.html similarity index 100% rename from ecs/api-ref/en-us_topic_0267425395.html rename to docs/ecs/api-ref/en-us_topic_0267425395.html diff --git a/ecs/api-ref/en-us_topic_0267427144.html b/docs/ecs/api-ref/en-us_topic_0267427144.html similarity index 100% rename from ecs/api-ref/en-us_topic_0267427144.html rename to docs/ecs/api-ref/en-us_topic_0267427144.html diff --git a/ecs/api-ref/en-us_topic_0267427881.html b/docs/ecs/api-ref/en-us_topic_0267427881.html similarity index 100% rename from ecs/api-ref/en-us_topic_0267427881.html rename to docs/ecs/api-ref/en-us_topic_0267427881.html diff --git a/ecs/api-ref/public_sys-resources/ExpandCollapse.js b/docs/ecs/api-ref/public_sys-resources/ExpandCollapse.js similarity index 100% rename from ecs/api-ref/public_sys-resources/ExpandCollapse.js rename to docs/ecs/api-ref/public_sys-resources/ExpandCollapse.js diff --git a/ecs/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/ecs/api-ref/public_sys-resources/caution_3.0-en-us.png similarity index 100% rename from ecs/api-ref/public_sys-resources/caution_3.0-en-us.png rename to docs/ecs/api-ref/public_sys-resources/caution_3.0-en-us.png diff --git a/ecs/api-ref/public_sys-resources/commonltr.css b/docs/ecs/api-ref/public_sys-resources/commonltr.css similarity index 100% rename from ecs/api-ref/public_sys-resources/commonltr.css rename to docs/ecs/api-ref/public_sys-resources/commonltr.css diff --git a/ecs/api-ref/public_sys-resources/commonltr_print.css b/docs/ecs/api-ref/public_sys-resources/commonltr_print.css similarity index 100% rename from ecs/api-ref/public_sys-resources/commonltr_print.css rename to docs/ecs/api-ref/public_sys-resources/commonltr_print.css diff --git a/ecs/api-ref/public_sys-resources/commonrtl.css b/docs/ecs/api-ref/public_sys-resources/commonrtl.css similarity index 100% rename from ecs/api-ref/public_sys-resources/commonrtl.css rename to docs/ecs/api-ref/public_sys-resources/commonrtl.css diff --git a/ecs/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/ecs/api-ref/public_sys-resources/danger_3.0-en-us.png similarity index 100% rename from ecs/api-ref/public_sys-resources/danger_3.0-en-us.png rename to docs/ecs/api-ref/public_sys-resources/danger_3.0-en-us.png diff --git a/ecs/api-ref/public_sys-resources/delta.gif b/docs/ecs/api-ref/public_sys-resources/delta.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/delta.gif rename to docs/ecs/api-ref/public_sys-resources/delta.gif diff --git a/ecs/api-ref/public_sys-resources/deltaend.gif b/docs/ecs/api-ref/public_sys-resources/deltaend.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/deltaend.gif rename to docs/ecs/api-ref/public_sys-resources/deltaend.gif diff --git a/ecs/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/ecs/api-ref/public_sys-resources/icon-arrowdn.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-arrowdn.gif rename to docs/ecs/api-ref/public_sys-resources/icon-arrowdn.gif diff --git a/ecs/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/ecs/api-ref/public_sys-resources/icon-arrowrt.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-arrowrt.gif rename to docs/ecs/api-ref/public_sys-resources/icon-arrowrt.gif diff --git a/ecs/api-ref/public_sys-resources/icon-caution.gif b/docs/ecs/api-ref/public_sys-resources/icon-caution.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-caution.gif rename to docs/ecs/api-ref/public_sys-resources/icon-caution.gif diff --git a/ecs/api-ref/public_sys-resources/icon-danger.gif b/docs/ecs/api-ref/public_sys-resources/icon-danger.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-danger.gif rename to docs/ecs/api-ref/public_sys-resources/icon-danger.gif diff --git a/ecs/api-ref/public_sys-resources/icon-huawei.gif b/docs/ecs/api-ref/public_sys-resources/icon-huawei.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-huawei.gif rename to docs/ecs/api-ref/public_sys-resources/icon-huawei.gif diff --git a/ecs/api-ref/public_sys-resources/icon-note.gif b/docs/ecs/api-ref/public_sys-resources/icon-note.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-note.gif rename to docs/ecs/api-ref/public_sys-resources/icon-note.gif diff --git a/ecs/api-ref/public_sys-resources/icon-notice.gif b/docs/ecs/api-ref/public_sys-resources/icon-notice.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-notice.gif rename to docs/ecs/api-ref/public_sys-resources/icon-notice.gif diff --git a/ecs/api-ref/public_sys-resources/icon-tip.gif b/docs/ecs/api-ref/public_sys-resources/icon-tip.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-tip.gif rename to docs/ecs/api-ref/public_sys-resources/icon-tip.gif diff --git a/ecs/api-ref/public_sys-resources/icon-warning.gif b/docs/ecs/api-ref/public_sys-resources/icon-warning.gif similarity index 100% rename from ecs/api-ref/public_sys-resources/icon-warning.gif rename to docs/ecs/api-ref/public_sys-resources/icon-warning.gif diff --git a/ecs/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/ecs/api-ref/public_sys-resources/note_3.0-en-us.png similarity index 100% rename from ecs/api-ref/public_sys-resources/note_3.0-en-us.png rename to docs/ecs/api-ref/public_sys-resources/note_3.0-en-us.png diff --git a/ecs/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/ecs/api-ref/public_sys-resources/notice_3.0-en-us.png similarity index 100% rename from ecs/api-ref/public_sys-resources/notice_3.0-en-us.png rename to docs/ecs/api-ref/public_sys-resources/notice_3.0-en-us.png diff --git a/ecs/api-ref/public_sys-resources/popup.js b/docs/ecs/api-ref/public_sys-resources/popup.js similarity index 100% rename from ecs/api-ref/public_sys-resources/popup.js rename to docs/ecs/api-ref/public_sys-resources/popup.js diff --git a/ecs/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/ecs/api-ref/public_sys-resources/warning_3.0-en-us.png similarity index 100% rename from ecs/api-ref/public_sys-resources/warning_3.0-en-us.png rename to docs/ecs/api-ref/public_sys-resources/warning_3.0-en-us.png diff --git a/ecs/dev/ALL_META.TXT.json b/docs/ecs/dev/ALL_META.TXT.json similarity index 100% rename from ecs/dev/ALL_META.TXT.json rename to docs/ecs/dev/ALL_META.TXT.json diff --git a/ecs/dev/CLASS.TXT.json b/docs/ecs/dev/CLASS.TXT.json similarity index 100% rename from ecs/dev/CLASS.TXT.json rename to docs/ecs/dev/CLASS.TXT.json diff --git a/ecs/dev/PARAMETERS.txt b/docs/ecs/dev/PARAMETERS.txt similarity index 100% rename from ecs/dev/PARAMETERS.txt rename to docs/ecs/dev/PARAMETERS.txt diff --git a/ecs/dev/en-us_image_0173496405.png b/docs/ecs/dev/en-us_image_0173496405.png similarity index 100% rename from ecs/dev/en-us_image_0173496405.png rename to docs/ecs/dev/en-us_image_0173496405.png diff --git a/ecs/dev/en-us_image_0173496413.png b/docs/ecs/dev/en-us_image_0173496413.png similarity index 100% rename from ecs/dev/en-us_image_0173496413.png rename to docs/ecs/dev/en-us_image_0173496413.png diff --git a/ecs/dev/en-us_topic_0134192984.html b/docs/ecs/dev/en-us_topic_0134192984.html similarity index 100% rename from ecs/dev/en-us_topic_0134192984.html rename to docs/ecs/dev/en-us_topic_0134192984.html diff --git a/ecs/dev/en-us_topic_0134192987.html b/docs/ecs/dev/en-us_topic_0134192987.html similarity index 100% rename from ecs/dev/en-us_topic_0134192987.html rename to docs/ecs/dev/en-us_topic_0134192987.html diff --git a/ecs/dev/en-us_topic_0134192990.html b/docs/ecs/dev/en-us_topic_0134192990.html similarity index 100% rename from ecs/dev/en-us_topic_0134192990.html rename to docs/ecs/dev/en-us_topic_0134192990.html diff --git a/ecs/dev/en-us_topic_0134192993.html b/docs/ecs/dev/en-us_topic_0134192993.html similarity index 100% rename from ecs/dev/en-us_topic_0134192993.html rename to docs/ecs/dev/en-us_topic_0134192993.html diff --git a/ecs/dev/en-us_topic_0134192996.html b/docs/ecs/dev/en-us_topic_0134192996.html similarity index 100% rename from ecs/dev/en-us_topic_0134192996.html rename to docs/ecs/dev/en-us_topic_0134192996.html diff --git a/ecs/dev/en-us_topic_0134192997.html b/docs/ecs/dev/en-us_topic_0134192997.html similarity index 100% rename from ecs/dev/en-us_topic_0134192997.html rename to docs/ecs/dev/en-us_topic_0134192997.html diff --git a/ecs/dev/en-us_topic_0134193004.html b/docs/ecs/dev/en-us_topic_0134193004.html similarity index 100% rename from ecs/dev/en-us_topic_0134193004.html rename to docs/ecs/dev/en-us_topic_0134193004.html diff --git a/ecs/dev/en-us_topic_0134193005.html b/docs/ecs/dev/en-us_topic_0134193005.html similarity index 100% rename from ecs/dev/en-us_topic_0134193005.html rename to docs/ecs/dev/en-us_topic_0134193005.html diff --git a/ecs/dev/en-us_topic_0134193006.html b/docs/ecs/dev/en-us_topic_0134193006.html similarity index 100% rename from ecs/dev/en-us_topic_0134193006.html rename to docs/ecs/dev/en-us_topic_0134193006.html diff --git a/ecs/dev/en-us_topic_0134327704.html b/docs/ecs/dev/en-us_topic_0134327704.html similarity index 100% rename from ecs/dev/en-us_topic_0134327704.html rename to docs/ecs/dev/en-us_topic_0134327704.html diff --git a/ecs/dev/en-us_topic_0134883593.html b/docs/ecs/dev/en-us_topic_0134883593.html similarity index 100% rename from ecs/dev/en-us_topic_0134883593.html rename to docs/ecs/dev/en-us_topic_0134883593.html diff --git a/ecs/dev/public_sys-resources/ExpandCollapse.js b/docs/ecs/dev/public_sys-resources/ExpandCollapse.js similarity index 100% rename from ecs/dev/public_sys-resources/ExpandCollapse.js rename to docs/ecs/dev/public_sys-resources/ExpandCollapse.js diff --git a/ecs/dev/public_sys-resources/caution_3.0-en-us.png b/docs/ecs/dev/public_sys-resources/caution_3.0-en-us.png similarity index 100% rename from ecs/dev/public_sys-resources/caution_3.0-en-us.png rename to docs/ecs/dev/public_sys-resources/caution_3.0-en-us.png diff --git a/ecs/dev/public_sys-resources/commonltr.css b/docs/ecs/dev/public_sys-resources/commonltr.css similarity index 100% rename from ecs/dev/public_sys-resources/commonltr.css rename to docs/ecs/dev/public_sys-resources/commonltr.css diff --git a/ecs/dev/public_sys-resources/commonltr_print.css b/docs/ecs/dev/public_sys-resources/commonltr_print.css similarity index 100% rename from ecs/dev/public_sys-resources/commonltr_print.css rename to docs/ecs/dev/public_sys-resources/commonltr_print.css diff --git a/ecs/dev/public_sys-resources/commonrtl.css b/docs/ecs/dev/public_sys-resources/commonrtl.css similarity index 100% rename from ecs/dev/public_sys-resources/commonrtl.css rename to docs/ecs/dev/public_sys-resources/commonrtl.css diff --git a/ecs/dev/public_sys-resources/danger_3.0-en-us.png b/docs/ecs/dev/public_sys-resources/danger_3.0-en-us.png similarity index 100% rename from ecs/dev/public_sys-resources/danger_3.0-en-us.png rename to docs/ecs/dev/public_sys-resources/danger_3.0-en-us.png diff --git a/ecs/dev/public_sys-resources/delta.gif b/docs/ecs/dev/public_sys-resources/delta.gif similarity index 100% rename from ecs/dev/public_sys-resources/delta.gif rename to docs/ecs/dev/public_sys-resources/delta.gif diff --git a/ecs/dev/public_sys-resources/deltaend.gif b/docs/ecs/dev/public_sys-resources/deltaend.gif similarity index 100% rename from ecs/dev/public_sys-resources/deltaend.gif rename to docs/ecs/dev/public_sys-resources/deltaend.gif diff --git a/ecs/dev/public_sys-resources/icon-arrowdn.gif b/docs/ecs/dev/public_sys-resources/icon-arrowdn.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-arrowdn.gif rename to docs/ecs/dev/public_sys-resources/icon-arrowdn.gif diff --git a/ecs/dev/public_sys-resources/icon-arrowrt.gif b/docs/ecs/dev/public_sys-resources/icon-arrowrt.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-arrowrt.gif rename to docs/ecs/dev/public_sys-resources/icon-arrowrt.gif diff --git a/ecs/dev/public_sys-resources/icon-caution.gif b/docs/ecs/dev/public_sys-resources/icon-caution.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-caution.gif rename to docs/ecs/dev/public_sys-resources/icon-caution.gif diff --git a/ecs/dev/public_sys-resources/icon-danger.gif b/docs/ecs/dev/public_sys-resources/icon-danger.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-danger.gif rename to docs/ecs/dev/public_sys-resources/icon-danger.gif diff --git a/ecs/dev/public_sys-resources/icon-huawei.gif b/docs/ecs/dev/public_sys-resources/icon-huawei.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-huawei.gif rename to docs/ecs/dev/public_sys-resources/icon-huawei.gif diff --git a/ecs/dev/public_sys-resources/icon-note.gif b/docs/ecs/dev/public_sys-resources/icon-note.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-note.gif rename to docs/ecs/dev/public_sys-resources/icon-note.gif diff --git a/ecs/dev/public_sys-resources/icon-notice.gif b/docs/ecs/dev/public_sys-resources/icon-notice.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-notice.gif rename to docs/ecs/dev/public_sys-resources/icon-notice.gif diff --git a/ecs/dev/public_sys-resources/icon-tip.gif b/docs/ecs/dev/public_sys-resources/icon-tip.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-tip.gif rename to docs/ecs/dev/public_sys-resources/icon-tip.gif diff --git a/ecs/dev/public_sys-resources/icon-warning.gif b/docs/ecs/dev/public_sys-resources/icon-warning.gif similarity index 100% rename from ecs/dev/public_sys-resources/icon-warning.gif rename to docs/ecs/dev/public_sys-resources/icon-warning.gif diff --git a/ecs/dev/public_sys-resources/imageResize.js b/docs/ecs/dev/public_sys-resources/imageResize.js similarity index 100% rename from ecs/dev/public_sys-resources/imageResize.js rename to docs/ecs/dev/public_sys-resources/imageResize.js diff --git a/ecs/dev/public_sys-resources/imageclose.gif b/docs/ecs/dev/public_sys-resources/imageclose.gif similarity index 100% rename from ecs/dev/public_sys-resources/imageclose.gif rename to docs/ecs/dev/public_sys-resources/imageclose.gif diff --git a/ecs/dev/public_sys-resources/imageclosehover.gif b/docs/ecs/dev/public_sys-resources/imageclosehover.gif similarity index 100% rename from ecs/dev/public_sys-resources/imageclosehover.gif rename to docs/ecs/dev/public_sys-resources/imageclosehover.gif diff --git a/ecs/dev/public_sys-resources/imagemax.gif b/docs/ecs/dev/public_sys-resources/imagemax.gif similarity index 100% rename from ecs/dev/public_sys-resources/imagemax.gif rename to docs/ecs/dev/public_sys-resources/imagemax.gif diff --git a/ecs/dev/public_sys-resources/imagemaxhover.gif b/docs/ecs/dev/public_sys-resources/imagemaxhover.gif similarity index 100% rename from ecs/dev/public_sys-resources/imagemaxhover.gif rename to docs/ecs/dev/public_sys-resources/imagemaxhover.gif diff --git a/ecs/dev/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/ecs/dev/public_sys-resources/jquery-migrate-1.2.1.min.js similarity index 100% rename from ecs/dev/public_sys-resources/jquery-migrate-1.2.1.min.js rename to docs/ecs/dev/public_sys-resources/jquery-migrate-1.2.1.min.js diff --git a/ecs/dev/public_sys-resources/jquery-ui.min.js b/docs/ecs/dev/public_sys-resources/jquery-ui.min.js similarity index 100% rename from ecs/dev/public_sys-resources/jquery-ui.min.js rename to docs/ecs/dev/public_sys-resources/jquery-ui.min.js diff --git a/ecs/dev/public_sys-resources/jquery.min.js b/docs/ecs/dev/public_sys-resources/jquery.min.js similarity index 100% rename from ecs/dev/public_sys-resources/jquery.min.js rename to docs/ecs/dev/public_sys-resources/jquery.min.js diff --git a/ecs/dev/public_sys-resources/jquery.mousewheel.min.js b/docs/ecs/dev/public_sys-resources/jquery.mousewheel.min.js similarity index 100% rename from ecs/dev/public_sys-resources/jquery.mousewheel.min.js rename to docs/ecs/dev/public_sys-resources/jquery.mousewheel.min.js diff --git a/ecs/dev/public_sys-resources/macFFBgHack.png b/docs/ecs/dev/public_sys-resources/macFFBgHack.png similarity index 100% rename from ecs/dev/public_sys-resources/macFFBgHack.png rename to docs/ecs/dev/public_sys-resources/macFFBgHack.png diff --git a/ecs/dev/public_sys-resources/note_3.0-en-us.png b/docs/ecs/dev/public_sys-resources/note_3.0-en-us.png similarity index 100% rename from ecs/dev/public_sys-resources/note_3.0-en-us.png rename to docs/ecs/dev/public_sys-resources/note_3.0-en-us.png diff --git a/ecs/dev/public_sys-resources/notice_3.0-en-us.png b/docs/ecs/dev/public_sys-resources/notice_3.0-en-us.png similarity index 100% rename from ecs/dev/public_sys-resources/notice_3.0-en-us.png rename to docs/ecs/dev/public_sys-resources/notice_3.0-en-us.png diff --git a/ecs/dev/public_sys-resources/popup.js b/docs/ecs/dev/public_sys-resources/popup.js similarity index 100% rename from ecs/dev/public_sys-resources/popup.js rename to docs/ecs/dev/public_sys-resources/popup.js diff --git a/ecs/dev/public_sys-resources/thickbox.css b/docs/ecs/dev/public_sys-resources/thickbox.css similarity index 100% rename from ecs/dev/public_sys-resources/thickbox.css rename to docs/ecs/dev/public_sys-resources/thickbox.css diff --git a/ecs/dev/public_sys-resources/thickbox.js b/docs/ecs/dev/public_sys-resources/thickbox.js similarity index 100% rename from ecs/dev/public_sys-resources/thickbox.js rename to docs/ecs/dev/public_sys-resources/thickbox.js diff --git a/ecs/dev/public_sys-resources/warning_3.0-en-us.png b/docs/ecs/dev/public_sys-resources/warning_3.0-en-us.png similarity index 100% rename from ecs/dev/public_sys-resources/warning_3.0-en-us.png rename to docs/ecs/dev/public_sys-resources/warning_3.0-en-us.png diff --git a/ecs/umn/ALL_META.TXT.json b/docs/ecs/umn/ALL_META.TXT.json similarity index 100% rename from ecs/umn/ALL_META.TXT.json rename to docs/ecs/umn/ALL_META.TXT.json diff --git a/ecs/umn/CLASS.TXT.json b/docs/ecs/umn/CLASS.TXT.json similarity index 100% rename from ecs/umn/CLASS.TXT.json rename to docs/ecs/umn/CLASS.TXT.json diff --git a/ecs/umn/PARAMETERS.txt b/docs/ecs/umn/PARAMETERS.txt similarity index 100% rename from ecs/umn/PARAMETERS.txt rename to docs/ecs/umn/PARAMETERS.txt diff --git a/ecs/umn/en-us_image_0000001071727803.png b/docs/ecs/umn/en-us_image_0000001071727803.png similarity index 100% rename from ecs/umn/en-us_image_0000001071727803.png rename to docs/ecs/umn/en-us_image_0000001071727803.png diff --git a/ecs/umn/en-us_image_0000001081131958.png b/docs/ecs/umn/en-us_image_0000001081131958.png similarity index 100% rename from ecs/umn/en-us_image_0000001081131958.png rename to docs/ecs/umn/en-us_image_0000001081131958.png diff --git a/ecs/umn/en-us_image_0000001082643605.jpg b/docs/ecs/umn/en-us_image_0000001082643605.jpg similarity index 100% rename from ecs/umn/en-us_image_0000001082643605.jpg rename to docs/ecs/umn/en-us_image_0000001082643605.jpg diff --git a/ecs/umn/en-us_image_0000001092045958.png b/docs/ecs/umn/en-us_image_0000001092045958.png similarity index 100% rename from ecs/umn/en-us_image_0000001092045958.png rename to docs/ecs/umn/en-us_image_0000001092045958.png diff --git a/ecs/umn/en-us_image_0000001092174258.png b/docs/ecs/umn/en-us_image_0000001092174258.png similarity index 100% rename from ecs/umn/en-us_image_0000001092174258.png rename to docs/ecs/umn/en-us_image_0000001092174258.png diff --git a/ecs/umn/en-us_image_0000001093310123.png b/docs/ecs/umn/en-us_image_0000001093310123.png similarity index 100% rename from ecs/umn/en-us_image_0000001093310123.png rename to docs/ecs/umn/en-us_image_0000001093310123.png diff --git a/ecs/umn/en-us_image_0000001093447741.png b/docs/ecs/umn/en-us_image_0000001093447741.png similarity index 100% rename from ecs/umn/en-us_image_0000001093447741.png rename to docs/ecs/umn/en-us_image_0000001093447741.png diff --git a/ecs/umn/en-us_image_0000001093449637.png b/docs/ecs/umn/en-us_image_0000001093449637.png similarity index 100% rename from ecs/umn/en-us_image_0000001093449637.png rename to docs/ecs/umn/en-us_image_0000001093449637.png diff --git a/ecs/umn/en-us_image_0000001093450009.png b/docs/ecs/umn/en-us_image_0000001093450009.png similarity index 100% rename from ecs/umn/en-us_image_0000001093450009.png rename to docs/ecs/umn/en-us_image_0000001093450009.png diff --git a/ecs/umn/en-us_image_0000001093667097.png b/docs/ecs/umn/en-us_image_0000001093667097.png similarity index 100% rename from ecs/umn/en-us_image_0000001093667097.png rename to docs/ecs/umn/en-us_image_0000001093667097.png diff --git a/ecs/umn/en-us_image_0000001100835050.png b/docs/ecs/umn/en-us_image_0000001100835050.png similarity index 100% rename from ecs/umn/en-us_image_0000001100835050.png rename to docs/ecs/umn/en-us_image_0000001100835050.png diff --git a/ecs/umn/en-us_image_0000001121886141.png b/docs/ecs/umn/en-us_image_0000001121886141.png similarity index 100% rename from ecs/umn/en-us_image_0000001121886141.png rename to docs/ecs/umn/en-us_image_0000001121886141.png diff --git a/ecs/umn/en-us_image_0000001121886253.png b/docs/ecs/umn/en-us_image_0000001121886253.png similarity index 100% rename from ecs/umn/en-us_image_0000001121886253.png rename to docs/ecs/umn/en-us_image_0000001121886253.png diff --git a/ecs/umn/en-us_image_0000001122000869.png b/docs/ecs/umn/en-us_image_0000001122000869.png similarity index 100% rename from ecs/umn/en-us_image_0000001122000869.png rename to docs/ecs/umn/en-us_image_0000001122000869.png diff --git a/ecs/umn/en-us_image_0000001122000977.png b/docs/ecs/umn/en-us_image_0000001122000977.png similarity index 100% rename from ecs/umn/en-us_image_0000001122000977.png rename to docs/ecs/umn/en-us_image_0000001122000977.png diff --git a/ecs/umn/en-us_image_0000001122000979.png b/docs/ecs/umn/en-us_image_0000001122000979.png similarity index 100% rename from ecs/umn/en-us_image_0000001122000979.png rename to docs/ecs/umn/en-us_image_0000001122000979.png diff --git a/ecs/umn/en-us_image_0000001122141457.png b/docs/ecs/umn/en-us_image_0000001122141457.png similarity index 100% rename from ecs/umn/en-us_image_0000001122141457.png rename to docs/ecs/umn/en-us_image_0000001122141457.png diff --git a/ecs/umn/en-us_image_0000001122204571.png b/docs/ecs/umn/en-us_image_0000001122204571.png similarity index 100% rename from ecs/umn/en-us_image_0000001122204571.png rename to docs/ecs/umn/en-us_image_0000001122204571.png diff --git a/ecs/umn/en-us_image_0000001122204673.png b/docs/ecs/umn/en-us_image_0000001122204673.png similarity index 100% rename from ecs/umn/en-us_image_0000001122204673.png rename to docs/ecs/umn/en-us_image_0000001122204673.png diff --git a/ecs/umn/en-us_image_0000001122204675.png b/docs/ecs/umn/en-us_image_0000001122204675.png similarity index 100% rename from ecs/umn/en-us_image_0000001122204675.png rename to docs/ecs/umn/en-us_image_0000001122204675.png diff --git a/ecs/umn/en-us_image_0000001122204677.png b/docs/ecs/umn/en-us_image_0000001122204677.png similarity index 100% rename from ecs/umn/en-us_image_0000001122204677.png rename to docs/ecs/umn/en-us_image_0000001122204677.png diff --git a/ecs/umn/en-us_image_0000001127902463.png b/docs/ecs/umn/en-us_image_0000001127902463.png similarity index 100% rename from ecs/umn/en-us_image_0000001127902463.png rename to docs/ecs/umn/en-us_image_0000001127902463.png diff --git a/ecs/umn/en-us_image_0000001127906793.png b/docs/ecs/umn/en-us_image_0000001127906793.png similarity index 100% rename from ecs/umn/en-us_image_0000001127906793.png rename to docs/ecs/umn/en-us_image_0000001127906793.png diff --git a/ecs/umn/en-us_image_0000001128111323.png b/docs/ecs/umn/en-us_image_0000001128111323.png similarity index 100% rename from ecs/umn/en-us_image_0000001128111323.png rename to docs/ecs/umn/en-us_image_0000001128111323.png diff --git a/ecs/umn/en-us_image_0000001128656892.png b/docs/ecs/umn/en-us_image_0000001128656892.png similarity index 100% rename from ecs/umn/en-us_image_0000001128656892.png rename to docs/ecs/umn/en-us_image_0000001128656892.png diff --git a/ecs/umn/en-us_image_0000001150707636.png b/docs/ecs/umn/en-us_image_0000001150707636.png similarity index 100% rename from ecs/umn/en-us_image_0000001150707636.png rename to docs/ecs/umn/en-us_image_0000001150707636.png diff --git a/ecs/umn/en-us_image_0000001189705789.png b/docs/ecs/umn/en-us_image_0000001189705789.png similarity index 100% rename from ecs/umn/en-us_image_0000001189705789.png rename to docs/ecs/umn/en-us_image_0000001189705789.png diff --git a/ecs/umn/en-us_image_0000001208978003.png b/docs/ecs/umn/en-us_image_0000001208978003.png similarity index 100% rename from ecs/umn/en-us_image_0000001208978003.png rename to docs/ecs/umn/en-us_image_0000001208978003.png diff --git a/ecs/umn/en-us_image_0000001230120807.png b/docs/ecs/umn/en-us_image_0000001230120807.png similarity index 100% rename from ecs/umn/en-us_image_0000001230120807.png rename to docs/ecs/umn/en-us_image_0000001230120807.png diff --git a/ecs/umn/en-us_image_0022382203.png b/docs/ecs/umn/en-us_image_0022382203.png similarity index 100% rename from ecs/umn/en-us_image_0022382203.png rename to docs/ecs/umn/en-us_image_0022382203.png diff --git a/ecs/umn/en-us_image_0027174005.png b/docs/ecs/umn/en-us_image_0027174005.png similarity index 100% rename from ecs/umn/en-us_image_0027174005.png rename to docs/ecs/umn/en-us_image_0027174005.png diff --git a/ecs/umn/en-us_image_0030874266.png b/docs/ecs/umn/en-us_image_0030874266.png similarity index 100% rename from ecs/umn/en-us_image_0030874266.png rename to docs/ecs/umn/en-us_image_0030874266.png diff --git a/ecs/umn/en-us_image_0030874270.png b/docs/ecs/umn/en-us_image_0030874270.png similarity index 100% rename from ecs/umn/en-us_image_0030874270.png rename to docs/ecs/umn/en-us_image_0030874270.png diff --git a/ecs/umn/en-us_image_0030874271.png b/docs/ecs/umn/en-us_image_0030874271.png similarity index 100% rename from ecs/umn/en-us_image_0030874271.png rename to docs/ecs/umn/en-us_image_0030874271.png diff --git a/ecs/umn/en-us_image_0030874275.png b/docs/ecs/umn/en-us_image_0030874275.png similarity index 100% rename from ecs/umn/en-us_image_0030874275.png rename to docs/ecs/umn/en-us_image_0030874275.png diff --git a/ecs/umn/en-us_image_0036068239.png b/docs/ecs/umn/en-us_image_0036068239.png similarity index 100% rename from ecs/umn/en-us_image_0036068239.png rename to docs/ecs/umn/en-us_image_0036068239.png diff --git a/ecs/umn/en-us_image_0037980515.png b/docs/ecs/umn/en-us_image_0037980515.png similarity index 100% rename from ecs/umn/en-us_image_0037980515.png rename to docs/ecs/umn/en-us_image_0037980515.png diff --git a/ecs/umn/en-us_image_0037982934.png b/docs/ecs/umn/en-us_image_0037982934.png similarity index 100% rename from ecs/umn/en-us_image_0037982934.png rename to docs/ecs/umn/en-us_image_0037982934.png diff --git a/ecs/umn/en-us_image_0042322120.png b/docs/ecs/umn/en-us_image_0042322120.png similarity index 100% rename from ecs/umn/en-us_image_0042322120.png rename to docs/ecs/umn/en-us_image_0042322120.png diff --git a/ecs/umn/en-us_image_0047273062.png b/docs/ecs/umn/en-us_image_0047273062.png similarity index 100% rename from ecs/umn/en-us_image_0047273062.png rename to docs/ecs/umn/en-us_image_0047273062.png diff --git a/ecs/umn/en-us_image_0049287308.png b/docs/ecs/umn/en-us_image_0049287308.png similarity index 100% rename from ecs/umn/en-us_image_0049287308.png rename to docs/ecs/umn/en-us_image_0049287308.png diff --git a/ecs/umn/en-us_image_0058747512.jpg b/docs/ecs/umn/en-us_image_0058747512.jpg similarity index 100% rename from ecs/umn/en-us_image_0058747512.jpg rename to docs/ecs/umn/en-us_image_0058747512.jpg diff --git a/ecs/umn/en-us_image_0071898891.png b/docs/ecs/umn/en-us_image_0071898891.png similarity index 100% rename from ecs/umn/en-us_image_0071898891.png rename to docs/ecs/umn/en-us_image_0071898891.png diff --git a/ecs/umn/en-us_image_0076540987.png b/docs/ecs/umn/en-us_image_0076540987.png similarity index 100% rename from ecs/umn/en-us_image_0076540987.png rename to docs/ecs/umn/en-us_image_0076540987.png diff --git a/ecs/umn/en-us_image_0076540988.png b/docs/ecs/umn/en-us_image_0076540988.png similarity index 100% rename from ecs/umn/en-us_image_0076540988.png rename to docs/ecs/umn/en-us_image_0076540988.png diff --git a/ecs/umn/en-us_image_0076541187.png b/docs/ecs/umn/en-us_image_0076541187.png similarity index 100% rename from ecs/umn/en-us_image_0076541187.png rename to docs/ecs/umn/en-us_image_0076541187.png diff --git a/ecs/umn/en-us_image_0076543500.jpg b/docs/ecs/umn/en-us_image_0076543500.jpg similarity index 100% rename from ecs/umn/en-us_image_0076543500.jpg rename to docs/ecs/umn/en-us_image_0076543500.jpg diff --git a/ecs/umn/en-us_image_0076543501.jpg b/docs/ecs/umn/en-us_image_0076543501.jpg similarity index 100% rename from ecs/umn/en-us_image_0076543501.jpg rename to docs/ecs/umn/en-us_image_0076543501.jpg diff --git a/ecs/umn/en-us_image_0076595619.jpg b/docs/ecs/umn/en-us_image_0076595619.jpg similarity index 100% rename from ecs/umn/en-us_image_0076595619.jpg rename to docs/ecs/umn/en-us_image_0076595619.jpg diff --git a/ecs/umn/en-us_image_0076595620.jpg b/docs/ecs/umn/en-us_image_0076595620.jpg similarity index 100% rename from ecs/umn/en-us_image_0076595620.jpg rename to docs/ecs/umn/en-us_image_0076595620.jpg diff --git a/ecs/umn/en-us_image_0076596029.jpg b/docs/ecs/umn/en-us_image_0076596029.jpg similarity index 100% rename from ecs/umn/en-us_image_0076596029.jpg rename to docs/ecs/umn/en-us_image_0076596029.jpg diff --git a/ecs/umn/en-us_image_0076596326.jpg b/docs/ecs/umn/en-us_image_0076596326.jpg similarity index 100% rename from ecs/umn/en-us_image_0076596326.jpg rename to docs/ecs/umn/en-us_image_0076596326.jpg diff --git a/ecs/umn/en-us_image_0076598858.jpg b/docs/ecs/umn/en-us_image_0076598858.jpg similarity index 100% rename from ecs/umn/en-us_image_0076598858.jpg rename to docs/ecs/umn/en-us_image_0076598858.jpg diff --git a/ecs/umn/en-us_image_0076600080.jpg b/docs/ecs/umn/en-us_image_0076600080.jpg similarity index 100% rename from ecs/umn/en-us_image_0076600080.jpg rename to docs/ecs/umn/en-us_image_0076600080.jpg diff --git a/ecs/umn/en-us_image_0079177144.png b/docs/ecs/umn/en-us_image_0079177144.png similarity index 100% rename from ecs/umn/en-us_image_0079177144.png rename to docs/ecs/umn/en-us_image_0079177144.png diff --git a/ecs/umn/en-us_image_0087630201.jpg b/docs/ecs/umn/en-us_image_0087630201.jpg similarity index 100% rename from ecs/umn/en-us_image_0087630201.jpg rename to docs/ecs/umn/en-us_image_0087630201.jpg diff --git a/ecs/umn/en-us_image_0087631679.jpg b/docs/ecs/umn/en-us_image_0087631679.jpg similarity index 100% rename from ecs/umn/en-us_image_0087631679.jpg rename to docs/ecs/umn/en-us_image_0087631679.jpg diff --git a/ecs/umn/en-us_image_0087632786.jpg b/docs/ecs/umn/en-us_image_0087632786.jpg similarity index 100% rename from ecs/umn/en-us_image_0087632786.jpg rename to docs/ecs/umn/en-us_image_0087632786.jpg diff --git a/ecs/umn/en-us_image_0087632787.jpg b/docs/ecs/umn/en-us_image_0087632787.jpg similarity index 100% rename from ecs/umn/en-us_image_0087632787.jpg rename to docs/ecs/umn/en-us_image_0087632787.jpg diff --git a/ecs/umn/en-us_image_0087903699.png b/docs/ecs/umn/en-us_image_0087903699.png similarity index 100% rename from ecs/umn/en-us_image_0087903699.png rename to docs/ecs/umn/en-us_image_0087903699.png diff --git a/ecs/umn/en-us_image_0087903704.png b/docs/ecs/umn/en-us_image_0087903704.png similarity index 100% rename from ecs/umn/en-us_image_0087903704.png rename to docs/ecs/umn/en-us_image_0087903704.png diff --git a/ecs/umn/en-us_image_0087906013.png b/docs/ecs/umn/en-us_image_0087906013.png similarity index 100% rename from ecs/umn/en-us_image_0087906013.png rename to docs/ecs/umn/en-us_image_0087906013.png diff --git a/ecs/umn/en-us_image_0087906055.png b/docs/ecs/umn/en-us_image_0087906055.png similarity index 100% rename from ecs/umn/en-us_image_0087906055.png rename to docs/ecs/umn/en-us_image_0087906055.png diff --git a/ecs/umn/en-us_image_0087906067.png b/docs/ecs/umn/en-us_image_0087906067.png similarity index 100% rename from ecs/umn/en-us_image_0087906067.png rename to docs/ecs/umn/en-us_image_0087906067.png diff --git a/ecs/umn/en-us_image_0088242234.jpg b/docs/ecs/umn/en-us_image_0088242234.jpg similarity index 100% rename from ecs/umn/en-us_image_0088242234.jpg rename to docs/ecs/umn/en-us_image_0088242234.jpg diff --git a/ecs/umn/en-us_image_0093469181.png b/docs/ecs/umn/en-us_image_0093469181.png similarity index 100% rename from ecs/umn/en-us_image_0093469181.png rename to docs/ecs/umn/en-us_image_0093469181.png diff --git a/ecs/umn/en-us_image_0093507575.png b/docs/ecs/umn/en-us_image_0093507575.png similarity index 100% rename from ecs/umn/en-us_image_0093507575.png rename to docs/ecs/umn/en-us_image_0093507575.png diff --git a/ecs/umn/en-us_image_0093507592.png b/docs/ecs/umn/en-us_image_0093507592.png similarity index 100% rename from ecs/umn/en-us_image_0093507592.png rename to docs/ecs/umn/en-us_image_0093507592.png diff --git a/ecs/umn/en-us_image_0093507600.png b/docs/ecs/umn/en-us_image_0093507600.png similarity index 100% rename from ecs/umn/en-us_image_0093507600.png rename to docs/ecs/umn/en-us_image_0093507600.png diff --git a/ecs/umn/en-us_image_0093518909.png b/docs/ecs/umn/en-us_image_0093518909.png similarity index 100% rename from ecs/umn/en-us_image_0093518909.png rename to docs/ecs/umn/en-us_image_0093518909.png diff --git a/ecs/umn/en-us_image_0094801740.png b/docs/ecs/umn/en-us_image_0094801740.png similarity index 100% rename from ecs/umn/en-us_image_0094801740.png rename to docs/ecs/umn/en-us_image_0094801740.png diff --git a/ecs/umn/en-us_image_0095024494.png b/docs/ecs/umn/en-us_image_0095024494.png similarity index 100% rename from ecs/umn/en-us_image_0095024494.png rename to docs/ecs/umn/en-us_image_0095024494.png diff --git a/ecs/umn/en-us_image_0096298046.png b/docs/ecs/umn/en-us_image_0096298046.png similarity index 100% rename from ecs/umn/en-us_image_0096298046.png rename to docs/ecs/umn/en-us_image_0096298046.png diff --git a/ecs/umn/en-us_image_0096298123.png b/docs/ecs/umn/en-us_image_0096298123.png similarity index 100% rename from ecs/umn/en-us_image_0096298123.png rename to docs/ecs/umn/en-us_image_0096298123.png diff --git a/ecs/umn/en-us_image_0097597141.png b/docs/ecs/umn/en-us_image_0097597141.png similarity index 100% rename from ecs/umn/en-us_image_0097597141.png rename to docs/ecs/umn/en-us_image_0097597141.png diff --git a/ecs/umn/en-us_image_0097597143.png b/docs/ecs/umn/en-us_image_0097597143.png similarity index 100% rename from ecs/umn/en-us_image_0097597143.png rename to docs/ecs/umn/en-us_image_0097597143.png diff --git a/ecs/umn/en-us_image_0097597145.png b/docs/ecs/umn/en-us_image_0097597145.png similarity index 100% rename from ecs/umn/en-us_image_0097597145.png rename to docs/ecs/umn/en-us_image_0097597145.png diff --git a/ecs/umn/en-us_image_0097597147.png b/docs/ecs/umn/en-us_image_0097597147.png similarity index 100% rename from ecs/umn/en-us_image_0097597147.png rename to docs/ecs/umn/en-us_image_0097597147.png diff --git a/ecs/umn/en-us_image_0097597149.png b/docs/ecs/umn/en-us_image_0097597149.png similarity index 100% rename from ecs/umn/en-us_image_0097597149.png rename to docs/ecs/umn/en-us_image_0097597149.png diff --git a/ecs/umn/en-us_image_0097597151.png b/docs/ecs/umn/en-us_image_0097597151.png similarity index 100% rename from ecs/umn/en-us_image_0097597151.png rename to docs/ecs/umn/en-us_image_0097597151.png diff --git a/ecs/umn/en-us_image_0097597153.png b/docs/ecs/umn/en-us_image_0097597153.png similarity index 100% rename from ecs/umn/en-us_image_0097597153.png rename to docs/ecs/umn/en-us_image_0097597153.png diff --git a/ecs/umn/en-us_image_0097597155.png b/docs/ecs/umn/en-us_image_0097597155.png similarity index 100% rename from ecs/umn/en-us_image_0097597155.png rename to docs/ecs/umn/en-us_image_0097597155.png diff --git a/ecs/umn/en-us_image_0107414257.png b/docs/ecs/umn/en-us_image_0107414257.png similarity index 100% rename from ecs/umn/en-us_image_0107414257.png rename to docs/ecs/umn/en-us_image_0107414257.png diff --git a/ecs/umn/en-us_image_0107415055.png b/docs/ecs/umn/en-us_image_0107415055.png similarity index 100% rename from ecs/umn/en-us_image_0107415055.png rename to docs/ecs/umn/en-us_image_0107415055.png diff --git a/ecs/umn/en-us_image_0107505891.png b/docs/ecs/umn/en-us_image_0107505891.png similarity index 100% rename from ecs/umn/en-us_image_0107505891.png rename to docs/ecs/umn/en-us_image_0107505891.png diff --git a/ecs/umn/en-us_image_0109039483.png b/docs/ecs/umn/en-us_image_0109039483.png similarity index 100% rename from ecs/umn/en-us_image_0109039483.png rename to docs/ecs/umn/en-us_image_0109039483.png diff --git a/ecs/umn/en-us_image_0114229858.png b/docs/ecs/umn/en-us_image_0114229858.png similarity index 100% rename from ecs/umn/en-us_image_0114229858.png rename to docs/ecs/umn/en-us_image_0114229858.png diff --git a/ecs/umn/en-us_image_0115873247.png b/docs/ecs/umn/en-us_image_0115873247.png similarity index 100% rename from ecs/umn/en-us_image_0115873247.png rename to docs/ecs/umn/en-us_image_0115873247.png diff --git a/ecs/umn/en-us_image_0115874559.png b/docs/ecs/umn/en-us_image_0115874559.png similarity index 100% rename from ecs/umn/en-us_image_0115874559.png rename to docs/ecs/umn/en-us_image_0115874559.png diff --git a/ecs/umn/en-us_image_0115931570.png b/docs/ecs/umn/en-us_image_0115931570.png similarity index 100% rename from ecs/umn/en-us_image_0115931570.png rename to docs/ecs/umn/en-us_image_0115931570.png diff --git a/ecs/umn/en-us_image_0115932123.png b/docs/ecs/umn/en-us_image_0115932123.png similarity index 100% rename from ecs/umn/en-us_image_0115932123.png rename to docs/ecs/umn/en-us_image_0115932123.png diff --git a/ecs/umn/en-us_image_0115932873.png b/docs/ecs/umn/en-us_image_0115932873.png similarity index 100% rename from ecs/umn/en-us_image_0115932873.png rename to docs/ecs/umn/en-us_image_0115932873.png diff --git a/ecs/umn/en-us_image_0115933029.png b/docs/ecs/umn/en-us_image_0115933029.png similarity index 100% rename from ecs/umn/en-us_image_0115933029.png rename to docs/ecs/umn/en-us_image_0115933029.png diff --git a/ecs/umn/en-us_image_0115934291.jpg b/docs/ecs/umn/en-us_image_0115934291.jpg similarity index 100% rename from ecs/umn/en-us_image_0115934291.jpg rename to docs/ecs/umn/en-us_image_0115934291.jpg diff --git a/ecs/umn/en-us_image_0116270059.jpg b/docs/ecs/umn/en-us_image_0116270059.jpg similarity index 100% rename from ecs/umn/en-us_image_0116270059.jpg rename to docs/ecs/umn/en-us_image_0116270059.jpg diff --git a/ecs/umn/en-us_image_0117031082.png b/docs/ecs/umn/en-us_image_0117031082.png similarity index 100% rename from ecs/umn/en-us_image_0117031082.png rename to docs/ecs/umn/en-us_image_0117031082.png diff --git a/ecs/umn/en-us_image_0117031548.gif b/docs/ecs/umn/en-us_image_0117031548.gif similarity index 100% rename from ecs/umn/en-us_image_0117031548.gif rename to docs/ecs/umn/en-us_image_0117031548.gif diff --git a/ecs/umn/en-us_image_0117334497.png b/docs/ecs/umn/en-us_image_0117334497.png similarity index 100% rename from ecs/umn/en-us_image_0117334497.png rename to docs/ecs/umn/en-us_image_0117334497.png diff --git a/ecs/umn/en-us_image_0120795776.jpg b/docs/ecs/umn/en-us_image_0120795776.jpg similarity index 100% rename from ecs/umn/en-us_image_0120795776.jpg rename to docs/ecs/umn/en-us_image_0120795776.jpg diff --git a/ecs/umn/en-us_image_0120795935.png b/docs/ecs/umn/en-us_image_0120795935.png similarity index 100% rename from ecs/umn/en-us_image_0120795935.png rename to docs/ecs/umn/en-us_image_0120795935.png diff --git a/ecs/umn/en-us_image_0120795956.png b/docs/ecs/umn/en-us_image_0120795956.png similarity index 100% rename from ecs/umn/en-us_image_0120795956.png rename to docs/ecs/umn/en-us_image_0120795956.png diff --git a/ecs/umn/en-us_image_0121090576.png b/docs/ecs/umn/en-us_image_0121090576.png similarity index 100% rename from ecs/umn/en-us_image_0121090576.png rename to docs/ecs/umn/en-us_image_0121090576.png diff --git a/ecs/umn/en-us_image_0121682272.png b/docs/ecs/umn/en-us_image_0121682272.png similarity index 100% rename from ecs/umn/en-us_image_0121682272.png rename to docs/ecs/umn/en-us_image_0121682272.png diff --git a/ecs/umn/en-us_image_0121682390.png b/docs/ecs/umn/en-us_image_0121682390.png similarity index 100% rename from ecs/umn/en-us_image_0121682390.png rename to docs/ecs/umn/en-us_image_0121682390.png diff --git a/ecs/umn/en-us_image_0121682392.png b/docs/ecs/umn/en-us_image_0121682392.png similarity index 100% rename from ecs/umn/en-us_image_0121682392.png rename to docs/ecs/umn/en-us_image_0121682392.png diff --git a/ecs/umn/en-us_image_0121682580.png b/docs/ecs/umn/en-us_image_0121682580.png similarity index 100% rename from ecs/umn/en-us_image_0121682580.png rename to docs/ecs/umn/en-us_image_0121682580.png diff --git a/ecs/umn/en-us_image_0121682602.png b/docs/ecs/umn/en-us_image_0121682602.png similarity index 100% rename from ecs/umn/en-us_image_0121682602.png rename to docs/ecs/umn/en-us_image_0121682602.png diff --git a/ecs/umn/en-us_image_0122999741.png b/docs/ecs/umn/en-us_image_0122999741.png similarity index 100% rename from ecs/umn/en-us_image_0122999741.png rename to docs/ecs/umn/en-us_image_0122999741.png diff --git a/ecs/umn/en-us_image_0123386277.jpg b/docs/ecs/umn/en-us_image_0123386277.jpg similarity index 100% rename from ecs/umn/en-us_image_0123386277.jpg rename to docs/ecs/umn/en-us_image_0123386277.jpg diff --git a/ecs/umn/en-us_image_0123417484.jpg b/docs/ecs/umn/en-us_image_0123417484.jpg similarity index 100% rename from ecs/umn/en-us_image_0123417484.jpg rename to docs/ecs/umn/en-us_image_0123417484.jpg diff --git a/ecs/umn/en-us_image_0126402833.png b/docs/ecs/umn/en-us_image_0126402833.png similarity index 100% rename from ecs/umn/en-us_image_0126402833.png rename to docs/ecs/umn/en-us_image_0126402833.png diff --git a/ecs/umn/en-us_image_0128851405.png b/docs/ecs/umn/en-us_image_0128851405.png similarity index 100% rename from ecs/umn/en-us_image_0128851405.png rename to docs/ecs/umn/en-us_image_0128851405.png diff --git a/ecs/umn/en-us_image_0128851444.png b/docs/ecs/umn/en-us_image_0128851444.png similarity index 100% rename from ecs/umn/en-us_image_0128851444.png rename to docs/ecs/umn/en-us_image_0128851444.png diff --git a/ecs/umn/en-us_image_0128851621.png b/docs/ecs/umn/en-us_image_0128851621.png similarity index 100% rename from ecs/umn/en-us_image_0128851621.png rename to docs/ecs/umn/en-us_image_0128851621.png diff --git a/ecs/umn/en-us_image_0128851717.png b/docs/ecs/umn/en-us_image_0128851717.png similarity index 100% rename from ecs/umn/en-us_image_0128851717.png rename to docs/ecs/umn/en-us_image_0128851717.png diff --git a/ecs/umn/en-us_image_0132359404.png b/docs/ecs/umn/en-us_image_0132359404.png similarity index 100% rename from ecs/umn/en-us_image_0132359404.png rename to docs/ecs/umn/en-us_image_0132359404.png diff --git a/ecs/umn/en-us_image_0132360430.png b/docs/ecs/umn/en-us_image_0132360430.png similarity index 100% rename from ecs/umn/en-us_image_0132360430.png rename to docs/ecs/umn/en-us_image_0132360430.png diff --git a/ecs/umn/en-us_image_0132368216.png b/docs/ecs/umn/en-us_image_0132368216.png similarity index 100% rename from ecs/umn/en-us_image_0132368216.png rename to docs/ecs/umn/en-us_image_0132368216.png diff --git a/ecs/umn/en-us_image_0142359884.png b/docs/ecs/umn/en-us_image_0142359884.png similarity index 100% rename from ecs/umn/en-us_image_0142359884.png rename to docs/ecs/umn/en-us_image_0142359884.png diff --git a/ecs/umn/en-us_image_0142360062.png b/docs/ecs/umn/en-us_image_0142360062.png similarity index 100% rename from ecs/umn/en-us_image_0142360062.png rename to docs/ecs/umn/en-us_image_0142360062.png diff --git a/ecs/umn/en-us_image_0146087803.png b/docs/ecs/umn/en-us_image_0146087803.png similarity index 100% rename from ecs/umn/en-us_image_0146087803.png rename to docs/ecs/umn/en-us_image_0146087803.png diff --git a/ecs/umn/en-us_image_0152727234.png b/docs/ecs/umn/en-us_image_0152727234.png similarity index 100% rename from ecs/umn/en-us_image_0152727234.png rename to docs/ecs/umn/en-us_image_0152727234.png diff --git a/ecs/umn/en-us_image_0152768827.png b/docs/ecs/umn/en-us_image_0152768827.png similarity index 100% rename from ecs/umn/en-us_image_0152768827.png rename to docs/ecs/umn/en-us_image_0152768827.png diff --git a/ecs/umn/en-us_image_0157904965.png b/docs/ecs/umn/en-us_image_0157904965.png similarity index 100% rename from ecs/umn/en-us_image_0157904965.png rename to docs/ecs/umn/en-us_image_0157904965.png diff --git a/ecs/umn/en-us_image_0159943784.png b/docs/ecs/umn/en-us_image_0159943784.png similarity index 100% rename from ecs/umn/en-us_image_0159943784.png rename to docs/ecs/umn/en-us_image_0159943784.png diff --git a/ecs/umn/en-us_image_0166287336.png b/docs/ecs/umn/en-us_image_0166287336.png similarity index 100% rename from ecs/umn/en-us_image_0166287336.png rename to docs/ecs/umn/en-us_image_0166287336.png diff --git a/ecs/umn/en-us_image_0166287347.png b/docs/ecs/umn/en-us_image_0166287347.png similarity index 100% rename from ecs/umn/en-us_image_0166287347.png rename to docs/ecs/umn/en-us_image_0166287347.png diff --git a/ecs/umn/en-us_image_0166287348.png b/docs/ecs/umn/en-us_image_0166287348.png similarity index 100% rename from ecs/umn/en-us_image_0166287348.png rename to docs/ecs/umn/en-us_image_0166287348.png diff --git a/ecs/umn/en-us_image_0166287349.png b/docs/ecs/umn/en-us_image_0166287349.png similarity index 100% rename from ecs/umn/en-us_image_0166287349.png rename to docs/ecs/umn/en-us_image_0166287349.png diff --git a/ecs/umn/en-us_image_0166287351.png b/docs/ecs/umn/en-us_image_0166287351.png similarity index 100% rename from ecs/umn/en-us_image_0166287351.png rename to docs/ecs/umn/en-us_image_0166287351.png diff --git a/ecs/umn/en-us_image_0166736726.png b/docs/ecs/umn/en-us_image_0166736726.png similarity index 100% rename from ecs/umn/en-us_image_0166736726.png rename to docs/ecs/umn/en-us_image_0166736726.png diff --git a/ecs/umn/en-us_image_0166755236.png b/docs/ecs/umn/en-us_image_0166755236.png similarity index 100% rename from ecs/umn/en-us_image_0166755236.png rename to docs/ecs/umn/en-us_image_0166755236.png diff --git a/ecs/umn/en-us_image_0166945975.png b/docs/ecs/umn/en-us_image_0166945975.png similarity index 100% rename from ecs/umn/en-us_image_0166945975.png rename to docs/ecs/umn/en-us_image_0166945975.png diff --git a/ecs/umn/en-us_image_0166947771.png b/docs/ecs/umn/en-us_image_0166947771.png similarity index 100% rename from ecs/umn/en-us_image_0166947771.png rename to docs/ecs/umn/en-us_image_0166947771.png diff --git a/ecs/umn/en-us_image_0166947775.png b/docs/ecs/umn/en-us_image_0166947775.png similarity index 100% rename from ecs/umn/en-us_image_0166947775.png rename to docs/ecs/umn/en-us_image_0166947775.png diff --git a/ecs/umn/en-us_image_0167110971.png b/docs/ecs/umn/en-us_image_0167110971.png similarity index 100% rename from ecs/umn/en-us_image_0167110971.png rename to docs/ecs/umn/en-us_image_0167110971.png diff --git a/ecs/umn/en-us_image_0167295759.png b/docs/ecs/umn/en-us_image_0167295759.png similarity index 100% rename from ecs/umn/en-us_image_0167295759.png rename to docs/ecs/umn/en-us_image_0167295759.png diff --git a/ecs/umn/en-us_image_0171575801.png b/docs/ecs/umn/en-us_image_0171575801.png similarity index 100% rename from ecs/umn/en-us_image_0171575801.png rename to docs/ecs/umn/en-us_image_0171575801.png diff --git a/ecs/umn/en-us_image_0171674763.png b/docs/ecs/umn/en-us_image_0171674763.png similarity index 100% rename from ecs/umn/en-us_image_0171674763.png rename to docs/ecs/umn/en-us_image_0171674763.png diff --git a/ecs/umn/en-us_image_0172453607.png b/docs/ecs/umn/en-us_image_0172453607.png similarity index 100% rename from ecs/umn/en-us_image_0172453607.png rename to docs/ecs/umn/en-us_image_0172453607.png diff --git a/ecs/umn/en-us_image_0174076025.png b/docs/ecs/umn/en-us_image_0174076025.png similarity index 100% rename from ecs/umn/en-us_image_0174076025.png rename to docs/ecs/umn/en-us_image_0174076025.png diff --git a/ecs/umn/en-us_image_0175083503.png b/docs/ecs/umn/en-us_image_0175083503.png similarity index 100% rename from ecs/umn/en-us_image_0175083503.png rename to docs/ecs/umn/en-us_image_0175083503.png diff --git a/ecs/umn/en-us_image_0175083504.png b/docs/ecs/umn/en-us_image_0175083504.png similarity index 100% rename from ecs/umn/en-us_image_0175083504.png rename to docs/ecs/umn/en-us_image_0175083504.png diff --git a/ecs/umn/en-us_image_0175083507.png b/docs/ecs/umn/en-us_image_0175083507.png similarity index 100% rename from ecs/umn/en-us_image_0175083507.png rename to docs/ecs/umn/en-us_image_0175083507.png diff --git a/ecs/umn/en-us_image_0175083508.png b/docs/ecs/umn/en-us_image_0175083508.png similarity index 100% rename from ecs/umn/en-us_image_0175083508.png rename to docs/ecs/umn/en-us_image_0175083508.png diff --git a/ecs/umn/en-us_image_0175083509.png b/docs/ecs/umn/en-us_image_0175083509.png similarity index 100% rename from ecs/umn/en-us_image_0175083509.png rename to docs/ecs/umn/en-us_image_0175083509.png diff --git a/ecs/umn/en-us_image_0175083510.png b/docs/ecs/umn/en-us_image_0175083510.png similarity index 100% rename from ecs/umn/en-us_image_0175083510.png rename to docs/ecs/umn/en-us_image_0175083510.png diff --git a/ecs/umn/en-us_image_0175083511.png b/docs/ecs/umn/en-us_image_0175083511.png similarity index 100% rename from ecs/umn/en-us_image_0175083511.png rename to docs/ecs/umn/en-us_image_0175083511.png diff --git a/ecs/umn/en-us_image_0175083512.png b/docs/ecs/umn/en-us_image_0175083512.png similarity index 100% rename from ecs/umn/en-us_image_0175083512.png rename to docs/ecs/umn/en-us_image_0175083512.png diff --git a/ecs/umn/en-us_image_0175083513.png b/docs/ecs/umn/en-us_image_0175083513.png similarity index 100% rename from ecs/umn/en-us_image_0175083513.png rename to docs/ecs/umn/en-us_image_0175083513.png diff --git a/ecs/umn/en-us_image_0175083515.png b/docs/ecs/umn/en-us_image_0175083515.png similarity index 100% rename from ecs/umn/en-us_image_0175083515.png rename to docs/ecs/umn/en-us_image_0175083515.png diff --git a/ecs/umn/en-us_image_0178069404.png b/docs/ecs/umn/en-us_image_0178069404.png similarity index 100% rename from ecs/umn/en-us_image_0178069404.png rename to docs/ecs/umn/en-us_image_0178069404.png diff --git a/ecs/umn/en-us_image_0178325096.png b/docs/ecs/umn/en-us_image_0178325096.png similarity index 100% rename from ecs/umn/en-us_image_0178325096.png rename to docs/ecs/umn/en-us_image_0178325096.png diff --git a/ecs/umn/en-us_image_0178334448.png b/docs/ecs/umn/en-us_image_0178334448.png similarity index 100% rename from ecs/umn/en-us_image_0178334448.png rename to docs/ecs/umn/en-us_image_0178334448.png diff --git a/ecs/umn/en-us_image_0178334449.png b/docs/ecs/umn/en-us_image_0178334449.png similarity index 100% rename from ecs/umn/en-us_image_0178334449.png rename to docs/ecs/umn/en-us_image_0178334449.png diff --git a/ecs/umn/en-us_image_0178334450.png b/docs/ecs/umn/en-us_image_0178334450.png similarity index 100% rename from ecs/umn/en-us_image_0178334450.png rename to docs/ecs/umn/en-us_image_0178334450.png diff --git a/ecs/umn/en-us_image_0178370293.png b/docs/ecs/umn/en-us_image_0178370293.png similarity index 100% rename from ecs/umn/en-us_image_0178370293.png rename to docs/ecs/umn/en-us_image_0178370293.png diff --git a/ecs/umn/en-us_image_0178475901.png b/docs/ecs/umn/en-us_image_0178475901.png similarity index 100% rename from ecs/umn/en-us_image_0178475901.png rename to docs/ecs/umn/en-us_image_0178475901.png diff --git a/ecs/umn/en-us_image_0178890066.png b/docs/ecs/umn/en-us_image_0178890066.png similarity index 100% rename from ecs/umn/en-us_image_0178890066.png rename to docs/ecs/umn/en-us_image_0178890066.png diff --git a/ecs/umn/en-us_image_0182087025.png b/docs/ecs/umn/en-us_image_0182087025.png similarity index 100% rename from ecs/umn/en-us_image_0182087025.png rename to docs/ecs/umn/en-us_image_0182087025.png diff --git a/ecs/umn/en-us_image_0183030460.png b/docs/ecs/umn/en-us_image_0183030460.png similarity index 100% rename from ecs/umn/en-us_image_0183030460.png rename to docs/ecs/umn/en-us_image_0183030460.png diff --git a/ecs/umn/en-us_image_0184026531.png b/docs/ecs/umn/en-us_image_0184026531.png similarity index 100% rename from ecs/umn/en-us_image_0184026531.png rename to docs/ecs/umn/en-us_image_0184026531.png diff --git a/ecs/umn/en-us_image_0188029785.png b/docs/ecs/umn/en-us_image_0188029785.png similarity index 100% rename from ecs/umn/en-us_image_0188029785.png rename to docs/ecs/umn/en-us_image_0188029785.png diff --git a/ecs/umn/en-us_image_0193026956.png b/docs/ecs/umn/en-us_image_0193026956.png similarity index 100% rename from ecs/umn/en-us_image_0193026956.png rename to docs/ecs/umn/en-us_image_0193026956.png diff --git a/ecs/umn/en-us_image_0201100229.png b/docs/ecs/umn/en-us_image_0201100229.png similarity index 100% rename from ecs/umn/en-us_image_0201100229.png rename to docs/ecs/umn/en-us_image_0201100229.png diff --git a/ecs/umn/en-us_image_0201103161.png b/docs/ecs/umn/en-us_image_0201103161.png similarity index 100% rename from ecs/umn/en-us_image_0201103161.png rename to docs/ecs/umn/en-us_image_0201103161.png diff --git a/ecs/umn/en-us_image_0201719710.png b/docs/ecs/umn/en-us_image_0201719710.png similarity index 100% rename from ecs/umn/en-us_image_0201719710.png rename to docs/ecs/umn/en-us_image_0201719710.png diff --git a/ecs/umn/en-us_image_0201719715.png b/docs/ecs/umn/en-us_image_0201719715.png similarity index 100% rename from ecs/umn/en-us_image_0201719715.png rename to docs/ecs/umn/en-us_image_0201719715.png diff --git a/ecs/umn/en-us_image_0202311481.gif b/docs/ecs/umn/en-us_image_0202311481.gif similarity index 100% rename from ecs/umn/en-us_image_0202311481.gif rename to docs/ecs/umn/en-us_image_0202311481.gif diff --git a/ecs/umn/en-us_image_0202311491.gif b/docs/ecs/umn/en-us_image_0202311491.gif similarity index 100% rename from ecs/umn/en-us_image_0202311491.gif rename to docs/ecs/umn/en-us_image_0202311491.gif diff --git a/ecs/umn/en-us_image_0210779229.png b/docs/ecs/umn/en-us_image_0210779229.png similarity index 100% rename from ecs/umn/en-us_image_0210779229.png rename to docs/ecs/umn/en-us_image_0210779229.png diff --git a/ecs/umn/en-us_image_0210875480.png b/docs/ecs/umn/en-us_image_0210875480.png similarity index 100% rename from ecs/umn/en-us_image_0210875480.png rename to docs/ecs/umn/en-us_image_0210875480.png diff --git a/ecs/umn/en-us_image_0210875481.png b/docs/ecs/umn/en-us_image_0210875481.png similarity index 100% rename from ecs/umn/en-us_image_0210875481.png rename to docs/ecs/umn/en-us_image_0210875481.png diff --git a/ecs/umn/en-us_image_0210875482.png b/docs/ecs/umn/en-us_image_0210875482.png similarity index 100% rename from ecs/umn/en-us_image_0210875482.png rename to docs/ecs/umn/en-us_image_0210875482.png diff --git a/ecs/umn/en-us_image_0210875483.png b/docs/ecs/umn/en-us_image_0210875483.png similarity index 100% rename from ecs/umn/en-us_image_0210875483.png rename to docs/ecs/umn/en-us_image_0210875483.png diff --git a/ecs/umn/en-us_image_0214947577.png b/docs/ecs/umn/en-us_image_0214947577.png similarity index 100% rename from ecs/umn/en-us_image_0214947577.png rename to docs/ecs/umn/en-us_image_0214947577.png diff --git a/ecs/umn/en-us_image_0214947578.png b/docs/ecs/umn/en-us_image_0214947578.png similarity index 100% rename from ecs/umn/en-us_image_0214947578.png rename to docs/ecs/umn/en-us_image_0214947578.png diff --git a/ecs/umn/en-us_image_0214947579.png b/docs/ecs/umn/en-us_image_0214947579.png similarity index 100% rename from ecs/umn/en-us_image_0214947579.png rename to docs/ecs/umn/en-us_image_0214947579.png diff --git a/ecs/umn/en-us_image_0214947580.png b/docs/ecs/umn/en-us_image_0214947580.png similarity index 100% rename from ecs/umn/en-us_image_0214947580.png rename to docs/ecs/umn/en-us_image_0214947580.png diff --git a/ecs/umn/en-us_image_0214947581.png b/docs/ecs/umn/en-us_image_0214947581.png similarity index 100% rename from ecs/umn/en-us_image_0214947581.png rename to docs/ecs/umn/en-us_image_0214947581.png diff --git a/ecs/umn/en-us_image_0214947582.png b/docs/ecs/umn/en-us_image_0214947582.png similarity index 100% rename from ecs/umn/en-us_image_0214947582.png rename to docs/ecs/umn/en-us_image_0214947582.png diff --git a/ecs/umn/en-us_image_0214947583.png b/docs/ecs/umn/en-us_image_0214947583.png similarity index 100% rename from ecs/umn/en-us_image_0214947583.png rename to docs/ecs/umn/en-us_image_0214947583.png diff --git a/ecs/umn/en-us_image_0216898618.png b/docs/ecs/umn/en-us_image_0216898618.png similarity index 100% rename from ecs/umn/en-us_image_0216898618.png rename to docs/ecs/umn/en-us_image_0216898618.png diff --git a/ecs/umn/en-us_image_0224317546.png b/docs/ecs/umn/en-us_image_0224317546.png similarity index 100% rename from ecs/umn/en-us_image_0224317546.png rename to docs/ecs/umn/en-us_image_0224317546.png diff --git a/ecs/umn/en-us_image_0225439857.png b/docs/ecs/umn/en-us_image_0225439857.png similarity index 100% rename from ecs/umn/en-us_image_0225439857.png rename to docs/ecs/umn/en-us_image_0225439857.png diff --git a/ecs/umn/en-us_image_0234354896.png b/docs/ecs/umn/en-us_image_0234354896.png similarity index 100% rename from ecs/umn/en-us_image_0234354896.png rename to docs/ecs/umn/en-us_image_0234354896.png diff --git a/ecs/umn/en-us_image_0234354931.png b/docs/ecs/umn/en-us_image_0234354931.png similarity index 100% rename from ecs/umn/en-us_image_0234354931.png rename to docs/ecs/umn/en-us_image_0234354931.png diff --git a/ecs/umn/en-us_image_0234355284.png b/docs/ecs/umn/en-us_image_0234355284.png similarity index 100% rename from ecs/umn/en-us_image_0234355284.png rename to docs/ecs/umn/en-us_image_0234355284.png diff --git a/ecs/umn/en-us_image_0234355299.png b/docs/ecs/umn/en-us_image_0234355299.png similarity index 100% rename from ecs/umn/en-us_image_0234355299.png rename to docs/ecs/umn/en-us_image_0234355299.png diff --git a/ecs/umn/en-us_image_0234355305.png b/docs/ecs/umn/en-us_image_0234355305.png similarity index 100% rename from ecs/umn/en-us_image_0234355305.png rename to docs/ecs/umn/en-us_image_0234355305.png diff --git a/ecs/umn/en-us_image_0234356929.png b/docs/ecs/umn/en-us_image_0234356929.png similarity index 100% rename from ecs/umn/en-us_image_0234356929.png rename to docs/ecs/umn/en-us_image_0234356929.png diff --git a/ecs/umn/en-us_image_0234356990.png b/docs/ecs/umn/en-us_image_0234356990.png similarity index 100% rename from ecs/umn/en-us_image_0234356990.png rename to docs/ecs/umn/en-us_image_0234356990.png diff --git a/ecs/umn/en-us_image_0234357031.png b/docs/ecs/umn/en-us_image_0234357031.png similarity index 100% rename from ecs/umn/en-us_image_0234357031.png rename to docs/ecs/umn/en-us_image_0234357031.png diff --git a/ecs/umn/en-us_image_0234357053.png b/docs/ecs/umn/en-us_image_0234357053.png similarity index 100% rename from ecs/umn/en-us_image_0234357053.png rename to docs/ecs/umn/en-us_image_0234357053.png diff --git a/ecs/umn/en-us_image_0234357336.png b/docs/ecs/umn/en-us_image_0234357336.png similarity index 100% rename from ecs/umn/en-us_image_0234357336.png rename to docs/ecs/umn/en-us_image_0234357336.png diff --git a/ecs/umn/en-us_image_0234357355.png b/docs/ecs/umn/en-us_image_0234357355.png similarity index 100% rename from ecs/umn/en-us_image_0234357355.png rename to docs/ecs/umn/en-us_image_0234357355.png diff --git a/ecs/umn/en-us_image_0234357365.png b/docs/ecs/umn/en-us_image_0234357365.png similarity index 100% rename from ecs/umn/en-us_image_0234357365.png rename to docs/ecs/umn/en-us_image_0234357365.png diff --git a/ecs/umn/en-us_image_0234357385.png b/docs/ecs/umn/en-us_image_0234357385.png similarity index 100% rename from ecs/umn/en-us_image_0234357385.png rename to docs/ecs/umn/en-us_image_0234357385.png diff --git a/ecs/umn/en-us_image_0234358619.png b/docs/ecs/umn/en-us_image_0234358619.png similarity index 100% rename from ecs/umn/en-us_image_0234358619.png rename to docs/ecs/umn/en-us_image_0234358619.png diff --git a/ecs/umn/en-us_image_0234358634.png b/docs/ecs/umn/en-us_image_0234358634.png similarity index 100% rename from ecs/umn/en-us_image_0234358634.png rename to docs/ecs/umn/en-us_image_0234358634.png diff --git a/ecs/umn/en-us_image_0234358642.png b/docs/ecs/umn/en-us_image_0234358642.png similarity index 100% rename from ecs/umn/en-us_image_0234358642.png rename to docs/ecs/umn/en-us_image_0234358642.png diff --git a/ecs/umn/en-us_image_0234358704.png b/docs/ecs/umn/en-us_image_0234358704.png similarity index 100% rename from ecs/umn/en-us_image_0234358704.png rename to docs/ecs/umn/en-us_image_0234358704.png diff --git a/ecs/umn/en-us_image_0234358719.png b/docs/ecs/umn/en-us_image_0234358719.png similarity index 100% rename from ecs/umn/en-us_image_0234358719.png rename to docs/ecs/umn/en-us_image_0234358719.png diff --git a/ecs/umn/en-us_image_0234358804.png b/docs/ecs/umn/en-us_image_0234358804.png similarity index 100% rename from ecs/umn/en-us_image_0234358804.png rename to docs/ecs/umn/en-us_image_0234358804.png diff --git a/ecs/umn/en-us_image_0234360248.png b/docs/ecs/umn/en-us_image_0234360248.png similarity index 100% rename from ecs/umn/en-us_image_0234360248.png rename to docs/ecs/umn/en-us_image_0234360248.png diff --git a/ecs/umn/en-us_image_0234360255.png b/docs/ecs/umn/en-us_image_0234360255.png similarity index 100% rename from ecs/umn/en-us_image_0234360255.png rename to docs/ecs/umn/en-us_image_0234360255.png diff --git a/ecs/umn/en-us_image_0234360274.png b/docs/ecs/umn/en-us_image_0234360274.png similarity index 100% rename from ecs/umn/en-us_image_0234360274.png rename to docs/ecs/umn/en-us_image_0234360274.png diff --git a/ecs/umn/en-us_image_0234360293.png b/docs/ecs/umn/en-us_image_0234360293.png similarity index 100% rename from ecs/umn/en-us_image_0234360293.png rename to docs/ecs/umn/en-us_image_0234360293.png diff --git a/ecs/umn/en-us_image_0237026761.png b/docs/ecs/umn/en-us_image_0237026761.png similarity index 100% rename from ecs/umn/en-us_image_0237026761.png rename to docs/ecs/umn/en-us_image_0237026761.png diff --git a/ecs/umn/en-us_image_0238263336.png b/docs/ecs/umn/en-us_image_0238263336.png similarity index 100% rename from ecs/umn/en-us_image_0238263336.png rename to docs/ecs/umn/en-us_image_0238263336.png diff --git a/ecs/umn/en-us_image_0240710552.png b/docs/ecs/umn/en-us_image_0240710552.png similarity index 100% rename from ecs/umn/en-us_image_0240710552.png rename to docs/ecs/umn/en-us_image_0240710552.png diff --git a/ecs/umn/en-us_image_0240710554.png b/docs/ecs/umn/en-us_image_0240710554.png similarity index 100% rename from ecs/umn/en-us_image_0240710554.png rename to docs/ecs/umn/en-us_image_0240710554.png diff --git a/ecs/umn/en-us_image_0240710555.png b/docs/ecs/umn/en-us_image_0240710555.png similarity index 100% rename from ecs/umn/en-us_image_0240710555.png rename to docs/ecs/umn/en-us_image_0240710555.png diff --git a/ecs/umn/en-us_image_0240710556.png b/docs/ecs/umn/en-us_image_0240710556.png similarity index 100% rename from ecs/umn/en-us_image_0240710556.png rename to docs/ecs/umn/en-us_image_0240710556.png diff --git a/ecs/umn/en-us_image_0240711431.png b/docs/ecs/umn/en-us_image_0240711431.png similarity index 100% rename from ecs/umn/en-us_image_0240711431.png rename to docs/ecs/umn/en-us_image_0240711431.png diff --git a/ecs/umn/en-us_image_0240714761.png b/docs/ecs/umn/en-us_image_0240714761.png similarity index 100% rename from ecs/umn/en-us_image_0240714761.png rename to docs/ecs/umn/en-us_image_0240714761.png diff --git a/ecs/umn/en-us_image_0244856480.png b/docs/ecs/umn/en-us_image_0244856480.png similarity index 100% rename from ecs/umn/en-us_image_0244856480.png rename to docs/ecs/umn/en-us_image_0244856480.png diff --git a/ecs/umn/en-us_image_0244859999.png b/docs/ecs/umn/en-us_image_0244859999.png similarity index 100% rename from ecs/umn/en-us_image_0244859999.png rename to docs/ecs/umn/en-us_image_0244859999.png diff --git a/ecs/umn/en-us_image_0244860550.png b/docs/ecs/umn/en-us_image_0244860550.png similarity index 100% rename from ecs/umn/en-us_image_0244860550.png rename to docs/ecs/umn/en-us_image_0244860550.png diff --git a/ecs/umn/en-us_image_0247293312.png b/docs/ecs/umn/en-us_image_0247293312.png similarity index 100% rename from ecs/umn/en-us_image_0247293312.png rename to docs/ecs/umn/en-us_image_0247293312.png diff --git a/ecs/umn/en-us_image_0247338934.png b/docs/ecs/umn/en-us_image_0247338934.png similarity index 100% rename from ecs/umn/en-us_image_0247338934.png rename to docs/ecs/umn/en-us_image_0247338934.png diff --git a/ecs/umn/en-us_image_0250105611.png b/docs/ecs/umn/en-us_image_0250105611.png similarity index 100% rename from ecs/umn/en-us_image_0250105611.png rename to docs/ecs/umn/en-us_image_0250105611.png diff --git a/ecs/umn/en-us_image_0250117342.png b/docs/ecs/umn/en-us_image_0250117342.png similarity index 100% rename from ecs/umn/en-us_image_0250117342.png rename to docs/ecs/umn/en-us_image_0250117342.png diff --git a/ecs/umn/en-us_image_0250182352.png b/docs/ecs/umn/en-us_image_0250182352.png similarity index 100% rename from ecs/umn/en-us_image_0250182352.png rename to docs/ecs/umn/en-us_image_0250182352.png diff --git a/ecs/umn/en-us_image_0250182717.png b/docs/ecs/umn/en-us_image_0250182717.png similarity index 100% rename from ecs/umn/en-us_image_0250182717.png rename to docs/ecs/umn/en-us_image_0250182717.png diff --git a/ecs/umn/en-us_image_0250287387.png b/docs/ecs/umn/en-us_image_0250287387.png similarity index 100% rename from ecs/umn/en-us_image_0250287387.png rename to docs/ecs/umn/en-us_image_0250287387.png diff --git a/ecs/umn/en-us_image_0250287611.png b/docs/ecs/umn/en-us_image_0250287611.png similarity index 100% rename from ecs/umn/en-us_image_0250287611.png rename to docs/ecs/umn/en-us_image_0250287611.png diff --git a/ecs/umn/en-us_image_0250288087.png b/docs/ecs/umn/en-us_image_0250288087.png similarity index 100% rename from ecs/umn/en-us_image_0250288087.png rename to docs/ecs/umn/en-us_image_0250288087.png diff --git a/ecs/umn/en-us_image_0250288371.png b/docs/ecs/umn/en-us_image_0250288371.png similarity index 100% rename from ecs/umn/en-us_image_0250288371.png rename to docs/ecs/umn/en-us_image_0250288371.png diff --git a/ecs/umn/en-us_image_0250288474.png b/docs/ecs/umn/en-us_image_0250288474.png similarity index 100% rename from ecs/umn/en-us_image_0250288474.png rename to docs/ecs/umn/en-us_image_0250288474.png diff --git a/ecs/umn/en-us_image_0250288895.png b/docs/ecs/umn/en-us_image_0250288895.png similarity index 100% rename from ecs/umn/en-us_image_0250288895.png rename to docs/ecs/umn/en-us_image_0250288895.png diff --git a/ecs/umn/en-us_image_0250289123.png b/docs/ecs/umn/en-us_image_0250289123.png similarity index 100% rename from ecs/umn/en-us_image_0250289123.png rename to docs/ecs/umn/en-us_image_0250289123.png diff --git a/ecs/umn/en-us_image_0251063932.png b/docs/ecs/umn/en-us_image_0251063932.png similarity index 100% rename from ecs/umn/en-us_image_0251063932.png rename to docs/ecs/umn/en-us_image_0251063932.png diff --git a/ecs/umn/en-us_image_0253037157.png b/docs/ecs/umn/en-us_image_0253037157.png similarity index 100% rename from ecs/umn/en-us_image_0253037157.png rename to docs/ecs/umn/en-us_image_0253037157.png diff --git a/ecs/umn/en-us_image_0260575520.png b/docs/ecs/umn/en-us_image_0260575520.png similarity index 100% rename from ecs/umn/en-us_image_0260575520.png rename to docs/ecs/umn/en-us_image_0260575520.png diff --git a/ecs/umn/en-us_image_0260575521.png b/docs/ecs/umn/en-us_image_0260575521.png similarity index 100% rename from ecs/umn/en-us_image_0260575521.png rename to docs/ecs/umn/en-us_image_0260575521.png diff --git a/ecs/umn/en-us_image_0263796649.png b/docs/ecs/umn/en-us_image_0263796649.png similarity index 100% rename from ecs/umn/en-us_image_0263796649.png rename to docs/ecs/umn/en-us_image_0263796649.png diff --git a/ecs/umn/en-us_image_0263796651.png b/docs/ecs/umn/en-us_image_0263796651.png similarity index 100% rename from ecs/umn/en-us_image_0263796651.png rename to docs/ecs/umn/en-us_image_0263796651.png diff --git a/ecs/umn/en-us_image_0263798009.png b/docs/ecs/umn/en-us_image_0263798009.png similarity index 100% rename from ecs/umn/en-us_image_0263798009.png rename to docs/ecs/umn/en-us_image_0263798009.png diff --git a/ecs/umn/en-us_image_0263798010.png b/docs/ecs/umn/en-us_image_0263798010.png similarity index 100% rename from ecs/umn/en-us_image_0263798010.png rename to docs/ecs/umn/en-us_image_0263798010.png diff --git a/ecs/umn/en-us_image_0263798011.png b/docs/ecs/umn/en-us_image_0263798011.png similarity index 100% rename from ecs/umn/en-us_image_0263798011.png rename to docs/ecs/umn/en-us_image_0263798011.png diff --git a/ecs/umn/en-us_image_0263798012.png b/docs/ecs/umn/en-us_image_0263798012.png similarity index 100% rename from ecs/umn/en-us_image_0263798012.png rename to docs/ecs/umn/en-us_image_0263798012.png diff --git a/ecs/umn/en-us_image_0263806339.png b/docs/ecs/umn/en-us_image_0263806339.png similarity index 100% rename from ecs/umn/en-us_image_0263806339.png rename to docs/ecs/umn/en-us_image_0263806339.png diff --git a/ecs/umn/en-us_image_0267133745.png b/docs/ecs/umn/en-us_image_0267133745.png similarity index 100% rename from ecs/umn/en-us_image_0267133745.png rename to docs/ecs/umn/en-us_image_0267133745.png diff --git a/ecs/umn/en-us_image_0268824628.png b/docs/ecs/umn/en-us_image_0268824628.png similarity index 100% rename from ecs/umn/en-us_image_0268824628.png rename to docs/ecs/umn/en-us_image_0268824628.png diff --git a/ecs/umn/en-us_image_0268825353.png b/docs/ecs/umn/en-us_image_0268825353.png similarity index 100% rename from ecs/umn/en-us_image_0268825353.png rename to docs/ecs/umn/en-us_image_0268825353.png diff --git a/ecs/umn/en-us_image_0268826092.png b/docs/ecs/umn/en-us_image_0268826092.png similarity index 100% rename from ecs/umn/en-us_image_0268826092.png rename to docs/ecs/umn/en-us_image_0268826092.png diff --git a/ecs/umn/en-us_image_0272917695.png b/docs/ecs/umn/en-us_image_0272917695.png similarity index 100% rename from ecs/umn/en-us_image_0272917695.png rename to docs/ecs/umn/en-us_image_0272917695.png diff --git a/ecs/umn/en-us_image_0272919399.png b/docs/ecs/umn/en-us_image_0272919399.png similarity index 100% rename from ecs/umn/en-us_image_0272919399.png rename to docs/ecs/umn/en-us_image_0272919399.png diff --git a/ecs/umn/en-us_image_0272919409.png b/docs/ecs/umn/en-us_image_0272919409.png similarity index 100% rename from ecs/umn/en-us_image_0272919409.png rename to docs/ecs/umn/en-us_image_0272919409.png diff --git a/ecs/umn/en-us_image_0275513364.png b/docs/ecs/umn/en-us_image_0275513364.png similarity index 100% rename from ecs/umn/en-us_image_0275513364.png rename to docs/ecs/umn/en-us_image_0275513364.png diff --git a/ecs/umn/en-us_image_0275724694.png b/docs/ecs/umn/en-us_image_0275724694.png similarity index 100% rename from ecs/umn/en-us_image_0275724694.png rename to docs/ecs/umn/en-us_image_0275724694.png diff --git a/ecs/umn/en-us_image_0275726221.png b/docs/ecs/umn/en-us_image_0275726221.png similarity index 100% rename from ecs/umn/en-us_image_0275726221.png rename to docs/ecs/umn/en-us_image_0275726221.png diff --git a/ecs/umn/en-us_image_0276033982.png b/docs/ecs/umn/en-us_image_0276033982.png similarity index 100% rename from ecs/umn/en-us_image_0276033982.png rename to docs/ecs/umn/en-us_image_0276033982.png diff --git a/ecs/umn/en-us_image_0277132897.png b/docs/ecs/umn/en-us_image_0277132897.png similarity index 100% rename from ecs/umn/en-us_image_0277132897.png rename to docs/ecs/umn/en-us_image_0277132897.png diff --git a/ecs/umn/en-us_image_0281771106.png b/docs/ecs/umn/en-us_image_0281771106.png similarity index 100% rename from ecs/umn/en-us_image_0281771106.png rename to docs/ecs/umn/en-us_image_0281771106.png diff --git a/ecs/umn/en-us_image_0281773972.png b/docs/ecs/umn/en-us_image_0281773972.png similarity index 100% rename from ecs/umn/en-us_image_0281773972.png rename to docs/ecs/umn/en-us_image_0281773972.png diff --git a/ecs/umn/en-us_image_0281775402.png b/docs/ecs/umn/en-us_image_0281775402.png similarity index 100% rename from ecs/umn/en-us_image_0281775402.png rename to docs/ecs/umn/en-us_image_0281775402.png diff --git a/ecs/umn/en-us_image_0284920908.png b/docs/ecs/umn/en-us_image_0284920908.png similarity index 100% rename from ecs/umn/en-us_image_0284920908.png rename to docs/ecs/umn/en-us_image_0284920908.png diff --git a/ecs/umn/en-us_image_0284993717.png b/docs/ecs/umn/en-us_image_0284993717.png similarity index 100% rename from ecs/umn/en-us_image_0284993717.png rename to docs/ecs/umn/en-us_image_0284993717.png diff --git a/ecs/umn/en-us_image_0288997242.png b/docs/ecs/umn/en-us_image_0288997242.png similarity index 100% rename from ecs/umn/en-us_image_0288997242.png rename to docs/ecs/umn/en-us_image_0288997242.png diff --git a/ecs/umn/en-us_image_0288997243.png b/docs/ecs/umn/en-us_image_0288997243.png similarity index 100% rename from ecs/umn/en-us_image_0288997243.png rename to docs/ecs/umn/en-us_image_0288997243.png diff --git a/ecs/umn/en-us_image_0288997244.png b/docs/ecs/umn/en-us_image_0288997244.png similarity index 100% rename from ecs/umn/en-us_image_0288997244.png rename to docs/ecs/umn/en-us_image_0288997244.png diff --git a/ecs/umn/en-us_image_0288997245.png b/docs/ecs/umn/en-us_image_0288997245.png similarity index 100% rename from ecs/umn/en-us_image_0288997245.png rename to docs/ecs/umn/en-us_image_0288997245.png diff --git a/ecs/umn/en-us_image_0288997246.png b/docs/ecs/umn/en-us_image_0288997246.png similarity index 100% rename from ecs/umn/en-us_image_0288997246.png rename to docs/ecs/umn/en-us_image_0288997246.png diff --git a/ecs/umn/en-us_image_0288997248.png b/docs/ecs/umn/en-us_image_0288997248.png similarity index 100% rename from ecs/umn/en-us_image_0288997248.png rename to docs/ecs/umn/en-us_image_0288997248.png diff --git a/ecs/umn/en-us_image_0288997249.png b/docs/ecs/umn/en-us_image_0288997249.png similarity index 100% rename from ecs/umn/en-us_image_0288997249.png rename to docs/ecs/umn/en-us_image_0288997249.png diff --git a/ecs/umn/en-us_image_0288997250.png b/docs/ecs/umn/en-us_image_0288997250.png similarity index 100% rename from ecs/umn/en-us_image_0288997250.png rename to docs/ecs/umn/en-us_image_0288997250.png diff --git a/ecs/umn/en-us_image_0288997257.png b/docs/ecs/umn/en-us_image_0288997257.png similarity index 100% rename from ecs/umn/en-us_image_0288997257.png rename to docs/ecs/umn/en-us_image_0288997257.png diff --git a/ecs/umn/en-us_image_0288997258.png b/docs/ecs/umn/en-us_image_0288997258.png similarity index 100% rename from ecs/umn/en-us_image_0288997258.png rename to docs/ecs/umn/en-us_image_0288997258.png diff --git a/ecs/umn/en-us_image_0288997259.png b/docs/ecs/umn/en-us_image_0288997259.png similarity index 100% rename from ecs/umn/en-us_image_0288997259.png rename to docs/ecs/umn/en-us_image_0288997259.png diff --git a/ecs/umn/en-us_image_0288997286.png b/docs/ecs/umn/en-us_image_0288997286.png similarity index 100% rename from ecs/umn/en-us_image_0288997286.png rename to docs/ecs/umn/en-us_image_0288997286.png diff --git a/ecs/umn/en-us_image_0288997287.png b/docs/ecs/umn/en-us_image_0288997287.png similarity index 100% rename from ecs/umn/en-us_image_0288997287.png rename to docs/ecs/umn/en-us_image_0288997287.png diff --git a/ecs/umn/en-us_image_0288997288.png b/docs/ecs/umn/en-us_image_0288997288.png similarity index 100% rename from ecs/umn/en-us_image_0288997288.png rename to docs/ecs/umn/en-us_image_0288997288.png diff --git a/ecs/umn/en-us_image_0288997289.png b/docs/ecs/umn/en-us_image_0288997289.png similarity index 100% rename from ecs/umn/en-us_image_0288997289.png rename to docs/ecs/umn/en-us_image_0288997289.png diff --git a/ecs/umn/en-us_image_0288997290.png b/docs/ecs/umn/en-us_image_0288997290.png similarity index 100% rename from ecs/umn/en-us_image_0288997290.png rename to docs/ecs/umn/en-us_image_0288997290.png diff --git a/ecs/umn/en-us_image_0288997346.png b/docs/ecs/umn/en-us_image_0288997346.png similarity index 100% rename from ecs/umn/en-us_image_0288997346.png rename to docs/ecs/umn/en-us_image_0288997346.png diff --git a/ecs/umn/en-us_image_0288997347.png b/docs/ecs/umn/en-us_image_0288997347.png similarity index 100% rename from ecs/umn/en-us_image_0288997347.png rename to docs/ecs/umn/en-us_image_0288997347.png diff --git a/ecs/umn/en-us_image_0288997348.png b/docs/ecs/umn/en-us_image_0288997348.png similarity index 100% rename from ecs/umn/en-us_image_0288997348.png rename to docs/ecs/umn/en-us_image_0288997348.png diff --git a/ecs/umn/en-us_image_0288997349.png b/docs/ecs/umn/en-us_image_0288997349.png similarity index 100% rename from ecs/umn/en-us_image_0288997349.png rename to docs/ecs/umn/en-us_image_0288997349.png diff --git a/ecs/umn/en-us_image_0288997350.png b/docs/ecs/umn/en-us_image_0288997350.png similarity index 100% rename from ecs/umn/en-us_image_0288997350.png rename to docs/ecs/umn/en-us_image_0288997350.png diff --git a/ecs/umn/en-us_image_0288997357.png b/docs/ecs/umn/en-us_image_0288997357.png similarity index 100% rename from ecs/umn/en-us_image_0288997357.png rename to docs/ecs/umn/en-us_image_0288997357.png diff --git a/ecs/umn/en-us_image_0288997370.png b/docs/ecs/umn/en-us_image_0288997370.png similarity index 100% rename from ecs/umn/en-us_image_0288997370.png rename to docs/ecs/umn/en-us_image_0288997370.png diff --git a/ecs/umn/en-us_image_0288997371.png b/docs/ecs/umn/en-us_image_0288997371.png similarity index 100% rename from ecs/umn/en-us_image_0288997371.png rename to docs/ecs/umn/en-us_image_0288997371.png diff --git a/ecs/umn/en-us_image_0288997372.png b/docs/ecs/umn/en-us_image_0288997372.png similarity index 100% rename from ecs/umn/en-us_image_0288997372.png rename to docs/ecs/umn/en-us_image_0288997372.png diff --git a/ecs/umn/en-us_image_0288997374.png b/docs/ecs/umn/en-us_image_0288997374.png similarity index 100% rename from ecs/umn/en-us_image_0288997374.png rename to docs/ecs/umn/en-us_image_0288997374.png diff --git a/ecs/umn/en-us_image_0288997375.png b/docs/ecs/umn/en-us_image_0288997375.png similarity index 100% rename from ecs/umn/en-us_image_0288997375.png rename to docs/ecs/umn/en-us_image_0288997375.png diff --git a/ecs/umn/en-us_image_0288997421.png b/docs/ecs/umn/en-us_image_0288997421.png similarity index 100% rename from ecs/umn/en-us_image_0288997421.png rename to docs/ecs/umn/en-us_image_0288997421.png diff --git a/ecs/umn/en-us_image_0288997423.png b/docs/ecs/umn/en-us_image_0288997423.png similarity index 100% rename from ecs/umn/en-us_image_0288997423.png rename to docs/ecs/umn/en-us_image_0288997423.png diff --git a/ecs/umn/en-us_image_0288997424.png b/docs/ecs/umn/en-us_image_0288997424.png similarity index 100% rename from ecs/umn/en-us_image_0288997424.png rename to docs/ecs/umn/en-us_image_0288997424.png diff --git a/ecs/umn/en-us_image_0288997425.png b/docs/ecs/umn/en-us_image_0288997425.png similarity index 100% rename from ecs/umn/en-us_image_0288997425.png rename to docs/ecs/umn/en-us_image_0288997425.png diff --git a/ecs/umn/en-us_image_0288997426.png b/docs/ecs/umn/en-us_image_0288997426.png similarity index 100% rename from ecs/umn/en-us_image_0288997426.png rename to docs/ecs/umn/en-us_image_0288997426.png diff --git a/ecs/umn/en-us_image_0288997427.png b/docs/ecs/umn/en-us_image_0288997427.png similarity index 100% rename from ecs/umn/en-us_image_0288997427.png rename to docs/ecs/umn/en-us_image_0288997427.png diff --git a/ecs/umn/en-us_image_0288997598.png b/docs/ecs/umn/en-us_image_0288997598.png similarity index 100% rename from ecs/umn/en-us_image_0288997598.png rename to docs/ecs/umn/en-us_image_0288997598.png diff --git a/ecs/umn/en-us_image_0288997600.png b/docs/ecs/umn/en-us_image_0288997600.png similarity index 100% rename from ecs/umn/en-us_image_0288997600.png rename to docs/ecs/umn/en-us_image_0288997600.png diff --git a/ecs/umn/en-us_image_0288997602.png b/docs/ecs/umn/en-us_image_0288997602.png similarity index 100% rename from ecs/umn/en-us_image_0288997602.png rename to docs/ecs/umn/en-us_image_0288997602.png diff --git a/ecs/umn/en-us_image_0288997604.png b/docs/ecs/umn/en-us_image_0288997604.png similarity index 100% rename from ecs/umn/en-us_image_0288997604.png rename to docs/ecs/umn/en-us_image_0288997604.png diff --git a/ecs/umn/en-us_image_0288997606.png b/docs/ecs/umn/en-us_image_0288997606.png similarity index 100% rename from ecs/umn/en-us_image_0288997606.png rename to docs/ecs/umn/en-us_image_0288997606.png diff --git a/ecs/umn/en-us_image_0288997608.png b/docs/ecs/umn/en-us_image_0288997608.png similarity index 100% rename from ecs/umn/en-us_image_0288997608.png rename to docs/ecs/umn/en-us_image_0288997608.png diff --git a/ecs/umn/en-us_image_0288997610.png b/docs/ecs/umn/en-us_image_0288997610.png similarity index 100% rename from ecs/umn/en-us_image_0288997610.png rename to docs/ecs/umn/en-us_image_0288997610.png diff --git a/ecs/umn/en-us_image_0288997612.png b/docs/ecs/umn/en-us_image_0288997612.png similarity index 100% rename from ecs/umn/en-us_image_0288997612.png rename to docs/ecs/umn/en-us_image_0288997612.png diff --git a/ecs/umn/en-us_image_0288997614.png b/docs/ecs/umn/en-us_image_0288997614.png similarity index 100% rename from ecs/umn/en-us_image_0288997614.png rename to docs/ecs/umn/en-us_image_0288997614.png diff --git a/ecs/umn/en-us_image_0293553366.png b/docs/ecs/umn/en-us_image_0293553366.png similarity index 100% rename from ecs/umn/en-us_image_0293553366.png rename to docs/ecs/umn/en-us_image_0293553366.png diff --git a/ecs/umn/en-us_image_0295095212.png b/docs/ecs/umn/en-us_image_0295095212.png similarity index 100% rename from ecs/umn/en-us_image_0295095212.png rename to docs/ecs/umn/en-us_image_0295095212.png diff --git a/ecs/umn/en-us_image_0295099198.png b/docs/ecs/umn/en-us_image_0295099198.png similarity index 100% rename from ecs/umn/en-us_image_0295099198.png rename to docs/ecs/umn/en-us_image_0295099198.png diff --git a/ecs/umn/en-us_image_0295099237.png b/docs/ecs/umn/en-us_image_0295099237.png similarity index 100% rename from ecs/umn/en-us_image_0295099237.png rename to docs/ecs/umn/en-us_image_0295099237.png diff --git a/ecs/umn/en-us_image_0295099238.png b/docs/ecs/umn/en-us_image_0295099238.png similarity index 100% rename from ecs/umn/en-us_image_0295099238.png rename to docs/ecs/umn/en-us_image_0295099238.png diff --git a/ecs/umn/en-us_image_0295099239.png b/docs/ecs/umn/en-us_image_0295099239.png similarity index 100% rename from ecs/umn/en-us_image_0295099239.png rename to docs/ecs/umn/en-us_image_0295099239.png diff --git a/ecs/umn/en-us_image_0295940977.png b/docs/ecs/umn/en-us_image_0295940977.png similarity index 100% rename from ecs/umn/en-us_image_0295940977.png rename to docs/ecs/umn/en-us_image_0295940977.png diff --git a/ecs/umn/en-us_image_0295940978.png b/docs/ecs/umn/en-us_image_0295940978.png similarity index 100% rename from ecs/umn/en-us_image_0295940978.png rename to docs/ecs/umn/en-us_image_0295940978.png diff --git a/ecs/umn/en-us_image_0295941039.png b/docs/ecs/umn/en-us_image_0295941039.png similarity index 100% rename from ecs/umn/en-us_image_0295941039.png rename to docs/ecs/umn/en-us_image_0295941039.png diff --git a/ecs/umn/en-us_image_0295941040.png b/docs/ecs/umn/en-us_image_0295941040.png similarity index 100% rename from ecs/umn/en-us_image_0295941040.png rename to docs/ecs/umn/en-us_image_0295941040.png diff --git a/ecs/umn/en-us_image_0295941041.png b/docs/ecs/umn/en-us_image_0295941041.png similarity index 100% rename from ecs/umn/en-us_image_0295941041.png rename to docs/ecs/umn/en-us_image_0295941041.png diff --git a/ecs/umn/en-us_topic_0000001128445638.html b/docs/ecs/umn/en-us_topic_0000001128445638.html similarity index 100% rename from ecs/umn/en-us_topic_0000001128445638.html rename to docs/ecs/umn/en-us_topic_0000001128445638.html diff --git a/ecs/umn/en-us_topic_0000001128604648.html b/docs/ecs/umn/en-us_topic_0000001128604648.html similarity index 100% rename from ecs/umn/en-us_topic_0000001128604648.html rename to docs/ecs/umn/en-us_topic_0000001128604648.html diff --git a/ecs/umn/en-us_topic_0000001138811177.html b/docs/ecs/umn/en-us_topic_0000001138811177.html similarity index 100% rename from ecs/umn/en-us_topic_0000001138811177.html rename to docs/ecs/umn/en-us_topic_0000001138811177.html diff --git a/ecs/umn/en-us_topic_0000001143214829.html b/docs/ecs/umn/en-us_topic_0000001143214829.html similarity index 100% rename from ecs/umn/en-us_topic_0000001143214829.html rename to docs/ecs/umn/en-us_topic_0000001143214829.html diff --git a/ecs/umn/en-us_topic_0000001174675379.html b/docs/ecs/umn/en-us_topic_0000001174675379.html similarity index 100% rename from ecs/umn/en-us_topic_0000001174675379.html rename to docs/ecs/umn/en-us_topic_0000001174675379.html diff --git a/ecs/umn/en-us_topic_0000001189572473.html b/docs/ecs/umn/en-us_topic_0000001189572473.html similarity index 100% rename from ecs/umn/en-us_topic_0000001189572473.html rename to docs/ecs/umn/en-us_topic_0000001189572473.html diff --git a/ecs/umn/en-us_topic_0000001210881033.html b/docs/ecs/umn/en-us_topic_0000001210881033.html similarity index 100% rename from ecs/umn/en-us_topic_0000001210881033.html rename to docs/ecs/umn/en-us_topic_0000001210881033.html diff --git a/ecs/umn/en-us_topic_0013771089.html b/docs/ecs/umn/en-us_topic_0013771089.html similarity index 100% rename from ecs/umn/en-us_topic_0013771089.html rename to docs/ecs/umn/en-us_topic_0013771089.html diff --git a/ecs/umn/en-us_topic_0013771092.html b/docs/ecs/umn/en-us_topic_0013771092.html similarity index 100% rename from ecs/umn/en-us_topic_0013771092.html rename to docs/ecs/umn/en-us_topic_0013771092.html diff --git a/ecs/umn/en-us_topic_0013771097.html b/docs/ecs/umn/en-us_topic_0013771097.html similarity index 100% rename from ecs/umn/en-us_topic_0013771097.html rename to docs/ecs/umn/en-us_topic_0013771097.html diff --git a/ecs/umn/en-us_topic_0013771101.html b/docs/ecs/umn/en-us_topic_0013771101.html similarity index 100% rename from ecs/umn/en-us_topic_0013771101.html rename to docs/ecs/umn/en-us_topic_0013771101.html diff --git a/ecs/umn/en-us_topic_0013771102.html b/docs/ecs/umn/en-us_topic_0013771102.html similarity index 100% rename from ecs/umn/en-us_topic_0013771102.html rename to docs/ecs/umn/en-us_topic_0013771102.html diff --git a/ecs/umn/en-us_topic_0013771105.html b/docs/ecs/umn/en-us_topic_0013771105.html similarity index 100% rename from ecs/umn/en-us_topic_0013771105.html rename to docs/ecs/umn/en-us_topic_0013771105.html diff --git a/ecs/umn/en-us_topic_0013771111.html b/docs/ecs/umn/en-us_topic_0013771111.html similarity index 100% rename from ecs/umn/en-us_topic_0013771111.html rename to docs/ecs/umn/en-us_topic_0013771111.html diff --git a/ecs/umn/en-us_topic_0013771112.html b/docs/ecs/umn/en-us_topic_0013771112.html similarity index 100% rename from ecs/umn/en-us_topic_0013771112.html rename to docs/ecs/umn/en-us_topic_0013771112.html diff --git a/ecs/umn/en-us_topic_0014250631.html b/docs/ecs/umn/en-us_topic_0014250631.html similarity index 100% rename from ecs/umn/en-us_topic_0014250631.html rename to docs/ecs/umn/en-us_topic_0014250631.html diff --git a/ecs/umn/en-us_topic_0017130261.html b/docs/ecs/umn/en-us_topic_0017130261.html similarity index 100% rename from ecs/umn/en-us_topic_0017130261.html rename to docs/ecs/umn/en-us_topic_0017130261.html diff --git a/ecs/umn/en-us_topic_0017955380.html b/docs/ecs/umn/en-us_topic_0017955380.html similarity index 100% rename from ecs/umn/en-us_topic_0017955380.html rename to docs/ecs/umn/en-us_topic_0017955380.html diff --git a/ecs/umn/en-us_topic_0017955381.html b/docs/ecs/umn/en-us_topic_0017955381.html similarity index 100% rename from ecs/umn/en-us_topic_0017955381.html rename to docs/ecs/umn/en-us_topic_0017955381.html diff --git a/ecs/umn/en-us_topic_0017955633.html b/docs/ecs/umn/en-us_topic_0017955633.html similarity index 100% rename from ecs/umn/en-us_topic_0017955633.html rename to docs/ecs/umn/en-us_topic_0017955633.html diff --git a/ecs/umn/en-us_topic_0018073208.html b/docs/ecs/umn/en-us_topic_0018073208.html similarity index 100% rename from ecs/umn/en-us_topic_0018073208.html rename to docs/ecs/umn/en-us_topic_0018073208.html diff --git a/ecs/umn/en-us_topic_0018073212.html b/docs/ecs/umn/en-us_topic_0018073212.html similarity index 100% rename from ecs/umn/en-us_topic_0018073212.html rename to docs/ecs/umn/en-us_topic_0018073212.html diff --git a/ecs/umn/en-us_topic_0018073214.html b/docs/ecs/umn/en-us_topic_0018073214.html similarity index 100% rename from ecs/umn/en-us_topic_0018073214.html rename to docs/ecs/umn/en-us_topic_0018073214.html diff --git a/ecs/umn/en-us_topic_0018073215.html b/docs/ecs/umn/en-us_topic_0018073215.html similarity index 100% rename from ecs/umn/en-us_topic_0018073215.html rename to docs/ecs/umn/en-us_topic_0018073215.html diff --git a/ecs/umn/en-us_topic_0018073216.html b/docs/ecs/umn/en-us_topic_0018073216.html similarity index 100% rename from ecs/umn/en-us_topic_0018073216.html rename to docs/ecs/umn/en-us_topic_0018073216.html diff --git a/ecs/umn/en-us_topic_0018073218.html b/docs/ecs/umn/en-us_topic_0018073218.html similarity index 100% rename from ecs/umn/en-us_topic_0018073218.html rename to docs/ecs/umn/en-us_topic_0018073218.html diff --git a/ecs/umn/en-us_topic_0018073221.html b/docs/ecs/umn/en-us_topic_0018073221.html similarity index 100% rename from ecs/umn/en-us_topic_0018073221.html rename to docs/ecs/umn/en-us_topic_0018073221.html diff --git a/ecs/umn/en-us_topic_0018078501.html b/docs/ecs/umn/en-us_topic_0018078501.html similarity index 100% rename from ecs/umn/en-us_topic_0018078501.html rename to docs/ecs/umn/en-us_topic_0018078501.html diff --git a/ecs/umn/en-us_topic_0018078503.html b/docs/ecs/umn/en-us_topic_0018078503.html similarity index 100% rename from ecs/umn/en-us_topic_0018078503.html rename to docs/ecs/umn/en-us_topic_0018078503.html diff --git a/ecs/umn/en-us_topic_0018078505.html b/docs/ecs/umn/en-us_topic_0018078505.html similarity index 100% rename from ecs/umn/en-us_topic_0018078505.html rename to docs/ecs/umn/en-us_topic_0018078505.html diff --git a/ecs/umn/en-us_topic_0018078507.html b/docs/ecs/umn/en-us_topic_0018078507.html similarity index 100% rename from ecs/umn/en-us_topic_0018078507.html rename to docs/ecs/umn/en-us_topic_0018078507.html diff --git a/ecs/umn/en-us_topic_0018078509.html b/docs/ecs/umn/en-us_topic_0018078509.html similarity index 100% rename from ecs/umn/en-us_topic_0018078509.html rename to docs/ecs/umn/en-us_topic_0018078509.html diff --git a/ecs/umn/en-us_topic_0018078520.html b/docs/ecs/umn/en-us_topic_0018078520.html similarity index 100% rename from ecs/umn/en-us_topic_0018078520.html rename to docs/ecs/umn/en-us_topic_0018078520.html diff --git a/ecs/umn/en-us_topic_0018078522.html b/docs/ecs/umn/en-us_topic_0018078522.html similarity index 100% rename from ecs/umn/en-us_topic_0018078522.html rename to docs/ecs/umn/en-us_topic_0018078522.html diff --git a/ecs/umn/en-us_topic_0018078523.html b/docs/ecs/umn/en-us_topic_0018078523.html similarity index 100% rename from ecs/umn/en-us_topic_0018078523.html rename to docs/ecs/umn/en-us_topic_0018078523.html diff --git a/ecs/umn/en-us_topic_0018124779.html b/docs/ecs/umn/en-us_topic_0018124779.html similarity index 100% rename from ecs/umn/en-us_topic_0018124779.html rename to docs/ecs/umn/en-us_topic_0018124779.html diff --git a/ecs/umn/en-us_topic_0018124785.html b/docs/ecs/umn/en-us_topic_0018124785.html similarity index 100% rename from ecs/umn/en-us_topic_0018124785.html rename to docs/ecs/umn/en-us_topic_0018124785.html diff --git a/ecs/umn/en-us_topic_0018124786.html b/docs/ecs/umn/en-us_topic_0018124786.html similarity index 100% rename from ecs/umn/en-us_topic_0018124786.html rename to docs/ecs/umn/en-us_topic_0018124786.html diff --git a/ecs/umn/en-us_topic_0018124788.html b/docs/ecs/umn/en-us_topic_0018124788.html similarity index 100% rename from ecs/umn/en-us_topic_0018124788.html rename to docs/ecs/umn/en-us_topic_0018124788.html diff --git a/ecs/umn/en-us_topic_0018124789.html b/docs/ecs/umn/en-us_topic_0018124789.html similarity index 100% rename from ecs/umn/en-us_topic_0018124789.html rename to docs/ecs/umn/en-us_topic_0018124789.html diff --git a/ecs/umn/en-us_topic_0018339851.html b/docs/ecs/umn/en-us_topic_0018339851.html similarity index 100% rename from ecs/umn/en-us_topic_0018339851.html rename to docs/ecs/umn/en-us_topic_0018339851.html diff --git a/ecs/umn/en-us_topic_0019883415.html b/docs/ecs/umn/en-us_topic_0019883415.html similarity index 100% rename from ecs/umn/en-us_topic_0019883415.html rename to docs/ecs/umn/en-us_topic_0019883415.html diff --git a/ecs/umn/en-us_topic_0021426802.html b/docs/ecs/umn/en-us_topic_0021426802.html similarity index 100% rename from ecs/umn/en-us_topic_0021426802.html rename to docs/ecs/umn/en-us_topic_0021426802.html diff --git a/ecs/umn/en-us_topic_0021427650.html b/docs/ecs/umn/en-us_topic_0021427650.html similarity index 100% rename from ecs/umn/en-us_topic_0021427650.html rename to docs/ecs/umn/en-us_topic_0021427650.html diff --git a/ecs/umn/en-us_topic_0021831611.html b/docs/ecs/umn/en-us_topic_0021831611.html similarity index 100% rename from ecs/umn/en-us_topic_0021831611.html rename to docs/ecs/umn/en-us_topic_0021831611.html diff --git a/ecs/umn/en-us_topic_0024911405.html b/docs/ecs/umn/en-us_topic_0024911405.html similarity index 100% rename from ecs/umn/en-us_topic_0024911405.html rename to docs/ecs/umn/en-us_topic_0024911405.html diff --git a/ecs/umn/en-us_topic_0024912311.html b/docs/ecs/umn/en-us_topic_0024912311.html similarity index 100% rename from ecs/umn/en-us_topic_0024912311.html rename to docs/ecs/umn/en-us_topic_0024912311.html diff --git a/ecs/umn/en-us_topic_0025445670.html b/docs/ecs/umn/en-us_topic_0025445670.html similarity index 100% rename from ecs/umn/en-us_topic_0025445670.html rename to docs/ecs/umn/en-us_topic_0025445670.html diff --git a/ecs/umn/en-us_topic_0027157850.html b/docs/ecs/umn/en-us_topic_0027157850.html similarity index 100% rename from ecs/umn/en-us_topic_0027157850.html rename to docs/ecs/umn/en-us_topic_0027157850.html diff --git a/ecs/umn/en-us_topic_0027268511.html b/docs/ecs/umn/en-us_topic_0027268511.html similarity index 100% rename from ecs/umn/en-us_topic_0027268511.html rename to docs/ecs/umn/en-us_topic_0027268511.html diff --git a/ecs/umn/en-us_topic_0027371529.html b/docs/ecs/umn/en-us_topic_0027371529.html similarity index 100% rename from ecs/umn/en-us_topic_0027371529.html rename to docs/ecs/umn/en-us_topic_0027371529.html diff --git a/ecs/umn/en-us_topic_0027371530.html b/docs/ecs/umn/en-us_topic_0027371530.html similarity index 100% rename from ecs/umn/en-us_topic_0027371530.html rename to docs/ecs/umn/en-us_topic_0027371530.html diff --git a/ecs/umn/en-us_topic_0027371531.html b/docs/ecs/umn/en-us_topic_0027371531.html similarity index 100% rename from ecs/umn/en-us_topic_0027371531.html rename to docs/ecs/umn/en-us_topic_0027371531.html diff --git a/ecs/umn/en-us_topic_0029792884.html b/docs/ecs/umn/en-us_topic_0029792884.html similarity index 100% rename from ecs/umn/en-us_topic_0029792884.html rename to docs/ecs/umn/en-us_topic_0029792884.html diff --git a/ecs/umn/en-us_topic_0029806525.html b/docs/ecs/umn/en-us_topic_0029806525.html similarity index 100% rename from ecs/umn/en-us_topic_0029806525.html rename to docs/ecs/umn/en-us_topic_0029806525.html diff --git a/ecs/umn/en-us_topic_0030013188.html b/docs/ecs/umn/en-us_topic_0030013188.html similarity index 100% rename from ecs/umn/en-us_topic_0030013188.html rename to docs/ecs/umn/en-us_topic_0030013188.html diff --git a/ecs/umn/en-us_topic_0030828254.html b/docs/ecs/umn/en-us_topic_0030828254.html similarity index 100% rename from ecs/umn/en-us_topic_0030828254.html rename to docs/ecs/umn/en-us_topic_0030828254.html diff --git a/ecs/umn/en-us_topic_0030828256.html b/docs/ecs/umn/en-us_topic_0030828256.html similarity index 100% rename from ecs/umn/en-us_topic_0030828256.html rename to docs/ecs/umn/en-us_topic_0030828256.html diff --git a/ecs/umn/en-us_topic_0030828257.html b/docs/ecs/umn/en-us_topic_0030828257.html similarity index 100% rename from ecs/umn/en-us_topic_0030828257.html rename to docs/ecs/umn/en-us_topic_0030828257.html diff --git a/ecs/umn/en-us_topic_0030828258.html b/docs/ecs/umn/en-us_topic_0030828258.html similarity index 100% rename from ecs/umn/en-us_topic_0030828258.html rename to docs/ecs/umn/en-us_topic_0030828258.html diff --git a/ecs/umn/en-us_topic_0030831623.html b/docs/ecs/umn/en-us_topic_0030831623.html similarity index 100% rename from ecs/umn/en-us_topic_0030831623.html rename to docs/ecs/umn/en-us_topic_0030831623.html diff --git a/ecs/umn/en-us_topic_0030831989.html b/docs/ecs/umn/en-us_topic_0030831989.html similarity index 100% rename from ecs/umn/en-us_topic_0030831989.html rename to docs/ecs/umn/en-us_topic_0030831989.html diff --git a/ecs/umn/en-us_topic_0030831990.html b/docs/ecs/umn/en-us_topic_0030831990.html similarity index 100% rename from ecs/umn/en-us_topic_0030831990.html rename to docs/ecs/umn/en-us_topic_0030831990.html diff --git a/ecs/umn/en-us_topic_0030878383.html b/docs/ecs/umn/en-us_topic_0030878383.html similarity index 100% rename from ecs/umn/en-us_topic_0030878383.html rename to docs/ecs/umn/en-us_topic_0030878383.html diff --git a/ecs/umn/en-us_topic_0030888079.html b/docs/ecs/umn/en-us_topic_0030888079.html similarity index 100% rename from ecs/umn/en-us_topic_0030888079.html rename to docs/ecs/umn/en-us_topic_0030888079.html diff --git a/ecs/umn/en-us_topic_0030893661.html b/docs/ecs/umn/en-us_topic_0030893661.html similarity index 100% rename from ecs/umn/en-us_topic_0030893661.html rename to docs/ecs/umn/en-us_topic_0030893661.html diff --git a/ecs/umn/en-us_topic_0030911465.html b/docs/ecs/umn/en-us_topic_0030911465.html similarity index 100% rename from ecs/umn/en-us_topic_0030911465.html rename to docs/ecs/umn/en-us_topic_0030911465.html diff --git a/ecs/umn/en-us_topic_0030930805.html b/docs/ecs/umn/en-us_topic_0030930805.html similarity index 100% rename from ecs/umn/en-us_topic_0030930805.html rename to docs/ecs/umn/en-us_topic_0030930805.html diff --git a/ecs/umn/en-us_topic_0030930807.html b/docs/ecs/umn/en-us_topic_0030930807.html similarity index 100% rename from ecs/umn/en-us_topic_0030930807.html rename to docs/ecs/umn/en-us_topic_0030930807.html diff --git a/ecs/umn/en-us_topic_0030932496.html b/docs/ecs/umn/en-us_topic_0030932496.html similarity index 100% rename from ecs/umn/en-us_topic_0030932496.html rename to docs/ecs/umn/en-us_topic_0030932496.html diff --git a/ecs/umn/en-us_topic_0030932497.html b/docs/ecs/umn/en-us_topic_0030932497.html similarity index 100% rename from ecs/umn/en-us_topic_0030932497.html rename to docs/ecs/umn/en-us_topic_0030932497.html diff --git a/ecs/umn/en-us_topic_0030932499.html b/docs/ecs/umn/en-us_topic_0030932499.html similarity index 100% rename from ecs/umn/en-us_topic_0030932499.html rename to docs/ecs/umn/en-us_topic_0030932499.html diff --git a/ecs/umn/en-us_topic_0030932500.html b/docs/ecs/umn/en-us_topic_0030932500.html similarity index 100% rename from ecs/umn/en-us_topic_0030932500.html rename to docs/ecs/umn/en-us_topic_0030932500.html diff --git a/ecs/umn/en-us_topic_0031073513.html b/docs/ecs/umn/en-us_topic_0031073513.html similarity index 100% rename from ecs/umn/en-us_topic_0031073513.html rename to docs/ecs/umn/en-us_topic_0031073513.html diff --git a/ecs/umn/en-us_topic_0031107266.html b/docs/ecs/umn/en-us_topic_0031107266.html similarity index 100% rename from ecs/umn/en-us_topic_0031107266.html rename to docs/ecs/umn/en-us_topic_0031107266.html diff --git a/ecs/umn/en-us_topic_0031107267.html b/docs/ecs/umn/en-us_topic_0031107267.html similarity index 100% rename from ecs/umn/en-us_topic_0031107267.html rename to docs/ecs/umn/en-us_topic_0031107267.html diff --git a/ecs/umn/en-us_topic_0031523135.html b/docs/ecs/umn/en-us_topic_0031523135.html similarity index 100% rename from ecs/umn/en-us_topic_0031523135.html rename to docs/ecs/umn/en-us_topic_0031523135.html diff --git a/ecs/umn/en-us_topic_0031734664.html b/docs/ecs/umn/en-us_topic_0031734664.html similarity index 100% rename from ecs/umn/en-us_topic_0031734664.html rename to docs/ecs/umn/en-us_topic_0031734664.html diff --git a/ecs/umn/en-us_topic_0031736846.html b/docs/ecs/umn/en-us_topic_0031736846.html similarity index 100% rename from ecs/umn/en-us_topic_0031736846.html rename to docs/ecs/umn/en-us_topic_0031736846.html diff --git a/ecs/umn/en-us_topic_0032380449.html b/docs/ecs/umn/en-us_topic_0032380449.html similarity index 100% rename from ecs/umn/en-us_topic_0032380449.html rename to docs/ecs/umn/en-us_topic_0032380449.html diff --git a/ecs/umn/en-us_topic_0032398121.html b/docs/ecs/umn/en-us_topic_0032398121.html similarity index 100% rename from ecs/umn/en-us_topic_0032398121.html rename to docs/ecs/umn/en-us_topic_0032398121.html diff --git a/ecs/umn/en-us_topic_0032850906.html b/docs/ecs/umn/en-us_topic_0032850906.html similarity index 100% rename from ecs/umn/en-us_topic_0032850906.html rename to docs/ecs/umn/en-us_topic_0032850906.html diff --git a/ecs/umn/en-us_topic_0032980085.html b/docs/ecs/umn/en-us_topic_0032980085.html similarity index 100% rename from ecs/umn/en-us_topic_0032980085.html rename to docs/ecs/umn/en-us_topic_0032980085.html diff --git a/ecs/umn/en-us_topic_0035233718.html b/docs/ecs/umn/en-us_topic_0035233718.html similarity index 100% rename from ecs/umn/en-us_topic_0035233718.html rename to docs/ecs/umn/en-us_topic_0035233718.html diff --git a/ecs/umn/en-us_topic_0035470096.html b/docs/ecs/umn/en-us_topic_0035470096.html similarity index 100% rename from ecs/umn/en-us_topic_0035470096.html rename to docs/ecs/umn/en-us_topic_0035470096.html diff --git a/ecs/umn/en-us_topic_0035470099.html b/docs/ecs/umn/en-us_topic_0035470099.html similarity index 100% rename from ecs/umn/en-us_topic_0035470099.html rename to docs/ecs/umn/en-us_topic_0035470099.html diff --git a/ecs/umn/en-us_topic_0035470100.html b/docs/ecs/umn/en-us_topic_0035470100.html similarity index 100% rename from ecs/umn/en-us_topic_0035470100.html rename to docs/ecs/umn/en-us_topic_0035470100.html diff --git a/ecs/umn/en-us_topic_0035470101.html b/docs/ecs/umn/en-us_topic_0035470101.html similarity index 100% rename from ecs/umn/en-us_topic_0035470101.html rename to docs/ecs/umn/en-us_topic_0035470101.html diff --git a/ecs/umn/en-us_topic_0035550301.html b/docs/ecs/umn/en-us_topic_0035550301.html similarity index 100% rename from ecs/umn/en-us_topic_0035550301.html rename to docs/ecs/umn/en-us_topic_0035550301.html diff --git a/ecs/umn/en-us_topic_0036046828.html b/docs/ecs/umn/en-us_topic_0036046828.html similarity index 100% rename from ecs/umn/en-us_topic_0036046828.html rename to docs/ecs/umn/en-us_topic_0036046828.html diff --git a/ecs/umn/en-us_topic_0036068717.html b/docs/ecs/umn/en-us_topic_0036068717.html similarity index 100% rename from ecs/umn/en-us_topic_0036068717.html rename to docs/ecs/umn/en-us_topic_0036068717.html diff --git a/ecs/umn/en-us_topic_0037470901.html b/docs/ecs/umn/en-us_topic_0037470901.html similarity index 100% rename from ecs/umn/en-us_topic_0037470901.html rename to docs/ecs/umn/en-us_topic_0037470901.html diff --git a/ecs/umn/en-us_topic_0037633087.html b/docs/ecs/umn/en-us_topic_0037633087.html similarity index 100% rename from ecs/umn/en-us_topic_0037633087.html rename to docs/ecs/umn/en-us_topic_0037633087.html diff --git a/ecs/umn/en-us_topic_0038024694.html b/docs/ecs/umn/en-us_topic_0038024694.html similarity index 100% rename from ecs/umn/en-us_topic_0038024694.html rename to docs/ecs/umn/en-us_topic_0038024694.html diff --git a/ecs/umn/en-us_topic_0039524582.html b/docs/ecs/umn/en-us_topic_0039524582.html similarity index 100% rename from ecs/umn/en-us_topic_0039524582.html rename to docs/ecs/umn/en-us_topic_0039524582.html diff --git a/ecs/umn/en-us_topic_0039588795.html b/docs/ecs/umn/en-us_topic_0039588795.html similarity index 100% rename from ecs/umn/en-us_topic_0039588795.html rename to docs/ecs/umn/en-us_topic_0039588795.html diff --git a/ecs/umn/en-us_topic_0040630518.html b/docs/ecs/umn/en-us_topic_0040630518.html similarity index 100% rename from ecs/umn/en-us_topic_0040630518.html rename to docs/ecs/umn/en-us_topic_0040630518.html diff --git a/ecs/umn/en-us_topic_0040863659.html b/docs/ecs/umn/en-us_topic_0040863659.html similarity index 100% rename from ecs/umn/en-us_topic_0040863659.html rename to docs/ecs/umn/en-us_topic_0040863659.html diff --git a/ecs/umn/en-us_topic_0041169567.html b/docs/ecs/umn/en-us_topic_0041169567.html similarity index 100% rename from ecs/umn/en-us_topic_0041169567.html rename to docs/ecs/umn/en-us_topic_0041169567.html diff --git a/ecs/umn/en-us_topic_0042400609.html b/docs/ecs/umn/en-us_topic_0042400609.html similarity index 100% rename from ecs/umn/en-us_topic_0042400609.html rename to docs/ecs/umn/en-us_topic_0042400609.html diff --git a/ecs/umn/en-us_topic_0046566932.html b/docs/ecs/umn/en-us_topic_0046566932.html similarity index 100% rename from ecs/umn/en-us_topic_0046566932.html rename to docs/ecs/umn/en-us_topic_0046566932.html diff --git a/ecs/umn/en-us_topic_0046912051.html b/docs/ecs/umn/en-us_topic_0046912051.html similarity index 100% rename from ecs/umn/en-us_topic_0046912051.html rename to docs/ecs/umn/en-us_topic_0046912051.html diff --git a/ecs/umn/en-us_topic_0047272493.html b/docs/ecs/umn/en-us_topic_0047272493.html similarity index 100% rename from ecs/umn/en-us_topic_0047272493.html rename to docs/ecs/umn/en-us_topic_0047272493.html diff --git a/ecs/umn/en-us_topic_0047624368.html b/docs/ecs/umn/en-us_topic_0047624368.html similarity index 100% rename from ecs/umn/en-us_topic_0047624368.html rename to docs/ecs/umn/en-us_topic_0047624368.html diff --git a/ecs/umn/en-us_topic_0047654687.html b/docs/ecs/umn/en-us_topic_0047654687.html similarity index 100% rename from ecs/umn/en-us_topic_0047654687.html rename to docs/ecs/umn/en-us_topic_0047654687.html diff --git a/ecs/umn/en-us_topic_0047898078.html b/docs/ecs/umn/en-us_topic_0047898078.html similarity index 100% rename from ecs/umn/en-us_topic_0047898078.html rename to docs/ecs/umn/en-us_topic_0047898078.html diff --git a/ecs/umn/en-us_topic_0048642616.html b/docs/ecs/umn/en-us_topic_0048642616.html similarity index 100% rename from ecs/umn/en-us_topic_0048642616.html rename to docs/ecs/umn/en-us_topic_0048642616.html diff --git a/ecs/umn/en-us_topic_0050735736.html b/docs/ecs/umn/en-us_topic_0050735736.html similarity index 100% rename from ecs/umn/en-us_topic_0050735736.html rename to docs/ecs/umn/en-us_topic_0050735736.html diff --git a/ecs/umn/en-us_topic_0053287548.html b/docs/ecs/umn/en-us_topic_0053287548.html similarity index 100% rename from ecs/umn/en-us_topic_0053287548.html rename to docs/ecs/umn/en-us_topic_0053287548.html diff --git a/ecs/umn/en-us_topic_0054121392.html b/docs/ecs/umn/en-us_topic_0054121392.html similarity index 100% rename from ecs/umn/en-us_topic_0054121392.html rename to docs/ecs/umn/en-us_topic_0054121392.html diff --git a/ecs/umn/en-us_topic_0057711189.html b/docs/ecs/umn/en-us_topic_0057711189.html similarity index 100% rename from ecs/umn/en-us_topic_0057711189.html rename to docs/ecs/umn/en-us_topic_0057711189.html diff --git a/ecs/umn/en-us_topic_0058747426.html b/docs/ecs/umn/en-us_topic_0058747426.html similarity index 100% rename from ecs/umn/en-us_topic_0058747426.html rename to docs/ecs/umn/en-us_topic_0058747426.html diff --git a/ecs/umn/en-us_topic_0058758453.html b/docs/ecs/umn/en-us_topic_0058758453.html similarity index 100% rename from ecs/umn/en-us_topic_0058758453.html rename to docs/ecs/umn/en-us_topic_0058758453.html diff --git a/ecs/umn/en-us_topic_0060610074.html b/docs/ecs/umn/en-us_topic_0060610074.html similarity index 100% rename from ecs/umn/en-us_topic_0060610074.html rename to docs/ecs/umn/en-us_topic_0060610074.html diff --git a/ecs/umn/en-us_topic_0070518971.html b/docs/ecs/umn/en-us_topic_0070518971.html similarity index 100% rename from ecs/umn/en-us_topic_0070518971.html rename to docs/ecs/umn/en-us_topic_0070518971.html diff --git a/ecs/umn/en-us_topic_0072987316.html b/docs/ecs/umn/en-us_topic_0072987316.html similarity index 100% rename from ecs/umn/en-us_topic_0072987316.html rename to docs/ecs/umn/en-us_topic_0072987316.html diff --git a/ecs/umn/en-us_topic_0074752335.html b/docs/ecs/umn/en-us_topic_0074752335.html similarity index 100% rename from ecs/umn/en-us_topic_0074752335.html rename to docs/ecs/umn/en-us_topic_0074752335.html diff --git a/ecs/umn/en-us_topic_0076210995.html b/docs/ecs/umn/en-us_topic_0076210995.html similarity index 100% rename from ecs/umn/en-us_topic_0076210995.html rename to docs/ecs/umn/en-us_topic_0076210995.html diff --git a/ecs/umn/en-us_topic_0077938284.html b/docs/ecs/umn/en-us_topic_0077938284.html similarity index 100% rename from ecs/umn/en-us_topic_0077938284.html rename to docs/ecs/umn/en-us_topic_0077938284.html diff --git a/ecs/umn/en-us_topic_0078300749.html b/docs/ecs/umn/en-us_topic_0078300749.html similarity index 100% rename from ecs/umn/en-us_topic_0078300749.html rename to docs/ecs/umn/en-us_topic_0078300749.html diff --git a/ecs/umn/en-us_topic_0078300750.html b/docs/ecs/umn/en-us_topic_0078300750.html similarity index 100% rename from ecs/umn/en-us_topic_0078300750.html rename to docs/ecs/umn/en-us_topic_0078300750.html diff --git a/ecs/umn/en-us_topic_0079176727.html b/docs/ecs/umn/en-us_topic_0079176727.html similarity index 100% rename from ecs/umn/en-us_topic_0079176727.html rename to docs/ecs/umn/en-us_topic_0079176727.html diff --git a/ecs/umn/en-us_topic_0081525053.html b/docs/ecs/umn/en-us_topic_0081525053.html similarity index 100% rename from ecs/umn/en-us_topic_0081525053.html rename to docs/ecs/umn/en-us_topic_0081525053.html diff --git a/ecs/umn/en-us_topic_0081525054.html b/docs/ecs/umn/en-us_topic_0081525054.html similarity index 100% rename from ecs/umn/en-us_topic_0081525054.html rename to docs/ecs/umn/en-us_topic_0081525054.html diff --git a/ecs/umn/en-us_topic_0083225171.html b/docs/ecs/umn/en-us_topic_0083225171.html similarity index 100% rename from ecs/umn/en-us_topic_0083225171.html rename to docs/ecs/umn/en-us_topic_0083225171.html diff --git a/ecs/umn/en-us_topic_0085634796.html b/docs/ecs/umn/en-us_topic_0085634796.html similarity index 100% rename from ecs/umn/en-us_topic_0085634796.html rename to docs/ecs/umn/en-us_topic_0085634796.html diff --git a/ecs/umn/en-us_topic_0085634797.html b/docs/ecs/umn/en-us_topic_0085634797.html similarity index 100% rename from ecs/umn/en-us_topic_0085634797.html rename to docs/ecs/umn/en-us_topic_0085634797.html diff --git a/ecs/umn/en-us_topic_0085634798.html b/docs/ecs/umn/en-us_topic_0085634798.html similarity index 100% rename from ecs/umn/en-us_topic_0085634798.html rename to docs/ecs/umn/en-us_topic_0085634798.html diff --git a/ecs/umn/en-us_topic_0087382187.html b/docs/ecs/umn/en-us_topic_0087382187.html similarity index 100% rename from ecs/umn/en-us_topic_0087382187.html rename to docs/ecs/umn/en-us_topic_0087382187.html diff --git a/ecs/umn/en-us_topic_0087622835.html b/docs/ecs/umn/en-us_topic_0087622835.html similarity index 100% rename from ecs/umn/en-us_topic_0087622835.html rename to docs/ecs/umn/en-us_topic_0087622835.html diff --git a/ecs/umn/en-us_topic_0087680813.html b/docs/ecs/umn/en-us_topic_0087680813.html similarity index 100% rename from ecs/umn/en-us_topic_0087680813.html rename to docs/ecs/umn/en-us_topic_0087680813.html diff --git a/ecs/umn/en-us_topic_0087901488.html b/docs/ecs/umn/en-us_topic_0087901488.html similarity index 100% rename from ecs/umn/en-us_topic_0087901488.html rename to docs/ecs/umn/en-us_topic_0087901488.html diff --git a/ecs/umn/en-us_topic_0088241338.html b/docs/ecs/umn/en-us_topic_0088241338.html similarity index 100% rename from ecs/umn/en-us_topic_0088241338.html rename to docs/ecs/umn/en-us_topic_0088241338.html diff --git a/ecs/umn/en-us_topic_0091224748.html b/docs/ecs/umn/en-us_topic_0091224748.html similarity index 100% rename from ecs/umn/en-us_topic_0091224748.html rename to docs/ecs/umn/en-us_topic_0091224748.html diff --git a/ecs/umn/en-us_topic_0092435778.html b/docs/ecs/umn/en-us_topic_0092435778.html similarity index 100% rename from ecs/umn/en-us_topic_0092435778.html rename to docs/ecs/umn/en-us_topic_0092435778.html diff --git a/ecs/umn/en-us_topic_0092435779.html b/docs/ecs/umn/en-us_topic_0092435779.html similarity index 100% rename from ecs/umn/en-us_topic_0092435779.html rename to docs/ecs/umn/en-us_topic_0092435779.html diff --git a/ecs/umn/en-us_topic_0092494193.html b/docs/ecs/umn/en-us_topic_0092494193.html similarity index 100% rename from ecs/umn/en-us_topic_0092494193.html rename to docs/ecs/umn/en-us_topic_0092494193.html diff --git a/ecs/umn/en-us_topic_0092494580.html b/docs/ecs/umn/en-us_topic_0092494580.html similarity index 100% rename from ecs/umn/en-us_topic_0092494580.html rename to docs/ecs/umn/en-us_topic_0092494580.html diff --git a/ecs/umn/en-us_topic_0092494943.html b/docs/ecs/umn/en-us_topic_0092494943.html similarity index 100% rename from ecs/umn/en-us_topic_0092494943.html rename to docs/ecs/umn/en-us_topic_0092494943.html diff --git a/ecs/umn/en-us_topic_0092497777.html b/docs/ecs/umn/en-us_topic_0092497777.html similarity index 100% rename from ecs/umn/en-us_topic_0092497777.html rename to docs/ecs/umn/en-us_topic_0092497777.html diff --git a/ecs/umn/en-us_topic_0092499768.html b/docs/ecs/umn/en-us_topic_0092499768.html similarity index 100% rename from ecs/umn/en-us_topic_0092499768.html rename to docs/ecs/umn/en-us_topic_0092499768.html diff --git a/ecs/umn/en-us_topic_0092499769.html b/docs/ecs/umn/en-us_topic_0092499769.html similarity index 100% rename from ecs/umn/en-us_topic_0092499769.html rename to docs/ecs/umn/en-us_topic_0092499769.html diff --git a/ecs/umn/en-us_topic_0092499770.html b/docs/ecs/umn/en-us_topic_0092499770.html similarity index 100% rename from ecs/umn/en-us_topic_0092499770.html rename to docs/ecs/umn/en-us_topic_0092499770.html diff --git a/ecs/umn/en-us_topic_0093153741.html b/docs/ecs/umn/en-us_topic_0093153741.html similarity index 100% rename from ecs/umn/en-us_topic_0093153741.html rename to docs/ecs/umn/en-us_topic_0093153741.html diff --git a/ecs/umn/en-us_topic_0093263550.html b/docs/ecs/umn/en-us_topic_0093263550.html similarity index 100% rename from ecs/umn/en-us_topic_0093263550.html rename to docs/ecs/umn/en-us_topic_0093263550.html diff --git a/ecs/umn/en-us_topic_0093492517.html b/docs/ecs/umn/en-us_topic_0093492517.html similarity index 100% rename from ecs/umn/en-us_topic_0093492517.html rename to docs/ecs/umn/en-us_topic_0093492517.html diff --git a/ecs/umn/en-us_topic_0093492518.html b/docs/ecs/umn/en-us_topic_0093492518.html similarity index 100% rename from ecs/umn/en-us_topic_0093492518.html rename to docs/ecs/umn/en-us_topic_0093492518.html diff --git a/ecs/umn/en-us_topic_0093492519.html b/docs/ecs/umn/en-us_topic_0093492519.html similarity index 100% rename from ecs/umn/en-us_topic_0093492519.html rename to docs/ecs/umn/en-us_topic_0093492519.html diff --git a/ecs/umn/en-us_topic_0093492520.html b/docs/ecs/umn/en-us_topic_0093492520.html similarity index 100% rename from ecs/umn/en-us_topic_0093492520.html rename to docs/ecs/umn/en-us_topic_0093492520.html diff --git a/ecs/umn/en-us_topic_0093492521.html b/docs/ecs/umn/en-us_topic_0093492521.html similarity index 100% rename from ecs/umn/en-us_topic_0093492521.html rename to docs/ecs/umn/en-us_topic_0093492521.html diff --git a/ecs/umn/en-us_topic_0093492522.html b/docs/ecs/umn/en-us_topic_0093492522.html similarity index 100% rename from ecs/umn/en-us_topic_0093492522.html rename to docs/ecs/umn/en-us_topic_0093492522.html diff --git a/ecs/umn/en-us_topic_0094801708.html b/docs/ecs/umn/en-us_topic_0094801708.html similarity index 100% rename from ecs/umn/en-us_topic_0094801708.html rename to docs/ecs/umn/en-us_topic_0094801708.html diff --git a/ecs/umn/en-us_topic_0094874138.html b/docs/ecs/umn/en-us_topic_0094874138.html similarity index 100% rename from ecs/umn/en-us_topic_0094874138.html rename to docs/ecs/umn/en-us_topic_0094874138.html diff --git a/ecs/umn/en-us_topic_0095020344.html b/docs/ecs/umn/en-us_topic_0095020344.html similarity index 100% rename from ecs/umn/en-us_topic_0095020344.html rename to docs/ecs/umn/en-us_topic_0095020344.html diff --git a/ecs/umn/en-us_topic_0096170524.html b/docs/ecs/umn/en-us_topic_0096170524.html similarity index 100% rename from ecs/umn/en-us_topic_0096170524.html rename to docs/ecs/umn/en-us_topic_0096170524.html diff --git a/ecs/umn/en-us_topic_0096293655.html b/docs/ecs/umn/en-us_topic_0096293655.html similarity index 100% rename from ecs/umn/en-us_topic_0096293655.html rename to docs/ecs/umn/en-us_topic_0096293655.html diff --git a/ecs/umn/en-us_topic_0096304614.html b/docs/ecs/umn/en-us_topic_0096304614.html similarity index 100% rename from ecs/umn/en-us_topic_0096304614.html rename to docs/ecs/umn/en-us_topic_0096304614.html diff --git a/ecs/umn/en-us_topic_0097289624.html b/docs/ecs/umn/en-us_topic_0097289624.html similarity index 100% rename from ecs/umn/en-us_topic_0097289624.html rename to docs/ecs/umn/en-us_topic_0097289624.html diff --git a/ecs/umn/en-us_topic_0100005619.html b/docs/ecs/umn/en-us_topic_0100005619.html similarity index 100% rename from ecs/umn/en-us_topic_0100005619.html rename to docs/ecs/umn/en-us_topic_0100005619.html diff --git a/ecs/umn/en-us_topic_0101604501.html b/docs/ecs/umn/en-us_topic_0101604501.html similarity index 100% rename from ecs/umn/en-us_topic_0101604501.html rename to docs/ecs/umn/en-us_topic_0101604501.html diff --git a/ecs/umn/en-us_topic_0101604506.html b/docs/ecs/umn/en-us_topic_0101604506.html similarity index 100% rename from ecs/umn/en-us_topic_0101604506.html rename to docs/ecs/umn/en-us_topic_0101604506.html diff --git a/ecs/umn/en-us_topic_0101604507.html b/docs/ecs/umn/en-us_topic_0101604507.html similarity index 100% rename from ecs/umn/en-us_topic_0101604507.html rename to docs/ecs/umn/en-us_topic_0101604507.html diff --git a/ecs/umn/en-us_topic_0101604508.html b/docs/ecs/umn/en-us_topic_0101604508.html similarity index 100% rename from ecs/umn/en-us_topic_0101604508.html rename to docs/ecs/umn/en-us_topic_0101604508.html diff --git a/ecs/umn/en-us_topic_0101604511.html b/docs/ecs/umn/en-us_topic_0101604511.html similarity index 100% rename from ecs/umn/en-us_topic_0101604511.html rename to docs/ecs/umn/en-us_topic_0101604511.html diff --git a/ecs/umn/en-us_topic_0101604512.html b/docs/ecs/umn/en-us_topic_0101604512.html similarity index 100% rename from ecs/umn/en-us_topic_0101604512.html rename to docs/ecs/umn/en-us_topic_0101604512.html diff --git a/ecs/umn/en-us_topic_0102391480.html b/docs/ecs/umn/en-us_topic_0102391480.html similarity index 100% rename from ecs/umn/en-us_topic_0102391480.html rename to docs/ecs/umn/en-us_topic_0102391480.html diff --git a/ecs/umn/en-us_topic_0103285575.html b/docs/ecs/umn/en-us_topic_0103285575.html similarity index 100% rename from ecs/umn/en-us_topic_0103285575.html rename to docs/ecs/umn/en-us_topic_0103285575.html diff --git a/ecs/umn/en-us_topic_0105130172.html b/docs/ecs/umn/en-us_topic_0105130172.html similarity index 100% rename from ecs/umn/en-us_topic_0105130172.html rename to docs/ecs/umn/en-us_topic_0105130172.html diff --git a/ecs/umn/en-us_topic_0105130173.html b/docs/ecs/umn/en-us_topic_0105130173.html similarity index 100% rename from ecs/umn/en-us_topic_0105130173.html rename to docs/ecs/umn/en-us_topic_0105130173.html diff --git a/ecs/umn/en-us_topic_0105215483.html b/docs/ecs/umn/en-us_topic_0105215483.html similarity index 100% rename from ecs/umn/en-us_topic_0105215483.html rename to docs/ecs/umn/en-us_topic_0105215483.html diff --git a/ecs/umn/en-us_topic_0107412162.html b/docs/ecs/umn/en-us_topic_0107412162.html similarity index 100% rename from ecs/umn/en-us_topic_0107412162.html rename to docs/ecs/umn/en-us_topic_0107412162.html diff --git a/ecs/umn/en-us_topic_0107490388.html b/docs/ecs/umn/en-us_topic_0107490388.html similarity index 100% rename from ecs/umn/en-us_topic_0107490388.html rename to docs/ecs/umn/en-us_topic_0107490388.html diff --git a/ecs/umn/en-us_topic_0107659745.html b/docs/ecs/umn/en-us_topic_0107659745.html similarity index 100% rename from ecs/umn/en-us_topic_0107659745.html rename to docs/ecs/umn/en-us_topic_0107659745.html diff --git a/ecs/umn/en-us_topic_0108255889.html b/docs/ecs/umn/en-us_topic_0108255889.html similarity index 100% rename from ecs/umn/en-us_topic_0108255889.html rename to docs/ecs/umn/en-us_topic_0108255889.html diff --git a/ecs/umn/en-us_topic_0114225937.html b/docs/ecs/umn/en-us_topic_0114225937.html similarity index 100% rename from ecs/umn/en-us_topic_0114225937.html rename to docs/ecs/umn/en-us_topic_0114225937.html diff --git a/ecs/umn/en-us_topic_0115820205.html b/docs/ecs/umn/en-us_topic_0115820205.html similarity index 100% rename from ecs/umn/en-us_topic_0115820205.html rename to docs/ecs/umn/en-us_topic_0115820205.html diff --git a/ecs/umn/en-us_topic_0116266206.html b/docs/ecs/umn/en-us_topic_0116266206.html similarity index 100% rename from ecs/umn/en-us_topic_0116266206.html rename to docs/ecs/umn/en-us_topic_0116266206.html diff --git a/ecs/umn/en-us_topic_0116266207.html b/docs/ecs/umn/en-us_topic_0116266207.html similarity index 100% rename from ecs/umn/en-us_topic_0116266207.html rename to docs/ecs/umn/en-us_topic_0116266207.html diff --git a/ecs/umn/en-us_topic_0117006217.html b/docs/ecs/umn/en-us_topic_0117006217.html similarity index 100% rename from ecs/umn/en-us_topic_0117006217.html rename to docs/ecs/umn/en-us_topic_0117006217.html diff --git a/ecs/umn/en-us_topic_0117490178.html b/docs/ecs/umn/en-us_topic_0117490178.html similarity index 100% rename from ecs/umn/en-us_topic_0117490178.html rename to docs/ecs/umn/en-us_topic_0117490178.html diff --git a/ecs/umn/en-us_topic_0118224527.html b/docs/ecs/umn/en-us_topic_0118224527.html similarity index 100% rename from ecs/umn/en-us_topic_0118224527.html rename to docs/ecs/umn/en-us_topic_0118224527.html diff --git a/ecs/umn/en-us_topic_0120795668.html b/docs/ecs/umn/en-us_topic_0120795668.html similarity index 100% rename from ecs/umn/en-us_topic_0120795668.html rename to docs/ecs/umn/en-us_topic_0120795668.html diff --git a/ecs/umn/en-us_topic_0120795802.html b/docs/ecs/umn/en-us_topic_0120795802.html similarity index 100% rename from ecs/umn/en-us_topic_0120795802.html rename to docs/ecs/umn/en-us_topic_0120795802.html diff --git a/ecs/umn/en-us_topic_0122307169.html b/docs/ecs/umn/en-us_topic_0122307169.html similarity index 100% rename from ecs/umn/en-us_topic_0122307169.html rename to docs/ecs/umn/en-us_topic_0122307169.html diff --git a/ecs/umn/en-us_topic_0122627689.html b/docs/ecs/umn/en-us_topic_0122627689.html similarity index 100% rename from ecs/umn/en-us_topic_0122627689.html rename to docs/ecs/umn/en-us_topic_0122627689.html diff --git a/ecs/umn/en-us_topic_0132345719.html b/docs/ecs/umn/en-us_topic_0132345719.html similarity index 100% rename from ecs/umn/en-us_topic_0132345719.html rename to docs/ecs/umn/en-us_topic_0132345719.html diff --git a/ecs/umn/en-us_topic_0133339807.html b/docs/ecs/umn/en-us_topic_0133339807.html similarity index 100% rename from ecs/umn/en-us_topic_0133339807.html rename to docs/ecs/umn/en-us_topic_0133339807.html diff --git a/ecs/umn/en-us_topic_0133365988.html b/docs/ecs/umn/en-us_topic_0133365988.html similarity index 100% rename from ecs/umn/en-us_topic_0133365988.html rename to docs/ecs/umn/en-us_topic_0133365988.html diff --git a/ecs/umn/en-us_topic_0133513874.html b/docs/ecs/umn/en-us_topic_0133513874.html similarity index 100% rename from ecs/umn/en-us_topic_0133513874.html rename to docs/ecs/umn/en-us_topic_0133513874.html diff --git a/ecs/umn/en-us_topic_0140313879.html b/docs/ecs/umn/en-us_topic_0140313879.html similarity index 100% rename from ecs/umn/en-us_topic_0140313879.html rename to docs/ecs/umn/en-us_topic_0140313879.html diff --git a/ecs/umn/en-us_topic_0140313881.html b/docs/ecs/umn/en-us_topic_0140313881.html similarity index 100% rename from ecs/umn/en-us_topic_0140313881.html rename to docs/ecs/umn/en-us_topic_0140313881.html diff --git a/ecs/umn/en-us_topic_0140313883.html b/docs/ecs/umn/en-us_topic_0140313883.html similarity index 100% rename from ecs/umn/en-us_topic_0140313883.html rename to docs/ecs/umn/en-us_topic_0140313883.html diff --git a/ecs/umn/en-us_topic_0140323150.html b/docs/ecs/umn/en-us_topic_0140323150.html similarity index 100% rename from ecs/umn/en-us_topic_0140323150.html rename to docs/ecs/umn/en-us_topic_0140323150.html diff --git a/ecs/umn/en-us_topic_0140323151.html b/docs/ecs/umn/en-us_topic_0140323151.html similarity index 100% rename from ecs/umn/en-us_topic_0140323151.html rename to docs/ecs/umn/en-us_topic_0140323151.html diff --git a/ecs/umn/en-us_topic_0140323152.html b/docs/ecs/umn/en-us_topic_0140323152.html similarity index 100% rename from ecs/umn/en-us_topic_0140323152.html rename to docs/ecs/umn/en-us_topic_0140323152.html diff --git a/ecs/umn/en-us_topic_0140323154.html b/docs/ecs/umn/en-us_topic_0140323154.html similarity index 100% rename from ecs/umn/en-us_topic_0140323154.html rename to docs/ecs/umn/en-us_topic_0140323154.html diff --git a/ecs/umn/en-us_topic_0140323157.html b/docs/ecs/umn/en-us_topic_0140323157.html similarity index 100% rename from ecs/umn/en-us_topic_0140323157.html rename to docs/ecs/umn/en-us_topic_0140323157.html diff --git a/ecs/umn/en-us_topic_0142266317.html b/docs/ecs/umn/en-us_topic_0142266317.html similarity index 100% rename from ecs/umn/en-us_topic_0142266317.html rename to docs/ecs/umn/en-us_topic_0142266317.html diff --git a/ecs/umn/en-us_topic_0149470468.html b/docs/ecs/umn/en-us_topic_0149470468.html similarity index 100% rename from ecs/umn/en-us_topic_0149470468.html rename to docs/ecs/umn/en-us_topic_0149470468.html diff --git a/ecs/umn/en-us_topic_0149610914.html b/docs/ecs/umn/en-us_topic_0149610914.html similarity index 100% rename from ecs/umn/en-us_topic_0149610914.html rename to docs/ecs/umn/en-us_topic_0149610914.html diff --git a/ecs/umn/en-us_topic_0152643976.html b/docs/ecs/umn/en-us_topic_0152643976.html similarity index 100% rename from ecs/umn/en-us_topic_0152643976.html rename to docs/ecs/umn/en-us_topic_0152643976.html diff --git a/ecs/umn/en-us_topic_0163572588.html b/docs/ecs/umn/en-us_topic_0163572588.html similarity index 100% rename from ecs/umn/en-us_topic_0163572588.html rename to docs/ecs/umn/en-us_topic_0163572588.html diff --git a/ecs/umn/en-us_topic_0163572589.html b/docs/ecs/umn/en-us_topic_0163572589.html similarity index 100% rename from ecs/umn/en-us_topic_0163572589.html rename to docs/ecs/umn/en-us_topic_0163572589.html diff --git a/ecs/umn/en-us_topic_0163572590.html b/docs/ecs/umn/en-us_topic_0163572590.html similarity index 100% rename from ecs/umn/en-us_topic_0163572590.html rename to docs/ecs/umn/en-us_topic_0163572590.html diff --git a/ecs/umn/en-us_topic_0163572591.html b/docs/ecs/umn/en-us_topic_0163572591.html similarity index 100% rename from ecs/umn/en-us_topic_0163572591.html rename to docs/ecs/umn/en-us_topic_0163572591.html diff --git a/ecs/umn/en-us_topic_0163572592.html b/docs/ecs/umn/en-us_topic_0163572592.html similarity index 100% rename from ecs/umn/en-us_topic_0163572592.html rename to docs/ecs/umn/en-us_topic_0163572592.html diff --git a/ecs/umn/en-us_topic_0166284970.html b/docs/ecs/umn/en-us_topic_0166284970.html similarity index 100% rename from ecs/umn/en-us_topic_0166284970.html rename to docs/ecs/umn/en-us_topic_0166284970.html diff --git a/ecs/umn/en-us_topic_0166284971.html b/docs/ecs/umn/en-us_topic_0166284971.html similarity index 100% rename from ecs/umn/en-us_topic_0166284971.html rename to docs/ecs/umn/en-us_topic_0166284971.html diff --git a/ecs/umn/en-us_topic_0167429328.html b/docs/ecs/umn/en-us_topic_0167429328.html similarity index 100% rename from ecs/umn/en-us_topic_0167429328.html rename to docs/ecs/umn/en-us_topic_0167429328.html diff --git a/ecs/umn/en-us_topic_0167429329.html b/docs/ecs/umn/en-us_topic_0167429329.html similarity index 100% rename from ecs/umn/en-us_topic_0167429329.html rename to docs/ecs/umn/en-us_topic_0167429329.html diff --git a/ecs/umn/en-us_topic_0170135967.html b/docs/ecs/umn/en-us_topic_0170135967.html similarity index 100% rename from ecs/umn/en-us_topic_0170135967.html rename to docs/ecs/umn/en-us_topic_0170135967.html diff --git a/ecs/umn/en-us_topic_0170139796.html b/docs/ecs/umn/en-us_topic_0170139796.html similarity index 100% rename from ecs/umn/en-us_topic_0170139796.html rename to docs/ecs/umn/en-us_topic_0170139796.html diff --git a/ecs/umn/en-us_topic_0170139797.html b/docs/ecs/umn/en-us_topic_0170139797.html similarity index 100% rename from ecs/umn/en-us_topic_0170139797.html rename to docs/ecs/umn/en-us_topic_0170139797.html diff --git a/ecs/umn/en-us_topic_0170139798.html b/docs/ecs/umn/en-us_topic_0170139798.html similarity index 100% rename from ecs/umn/en-us_topic_0170139798.html rename to docs/ecs/umn/en-us_topic_0170139798.html diff --git a/ecs/umn/en-us_topic_0174917535.html b/docs/ecs/umn/en-us_topic_0174917535.html similarity index 100% rename from ecs/umn/en-us_topic_0174917535.html rename to docs/ecs/umn/en-us_topic_0174917535.html diff --git a/ecs/umn/en-us_topic_0176502615.html b/docs/ecs/umn/en-us_topic_0176502615.html similarity index 100% rename from ecs/umn/en-us_topic_0176502615.html rename to docs/ecs/umn/en-us_topic_0176502615.html diff --git a/ecs/umn/en-us_topic_0177457773.html b/docs/ecs/umn/en-us_topic_0177457773.html similarity index 100% rename from ecs/umn/en-us_topic_0177457773.html rename to docs/ecs/umn/en-us_topic_0177457773.html diff --git a/ecs/umn/en-us_topic_0177457774.html b/docs/ecs/umn/en-us_topic_0177457774.html similarity index 100% rename from ecs/umn/en-us_topic_0177457774.html rename to docs/ecs/umn/en-us_topic_0177457774.html diff --git a/ecs/umn/en-us_topic_0177512565.html b/docs/ecs/umn/en-us_topic_0177512565.html similarity index 100% rename from ecs/umn/en-us_topic_0177512565.html rename to docs/ecs/umn/en-us_topic_0177512565.html diff --git a/ecs/umn/en-us_topic_0183016706.html b/docs/ecs/umn/en-us_topic_0183016706.html similarity index 100% rename from ecs/umn/en-us_topic_0183016706.html rename to docs/ecs/umn/en-us_topic_0183016706.html diff --git a/ecs/umn/en-us_topic_0183019668.html b/docs/ecs/umn/en-us_topic_0183019668.html similarity index 100% rename from ecs/umn/en-us_topic_0183019668.html rename to docs/ecs/umn/en-us_topic_0183019668.html diff --git a/ecs/umn/en-us_topic_0183019669.html b/docs/ecs/umn/en-us_topic_0183019669.html similarity index 100% rename from ecs/umn/en-us_topic_0183019669.html rename to docs/ecs/umn/en-us_topic_0183019669.html diff --git a/ecs/umn/en-us_topic_0183019670.html b/docs/ecs/umn/en-us_topic_0183019670.html similarity index 100% rename from ecs/umn/en-us_topic_0183019670.html rename to docs/ecs/umn/en-us_topic_0183019670.html diff --git a/ecs/umn/en-us_topic_0183019671.html b/docs/ecs/umn/en-us_topic_0183019671.html similarity index 100% rename from ecs/umn/en-us_topic_0183019671.html rename to docs/ecs/umn/en-us_topic_0183019671.html diff --git a/ecs/umn/en-us_topic_0186645877.html b/docs/ecs/umn/en-us_topic_0186645877.html similarity index 100% rename from ecs/umn/en-us_topic_0186645877.html rename to docs/ecs/umn/en-us_topic_0186645877.html diff --git a/ecs/umn/en-us_topic_0208808104.html b/docs/ecs/umn/en-us_topic_0208808104.html similarity index 100% rename from ecs/umn/en-us_topic_0208808104.html rename to docs/ecs/umn/en-us_topic_0208808104.html diff --git a/ecs/umn/en-us_topic_0208809314.html b/docs/ecs/umn/en-us_topic_0208809314.html similarity index 100% rename from ecs/umn/en-us_topic_0208809314.html rename to docs/ecs/umn/en-us_topic_0208809314.html diff --git a/ecs/umn/en-us_topic_0208809315.html b/docs/ecs/umn/en-us_topic_0208809315.html similarity index 100% rename from ecs/umn/en-us_topic_0208809315.html rename to docs/ecs/umn/en-us_topic_0208809315.html diff --git a/ecs/umn/en-us_topic_0208809316.html b/docs/ecs/umn/en-us_topic_0208809316.html similarity index 100% rename from ecs/umn/en-us_topic_0208809316.html rename to docs/ecs/umn/en-us_topic_0208809316.html diff --git a/ecs/umn/en-us_topic_0213874991.html b/docs/ecs/umn/en-us_topic_0213874991.html similarity index 100% rename from ecs/umn/en-us_topic_0213874991.html rename to docs/ecs/umn/en-us_topic_0213874991.html diff --git a/ecs/umn/en-us_topic_0214940105.html b/docs/ecs/umn/en-us_topic_0214940105.html similarity index 100% rename from ecs/umn/en-us_topic_0214940105.html rename to docs/ecs/umn/en-us_topic_0214940105.html diff --git a/ecs/umn/en-us_topic_0214940106.html b/docs/ecs/umn/en-us_topic_0214940106.html similarity index 100% rename from ecs/umn/en-us_topic_0214940106.html rename to docs/ecs/umn/en-us_topic_0214940106.html diff --git a/ecs/umn/en-us_topic_0234802636.html b/docs/ecs/umn/en-us_topic_0234802636.html similarity index 100% rename from ecs/umn/en-us_topic_0234802636.html rename to docs/ecs/umn/en-us_topic_0234802636.html diff --git a/ecs/umn/en-us_topic_0236302789.html b/docs/ecs/umn/en-us_topic_0236302789.html similarity index 100% rename from ecs/umn/en-us_topic_0236302789.html rename to docs/ecs/umn/en-us_topic_0236302789.html diff --git a/ecs/umn/en-us_topic_0236308363.html b/docs/ecs/umn/en-us_topic_0236308363.html similarity index 100% rename from ecs/umn/en-us_topic_0236308363.html rename to docs/ecs/umn/en-us_topic_0236308363.html diff --git a/ecs/umn/en-us_topic_0240708482.html b/docs/ecs/umn/en-us_topic_0240708482.html similarity index 100% rename from ecs/umn/en-us_topic_0240708482.html rename to docs/ecs/umn/en-us_topic_0240708482.html diff --git a/ecs/umn/en-us_topic_0240708483.html b/docs/ecs/umn/en-us_topic_0240708483.html similarity index 100% rename from ecs/umn/en-us_topic_0240708483.html rename to docs/ecs/umn/en-us_topic_0240708483.html diff --git a/ecs/umn/en-us_topic_0240714337.html b/docs/ecs/umn/en-us_topic_0240714337.html similarity index 100% rename from ecs/umn/en-us_topic_0240714337.html rename to docs/ecs/umn/en-us_topic_0240714337.html diff --git a/ecs/umn/en-us_topic_0240831198.html b/docs/ecs/umn/en-us_topic_0240831198.html similarity index 100% rename from ecs/umn/en-us_topic_0240831198.html rename to docs/ecs/umn/en-us_topic_0240831198.html diff --git a/ecs/umn/en-us_topic_0244854543.html b/docs/ecs/umn/en-us_topic_0244854543.html similarity index 100% rename from ecs/umn/en-us_topic_0244854543.html rename to docs/ecs/umn/en-us_topic_0244854543.html diff --git a/ecs/umn/en-us_topic_0247282819.html b/docs/ecs/umn/en-us_topic_0247282819.html similarity index 100% rename from ecs/umn/en-us_topic_0247282819.html rename to docs/ecs/umn/en-us_topic_0247282819.html diff --git a/ecs/umn/en-us_topic_0251012483.html b/docs/ecs/umn/en-us_topic_0251012483.html similarity index 100% rename from ecs/umn/en-us_topic_0251012483.html rename to docs/ecs/umn/en-us_topic_0251012483.html diff --git a/ecs/umn/en-us_topic_0263796591.html b/docs/ecs/umn/en-us_topic_0263796591.html similarity index 100% rename from ecs/umn/en-us_topic_0263796591.html rename to docs/ecs/umn/en-us_topic_0263796591.html diff --git a/ecs/umn/en-us_topic_0263806053.html b/docs/ecs/umn/en-us_topic_0263806053.html similarity index 100% rename from ecs/umn/en-us_topic_0263806053.html rename to docs/ecs/umn/en-us_topic_0263806053.html diff --git a/ecs/umn/en-us_topic_0263806054.html b/docs/ecs/umn/en-us_topic_0263806054.html similarity index 100% rename from ecs/umn/en-us_topic_0263806054.html rename to docs/ecs/umn/en-us_topic_0263806054.html diff --git a/ecs/umn/en-us_topic_0264235939.html b/docs/ecs/umn/en-us_topic_0264235939.html similarity index 100% rename from ecs/umn/en-us_topic_0264235939.html rename to docs/ecs/umn/en-us_topic_0264235939.html diff --git a/ecs/umn/en-us_topic_0264235940.html b/docs/ecs/umn/en-us_topic_0264235940.html similarity index 100% rename from ecs/umn/en-us_topic_0264235940.html rename to docs/ecs/umn/en-us_topic_0264235940.html diff --git a/ecs/umn/en-us_topic_0264235941.html b/docs/ecs/umn/en-us_topic_0264235941.html similarity index 100% rename from ecs/umn/en-us_topic_0264235941.html rename to docs/ecs/umn/en-us_topic_0264235941.html diff --git a/ecs/umn/en-us_topic_0264235942.html b/docs/ecs/umn/en-us_topic_0264235942.html similarity index 100% rename from ecs/umn/en-us_topic_0264235942.html rename to docs/ecs/umn/en-us_topic_0264235942.html diff --git a/ecs/umn/en-us_topic_0264235943.html b/docs/ecs/umn/en-us_topic_0264235943.html similarity index 100% rename from ecs/umn/en-us_topic_0264235943.html rename to docs/ecs/umn/en-us_topic_0264235943.html diff --git a/ecs/umn/en-us_topic_0264235944.html b/docs/ecs/umn/en-us_topic_0264235944.html similarity index 100% rename from ecs/umn/en-us_topic_0264235944.html rename to docs/ecs/umn/en-us_topic_0264235944.html diff --git a/ecs/umn/en-us_topic_0264235945.html b/docs/ecs/umn/en-us_topic_0264235945.html similarity index 100% rename from ecs/umn/en-us_topic_0264235945.html rename to docs/ecs/umn/en-us_topic_0264235945.html diff --git a/ecs/umn/en-us_topic_0264235946.html b/docs/ecs/umn/en-us_topic_0264235946.html similarity index 100% rename from ecs/umn/en-us_topic_0264235946.html rename to docs/ecs/umn/en-us_topic_0264235946.html diff --git a/ecs/umn/en-us_topic_0264235947.html b/docs/ecs/umn/en-us_topic_0264235947.html similarity index 100% rename from ecs/umn/en-us_topic_0264235947.html rename to docs/ecs/umn/en-us_topic_0264235947.html diff --git a/ecs/umn/en-us_topic_0264235948.html b/docs/ecs/umn/en-us_topic_0264235948.html similarity index 100% rename from ecs/umn/en-us_topic_0264235948.html rename to docs/ecs/umn/en-us_topic_0264235948.html diff --git a/ecs/umn/en-us_topic_0264235950.html b/docs/ecs/umn/en-us_topic_0264235950.html similarity index 100% rename from ecs/umn/en-us_topic_0264235950.html rename to docs/ecs/umn/en-us_topic_0264235950.html diff --git a/ecs/umn/en-us_topic_0271001300.html b/docs/ecs/umn/en-us_topic_0271001300.html similarity index 100% rename from ecs/umn/en-us_topic_0271001300.html rename to docs/ecs/umn/en-us_topic_0271001300.html diff --git a/ecs/umn/en-us_topic_0275383051.html b/docs/ecs/umn/en-us_topic_0275383051.html similarity index 100% rename from ecs/umn/en-us_topic_0275383051.html rename to docs/ecs/umn/en-us_topic_0275383051.html diff --git a/ecs/umn/en-us_topic_0277097520.html b/docs/ecs/umn/en-us_topic_0277097520.html similarity index 100% rename from ecs/umn/en-us_topic_0277097520.html rename to docs/ecs/umn/en-us_topic_0277097520.html diff --git a/ecs/umn/en-us_topic_0277132844.html b/docs/ecs/umn/en-us_topic_0277132844.html similarity index 100% rename from ecs/umn/en-us_topic_0277132844.html rename to docs/ecs/umn/en-us_topic_0277132844.html diff --git a/ecs/umn/en-us_topic_0295091738.html b/docs/ecs/umn/en-us_topic_0295091738.html similarity index 100% rename from ecs/umn/en-us_topic_0295091738.html rename to docs/ecs/umn/en-us_topic_0295091738.html diff --git a/ecs/umn/public_sys-resources/ExpandCollapse.js b/docs/ecs/umn/public_sys-resources/ExpandCollapse.js similarity index 100% rename from ecs/umn/public_sys-resources/ExpandCollapse.js rename to docs/ecs/umn/public_sys-resources/ExpandCollapse.js diff --git a/ecs/umn/public_sys-resources/caution_3.0-en-us.png b/docs/ecs/umn/public_sys-resources/caution_3.0-en-us.png similarity index 100% rename from ecs/umn/public_sys-resources/caution_3.0-en-us.png rename to docs/ecs/umn/public_sys-resources/caution_3.0-en-us.png diff --git a/ecs/umn/public_sys-resources/commonltr.css b/docs/ecs/umn/public_sys-resources/commonltr.css similarity index 100% rename from ecs/umn/public_sys-resources/commonltr.css rename to docs/ecs/umn/public_sys-resources/commonltr.css diff --git a/ecs/umn/public_sys-resources/commonltr_print.css b/docs/ecs/umn/public_sys-resources/commonltr_print.css similarity index 100% rename from ecs/umn/public_sys-resources/commonltr_print.css rename to docs/ecs/umn/public_sys-resources/commonltr_print.css diff --git a/ecs/umn/public_sys-resources/commonrtl.css b/docs/ecs/umn/public_sys-resources/commonrtl.css similarity index 100% rename from ecs/umn/public_sys-resources/commonrtl.css rename to docs/ecs/umn/public_sys-resources/commonrtl.css diff --git a/ecs/umn/public_sys-resources/danger_3.0-en-us.png b/docs/ecs/umn/public_sys-resources/danger_3.0-en-us.png similarity index 100% rename from ecs/umn/public_sys-resources/danger_3.0-en-us.png rename to docs/ecs/umn/public_sys-resources/danger_3.0-en-us.png diff --git a/ecs/umn/public_sys-resources/delta.gif b/docs/ecs/umn/public_sys-resources/delta.gif similarity index 100% rename from ecs/umn/public_sys-resources/delta.gif rename to docs/ecs/umn/public_sys-resources/delta.gif diff --git a/ecs/umn/public_sys-resources/deltaend.gif b/docs/ecs/umn/public_sys-resources/deltaend.gif similarity index 100% rename from ecs/umn/public_sys-resources/deltaend.gif rename to docs/ecs/umn/public_sys-resources/deltaend.gif diff --git a/ecs/umn/public_sys-resources/icon-arrowdn.gif b/docs/ecs/umn/public_sys-resources/icon-arrowdn.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-arrowdn.gif rename to docs/ecs/umn/public_sys-resources/icon-arrowdn.gif diff --git a/ecs/umn/public_sys-resources/icon-arrowrt.gif b/docs/ecs/umn/public_sys-resources/icon-arrowrt.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-arrowrt.gif rename to docs/ecs/umn/public_sys-resources/icon-arrowrt.gif diff --git a/ecs/umn/public_sys-resources/icon-caution.gif b/docs/ecs/umn/public_sys-resources/icon-caution.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-caution.gif rename to docs/ecs/umn/public_sys-resources/icon-caution.gif diff --git a/ecs/umn/public_sys-resources/icon-danger.gif b/docs/ecs/umn/public_sys-resources/icon-danger.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-danger.gif rename to docs/ecs/umn/public_sys-resources/icon-danger.gif diff --git a/ecs/umn/public_sys-resources/icon-huawei.gif b/docs/ecs/umn/public_sys-resources/icon-huawei.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-huawei.gif rename to docs/ecs/umn/public_sys-resources/icon-huawei.gif diff --git a/ecs/umn/public_sys-resources/icon-note.gif b/docs/ecs/umn/public_sys-resources/icon-note.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-note.gif rename to docs/ecs/umn/public_sys-resources/icon-note.gif diff --git a/ecs/umn/public_sys-resources/icon-notice.gif b/docs/ecs/umn/public_sys-resources/icon-notice.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-notice.gif rename to docs/ecs/umn/public_sys-resources/icon-notice.gif diff --git a/ecs/umn/public_sys-resources/icon-tip.gif b/docs/ecs/umn/public_sys-resources/icon-tip.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-tip.gif rename to docs/ecs/umn/public_sys-resources/icon-tip.gif diff --git a/ecs/umn/public_sys-resources/icon-warning.gif b/docs/ecs/umn/public_sys-resources/icon-warning.gif similarity index 100% rename from ecs/umn/public_sys-resources/icon-warning.gif rename to docs/ecs/umn/public_sys-resources/icon-warning.gif diff --git a/ecs/umn/public_sys-resources/imageResize.js b/docs/ecs/umn/public_sys-resources/imageResize.js similarity index 100% rename from ecs/umn/public_sys-resources/imageResize.js rename to docs/ecs/umn/public_sys-resources/imageResize.js diff --git a/ecs/umn/public_sys-resources/imageclose.gif b/docs/ecs/umn/public_sys-resources/imageclose.gif similarity index 100% rename from ecs/umn/public_sys-resources/imageclose.gif rename to docs/ecs/umn/public_sys-resources/imageclose.gif diff --git a/ecs/umn/public_sys-resources/imageclosehover.gif b/docs/ecs/umn/public_sys-resources/imageclosehover.gif similarity index 100% rename from ecs/umn/public_sys-resources/imageclosehover.gif rename to docs/ecs/umn/public_sys-resources/imageclosehover.gif diff --git a/ecs/umn/public_sys-resources/imagemax.gif b/docs/ecs/umn/public_sys-resources/imagemax.gif similarity index 100% rename from ecs/umn/public_sys-resources/imagemax.gif rename to docs/ecs/umn/public_sys-resources/imagemax.gif diff --git a/ecs/umn/public_sys-resources/imagemaxhover.gif b/docs/ecs/umn/public_sys-resources/imagemaxhover.gif similarity index 100% rename from ecs/umn/public_sys-resources/imagemaxhover.gif rename to docs/ecs/umn/public_sys-resources/imagemaxhover.gif diff --git a/ecs/umn/public_sys-resources/jquery-migrate-1.2.1.min.js b/docs/ecs/umn/public_sys-resources/jquery-migrate-1.2.1.min.js similarity index 100% rename from ecs/umn/public_sys-resources/jquery-migrate-1.2.1.min.js rename to docs/ecs/umn/public_sys-resources/jquery-migrate-1.2.1.min.js diff --git a/ecs/umn/public_sys-resources/jquery-ui.min.js b/docs/ecs/umn/public_sys-resources/jquery-ui.min.js similarity index 100% rename from ecs/umn/public_sys-resources/jquery-ui.min.js rename to docs/ecs/umn/public_sys-resources/jquery-ui.min.js diff --git a/ecs/umn/public_sys-resources/jquery.min.js b/docs/ecs/umn/public_sys-resources/jquery.min.js similarity index 100% rename from ecs/umn/public_sys-resources/jquery.min.js rename to docs/ecs/umn/public_sys-resources/jquery.min.js diff --git a/ecs/umn/public_sys-resources/jquery.mousewheel.min.js b/docs/ecs/umn/public_sys-resources/jquery.mousewheel.min.js similarity index 100% rename from ecs/umn/public_sys-resources/jquery.mousewheel.min.js rename to docs/ecs/umn/public_sys-resources/jquery.mousewheel.min.js diff --git a/ecs/umn/public_sys-resources/macFFBgHack.png b/docs/ecs/umn/public_sys-resources/macFFBgHack.png similarity index 100% rename from ecs/umn/public_sys-resources/macFFBgHack.png rename to docs/ecs/umn/public_sys-resources/macFFBgHack.png diff --git a/ecs/umn/public_sys-resources/note_3.0-en-us.png b/docs/ecs/umn/public_sys-resources/note_3.0-en-us.png similarity index 100% rename from ecs/umn/public_sys-resources/note_3.0-en-us.png rename to docs/ecs/umn/public_sys-resources/note_3.0-en-us.png diff --git a/ecs/umn/public_sys-resources/notice_3.0-en-us.png b/docs/ecs/umn/public_sys-resources/notice_3.0-en-us.png similarity index 100% rename from ecs/umn/public_sys-resources/notice_3.0-en-us.png rename to docs/ecs/umn/public_sys-resources/notice_3.0-en-us.png diff --git a/ecs/umn/public_sys-resources/popup.js b/docs/ecs/umn/public_sys-resources/popup.js similarity index 100% rename from ecs/umn/public_sys-resources/popup.js rename to docs/ecs/umn/public_sys-resources/popup.js diff --git a/ecs/umn/public_sys-resources/thickbox.css b/docs/ecs/umn/public_sys-resources/thickbox.css similarity index 100% rename from ecs/umn/public_sys-resources/thickbox.css rename to docs/ecs/umn/public_sys-resources/thickbox.css diff --git a/ecs/umn/public_sys-resources/thickbox.js b/docs/ecs/umn/public_sys-resources/thickbox.js similarity index 100% rename from ecs/umn/public_sys-resources/thickbox.js rename to docs/ecs/umn/public_sys-resources/thickbox.js diff --git a/ecs/umn/public_sys-resources/warning_3.0-en-us.png b/docs/ecs/umn/public_sys-resources/warning_3.0-en-us.png similarity index 100% rename from ecs/umn/public_sys-resources/warning_3.0-en-us.png rename to docs/ecs/umn/public_sys-resources/warning_3.0-en-us.png diff --git a/modelarts/api-ref/ALL_META.TXT.json b/docs/modelarts/api-ref/ALL_META.TXT.json similarity index 100% rename from modelarts/api-ref/ALL_META.TXT.json rename to docs/modelarts/api-ref/ALL_META.TXT.json diff --git a/modelarts/api-ref/AcceptSamples.html b/docs/modelarts/api-ref/AcceptSamples.html similarity index 100% rename from modelarts/api-ref/AcceptSamples.html rename to docs/modelarts/api-ref/AcceptSamples.html diff --git a/modelarts/api-ref/AutoAnnotationProgress.html b/docs/modelarts/api-ref/AutoAnnotationProgress.html similarity index 100% rename from modelarts/api-ref/AutoAnnotationProgress.html rename to docs/modelarts/api-ref/AutoAnnotationProgress.html diff --git a/modelarts/api-ref/CLASS.TXT.json b/docs/modelarts/api-ref/CLASS.TXT.json similarity index 100% rename from modelarts/api-ref/CLASS.TXT.json rename to docs/modelarts/api-ref/CLASS.TXT.json diff --git a/modelarts/api-ref/CreateAuthorization.html b/docs/modelarts/api-ref/CreateAuthorization.html similarity index 100% rename from modelarts/api-ref/CreateAuthorization.html rename to docs/modelarts/api-ref/CreateAuthorization.html diff --git a/modelarts/api-ref/CreateDataset.html b/docs/modelarts/api-ref/CreateDataset.html similarity index 100% rename from modelarts/api-ref/CreateDataset.html rename to docs/modelarts/api-ref/CreateDataset.html diff --git a/modelarts/api-ref/CreateDatasetVersion.html b/docs/modelarts/api-ref/CreateDatasetVersion.html similarity index 100% rename from modelarts/api-ref/CreateDatasetVersion.html rename to docs/modelarts/api-ref/CreateDatasetVersion.html diff --git a/modelarts/api-ref/CreateLabels.html b/docs/modelarts/api-ref/CreateLabels.html similarity index 100% rename from modelarts/api-ref/CreateLabels.html rename to docs/modelarts/api-ref/CreateLabels.html diff --git a/modelarts/api-ref/CreateModelArtsAgency.html b/docs/modelarts/api-ref/CreateModelArtsAgency.html similarity index 100% rename from modelarts/api-ref/CreateModelArtsAgency.html rename to docs/modelarts/api-ref/CreateModelArtsAgency.html diff --git a/modelarts/api-ref/CreateProcessorTask.html b/docs/modelarts/api-ref/CreateProcessorTask.html similarity index 100% rename from modelarts/api-ref/CreateProcessorTask.html rename to docs/modelarts/api-ref/CreateProcessorTask.html diff --git a/modelarts/api-ref/CreateProcessorTaskVersion.html b/docs/modelarts/api-ref/CreateProcessorTaskVersion.html similarity index 100% rename from modelarts/api-ref/CreateProcessorTaskVersion.html rename to docs/modelarts/api-ref/CreateProcessorTaskVersion.html diff --git a/modelarts/api-ref/CreateTask.html b/docs/modelarts/api-ref/CreateTask.html similarity index 100% rename from modelarts/api-ref/CreateTask.html rename to docs/modelarts/api-ref/CreateTask.html diff --git a/modelarts/api-ref/CreateWorker.html b/docs/modelarts/api-ref/CreateWorker.html similarity index 100% rename from modelarts/api-ref/CreateWorker.html rename to docs/modelarts/api-ref/CreateWorker.html diff --git a/modelarts/api-ref/CreateWorkforce.html b/docs/modelarts/api-ref/CreateWorkforce.html similarity index 100% rename from modelarts/api-ref/CreateWorkforce.html rename to docs/modelarts/api-ref/CreateWorkforce.html diff --git a/modelarts/api-ref/CreateWorkforceTask.html b/docs/modelarts/api-ref/CreateWorkforceTask.html similarity index 100% rename from modelarts/api-ref/CreateWorkforceTask.html rename to docs/modelarts/api-ref/CreateWorkforceTask.html diff --git a/modelarts/api-ref/CreateWorkspace.html b/docs/modelarts/api-ref/CreateWorkspace.html similarity index 100% rename from modelarts/api-ref/CreateWorkspace.html rename to docs/modelarts/api-ref/CreateWorkspace.html diff --git a/modelarts/api-ref/DeleteAuthorizations.html b/docs/modelarts/api-ref/DeleteAuthorizations.html similarity index 100% rename from modelarts/api-ref/DeleteAuthorizations.html rename to docs/modelarts/api-ref/DeleteAuthorizations.html diff --git a/modelarts/api-ref/DeleteDataset.html b/docs/modelarts/api-ref/DeleteDataset.html similarity index 100% rename from modelarts/api-ref/DeleteDataset.html rename to docs/modelarts/api-ref/DeleteDataset.html diff --git a/modelarts/api-ref/DeleteDatasetVersion.html b/docs/modelarts/api-ref/DeleteDatasetVersion.html similarity index 100% rename from modelarts/api-ref/DeleteDatasetVersion.html rename to docs/modelarts/api-ref/DeleteDatasetVersion.html diff --git a/modelarts/api-ref/DeleteLabelAndSamples.html b/docs/modelarts/api-ref/DeleteLabelAndSamples.html similarity index 100% rename from modelarts/api-ref/DeleteLabelAndSamples.html rename to docs/modelarts/api-ref/DeleteLabelAndSamples.html diff --git a/modelarts/api-ref/DeleteLabels.html b/docs/modelarts/api-ref/DeleteLabels.html similarity index 100% rename from modelarts/api-ref/DeleteLabels.html rename to docs/modelarts/api-ref/DeleteLabels.html diff --git a/modelarts/api-ref/DeleteProcessorTask.html b/docs/modelarts/api-ref/DeleteProcessorTask.html similarity index 100% rename from modelarts/api-ref/DeleteProcessorTask.html rename to docs/modelarts/api-ref/DeleteProcessorTask.html diff --git a/modelarts/api-ref/DeleteProcessorTaskVersion.html b/docs/modelarts/api-ref/DeleteProcessorTaskVersion.html similarity index 100% rename from modelarts/api-ref/DeleteProcessorTaskVersion.html rename to docs/modelarts/api-ref/DeleteProcessorTaskVersion.html diff --git a/modelarts/api-ref/DeleteSamples.html b/docs/modelarts/api-ref/DeleteSamples.html similarity index 100% rename from modelarts/api-ref/DeleteSamples.html rename to docs/modelarts/api-ref/DeleteSamples.html diff --git a/modelarts/api-ref/DeleteWorker.html b/docs/modelarts/api-ref/DeleteWorker.html similarity index 100% rename from modelarts/api-ref/DeleteWorker.html rename to docs/modelarts/api-ref/DeleteWorker.html diff --git a/modelarts/api-ref/DeleteWorkers.html b/docs/modelarts/api-ref/DeleteWorkers.html similarity index 100% rename from modelarts/api-ref/DeleteWorkers.html rename to docs/modelarts/api-ref/DeleteWorkers.html diff --git a/modelarts/api-ref/DeleteWorkforce.html b/docs/modelarts/api-ref/DeleteWorkforce.html similarity index 100% rename from modelarts/api-ref/DeleteWorkforce.html rename to docs/modelarts/api-ref/DeleteWorkforce.html diff --git a/modelarts/api-ref/DeleteWorkforceTask.html b/docs/modelarts/api-ref/DeleteWorkforceTask.html similarity index 100% rename from modelarts/api-ref/DeleteWorkforceTask.html rename to docs/modelarts/api-ref/DeleteWorkforceTask.html diff --git a/modelarts/api-ref/DeleteWorkspace.html b/docs/modelarts/api-ref/DeleteWorkspace.html similarity index 100% rename from modelarts/api-ref/DeleteWorkspace.html rename to docs/modelarts/api-ref/DeleteWorkspace.html diff --git a/modelarts/api-ref/DescDataset.html b/docs/modelarts/api-ref/DescDataset.html similarity index 100% rename from modelarts/api-ref/DescDataset.html rename to docs/modelarts/api-ref/DescDataset.html diff --git a/modelarts/api-ref/DescImportTask.html b/docs/modelarts/api-ref/DescImportTask.html similarity index 100% rename from modelarts/api-ref/DescImportTask.html rename to docs/modelarts/api-ref/DescImportTask.html diff --git a/modelarts/api-ref/DescProcessorTaskVersion.html b/docs/modelarts/api-ref/DescProcessorTaskVersion.html similarity index 100% rename from modelarts/api-ref/DescProcessorTaskVersion.html rename to docs/modelarts/api-ref/DescProcessorTaskVersion.html diff --git a/modelarts/api-ref/DescWorker.html b/docs/modelarts/api-ref/DescWorker.html similarity index 100% rename from modelarts/api-ref/DescWorker.html rename to docs/modelarts/api-ref/DescWorker.html diff --git a/modelarts/api-ref/DescWorkforce.html b/docs/modelarts/api-ref/DescWorkforce.html similarity index 100% rename from modelarts/api-ref/DescWorkforce.html rename to docs/modelarts/api-ref/DescWorkforce.html diff --git a/modelarts/api-ref/DescWorkforceTask.html b/docs/modelarts/api-ref/DescWorkforceTask.html similarity index 100% rename from modelarts/api-ref/DescWorkforceTask.html rename to docs/modelarts/api-ref/DescWorkforceTask.html diff --git a/modelarts/api-ref/DescribeAutoAnnotationSample.html b/docs/modelarts/api-ref/DescribeAutoAnnotationSample.html similarity index 100% rename from modelarts/api-ref/DescribeAutoAnnotationSample.html rename to docs/modelarts/api-ref/DescribeAutoAnnotationSample.html diff --git a/modelarts/api-ref/DescribeDatasetVersion.html b/docs/modelarts/api-ref/DescribeDatasetVersion.html similarity index 100% rename from modelarts/api-ref/DescribeDatasetVersion.html rename to docs/modelarts/api-ref/DescribeDatasetVersion.html diff --git a/modelarts/api-ref/DescribeProcessorTask.html b/docs/modelarts/api-ref/DescribeProcessorTask.html similarity index 100% rename from modelarts/api-ref/DescribeProcessorTask.html rename to docs/modelarts/api-ref/DescribeProcessorTask.html diff --git a/modelarts/api-ref/DescribeSample.html b/docs/modelarts/api-ref/DescribeSample.html similarity index 100% rename from modelarts/api-ref/DescribeSample.html rename to docs/modelarts/api-ref/DescribeSample.html diff --git a/modelarts/api-ref/DescribeWorkforceTaskSample.html b/docs/modelarts/api-ref/DescribeWorkforceTaskSample.html similarity index 100% rename from modelarts/api-ref/DescribeWorkforceTaskSample.html rename to docs/modelarts/api-ref/DescribeWorkforceTaskSample.html diff --git a/modelarts/api-ref/ExportTask.html b/docs/modelarts/api-ref/ExportTask.html similarity index 100% rename from modelarts/api-ref/ExportTask.html rename to docs/modelarts/api-ref/ExportTask.html diff --git a/modelarts/api-ref/GetAuthorizations.html b/docs/modelarts/api-ref/GetAuthorizations.html similarity index 100% rename from modelarts/api-ref/GetAuthorizations.html rename to docs/modelarts/api-ref/GetAuthorizations.html diff --git a/modelarts/api-ref/GetDatasetMetrics.html b/docs/modelarts/api-ref/GetDatasetMetrics.html similarity index 100% rename from modelarts/api-ref/GetDatasetMetrics.html rename to docs/modelarts/api-ref/GetDatasetMetrics.html diff --git a/modelarts/api-ref/GetExportTaskStatusOfDataset.html b/docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html similarity index 100% rename from modelarts/api-ref/GetExportTaskStatusOfDataset.html rename to docs/modelarts/api-ref/GetExportTaskStatusOfDataset.html diff --git a/modelarts/api-ref/GetExportTasksStatusOfDataset.html b/docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html similarity index 100% rename from modelarts/api-ref/GetExportTasksStatusOfDataset.html rename to docs/modelarts/api-ref/GetExportTasksStatusOfDataset.html diff --git a/modelarts/api-ref/GetProcessorTaskItems.html b/docs/modelarts/api-ref/GetProcessorTaskItems.html similarity index 100% rename from modelarts/api-ref/GetProcessorTaskItems.html rename to docs/modelarts/api-ref/GetProcessorTaskItems.html diff --git a/modelarts/api-ref/GetWorkforceSamplingTask.html b/docs/modelarts/api-ref/GetWorkforceSamplingTask.html similarity index 100% rename from modelarts/api-ref/GetWorkforceSamplingTask.html rename to docs/modelarts/api-ref/GetWorkforceSamplingTask.html diff --git a/modelarts/api-ref/GetWorkforceTaskMetrics.html b/docs/modelarts/api-ref/GetWorkforceTaskMetrics.html similarity index 100% rename from modelarts/api-ref/GetWorkforceTaskMetrics.html rename to docs/modelarts/api-ref/GetWorkforceTaskMetrics.html diff --git a/modelarts/api-ref/ImportTask.html b/docs/modelarts/api-ref/ImportTask.html similarity index 100% rename from modelarts/api-ref/ImportTask.html rename to docs/modelarts/api-ref/ImportTask.html diff --git a/modelarts/api-ref/ListAllWorkers.html b/docs/modelarts/api-ref/ListAllWorkers.html similarity index 100% rename from modelarts/api-ref/ListAllWorkers.html rename to docs/modelarts/api-ref/ListAllWorkers.html diff --git a/modelarts/api-ref/ListAutoAnnotationSamples.html b/docs/modelarts/api-ref/ListAutoAnnotationSamples.html similarity index 100% rename from modelarts/api-ref/ListAutoAnnotationSamples.html rename to docs/modelarts/api-ref/ListAutoAnnotationSamples.html diff --git a/modelarts/api-ref/ListDatasetVersions.html b/docs/modelarts/api-ref/ListDatasetVersions.html similarity index 100% rename from modelarts/api-ref/ListDatasetVersions.html rename to docs/modelarts/api-ref/ListDatasetVersions.html diff --git a/modelarts/api-ref/ListDatasets.html b/docs/modelarts/api-ref/ListDatasets.html similarity index 100% rename from modelarts/api-ref/ListDatasets.html rename to docs/modelarts/api-ref/ListDatasets.html diff --git a/modelarts/api-ref/ListImportTasks.html b/docs/modelarts/api-ref/ListImportTasks.html similarity index 100% rename from modelarts/api-ref/ListImportTasks.html rename to docs/modelarts/api-ref/ListImportTasks.html diff --git a/modelarts/api-ref/ListLabels.html b/docs/modelarts/api-ref/ListLabels.html similarity index 100% rename from modelarts/api-ref/ListLabels.html rename to docs/modelarts/api-ref/ListLabels.html diff --git a/modelarts/api-ref/ListProcessorTaskVersionResults.html b/docs/modelarts/api-ref/ListProcessorTaskVersionResults.html similarity index 100% rename from modelarts/api-ref/ListProcessorTaskVersionResults.html rename to docs/modelarts/api-ref/ListProcessorTaskVersionResults.html diff --git a/modelarts/api-ref/ListProcessorTaskVersions.html b/docs/modelarts/api-ref/ListProcessorTaskVersions.html similarity index 100% rename from modelarts/api-ref/ListProcessorTaskVersions.html rename to docs/modelarts/api-ref/ListProcessorTaskVersions.html diff --git a/modelarts/api-ref/ListProcessorTasks.html b/docs/modelarts/api-ref/ListProcessorTasks.html similarity index 100% rename from modelarts/api-ref/ListProcessorTasks.html rename to docs/modelarts/api-ref/ListProcessorTasks.html diff --git a/modelarts/api-ref/ListSamples.html b/docs/modelarts/api-ref/ListSamples.html similarity index 100% rename from modelarts/api-ref/ListSamples.html rename to docs/modelarts/api-ref/ListSamples.html diff --git a/modelarts/api-ref/ListSearch.html b/docs/modelarts/api-ref/ListSearch.html similarity index 100% rename from modelarts/api-ref/ListSearch.html rename to docs/modelarts/api-ref/ListSearch.html diff --git a/modelarts/api-ref/ListStats.html b/docs/modelarts/api-ref/ListStats.html similarity index 100% rename from modelarts/api-ref/ListStats.html rename to docs/modelarts/api-ref/ListStats.html diff --git a/modelarts/api-ref/ListTasks.html b/docs/modelarts/api-ref/ListTasks.html similarity index 100% rename from modelarts/api-ref/ListTasks.html rename to docs/modelarts/api-ref/ListTasks.html diff --git a/modelarts/api-ref/ListWorkerTasks.html b/docs/modelarts/api-ref/ListWorkerTasks.html similarity index 100% rename from modelarts/api-ref/ListWorkerTasks.html rename to docs/modelarts/api-ref/ListWorkerTasks.html diff --git a/modelarts/api-ref/ListWorkers.html b/docs/modelarts/api-ref/ListWorkers.html similarity index 100% rename from modelarts/api-ref/ListWorkers.html rename to docs/modelarts/api-ref/ListWorkers.html diff --git a/modelarts/api-ref/ListWorkforceTaskSamples.html b/docs/modelarts/api-ref/ListWorkforceTaskSamples.html similarity index 100% rename from modelarts/api-ref/ListWorkforceTaskSamples.html rename to docs/modelarts/api-ref/ListWorkforceTaskSamples.html diff --git a/modelarts/api-ref/ListWorkforceTaskStats.html b/docs/modelarts/api-ref/ListWorkforceTaskStats.html similarity index 100% rename from modelarts/api-ref/ListWorkforceTaskStats.html rename to docs/modelarts/api-ref/ListWorkforceTaskStats.html diff --git a/modelarts/api-ref/ListWorkforceTasks.html b/docs/modelarts/api-ref/ListWorkforceTasks.html similarity index 100% rename from modelarts/api-ref/ListWorkforceTasks.html rename to docs/modelarts/api-ref/ListWorkforceTasks.html diff --git a/modelarts/api-ref/ListWorkforces.html b/docs/modelarts/api-ref/ListWorkforces.html similarity index 100% rename from modelarts/api-ref/ListWorkforces.html rename to docs/modelarts/api-ref/ListWorkforces.html diff --git a/modelarts/api-ref/ListWorkspaceQuotas.html b/docs/modelarts/api-ref/ListWorkspaceQuotas.html similarity index 100% rename from modelarts/api-ref/ListWorkspaceQuotas.html rename to docs/modelarts/api-ref/ListWorkspaceQuotas.html diff --git a/modelarts/api-ref/ListWorkspaces.html b/docs/modelarts/api-ref/ListWorkspaces.html similarity index 100% rename from modelarts/api-ref/ListWorkspaces.html rename to docs/modelarts/api-ref/ListWorkspaces.html diff --git a/modelarts/api-ref/PARAMETERS.txt b/docs/modelarts/api-ref/PARAMETERS.txt similarity index 100% rename from modelarts/api-ref/PARAMETERS.txt rename to docs/modelarts/api-ref/PARAMETERS.txt diff --git a/modelarts/api-ref/ReviewSamples.html b/docs/modelarts/api-ref/ReviewSamples.html similarity index 100% rename from modelarts/api-ref/ReviewSamples.html rename to docs/modelarts/api-ref/ReviewSamples.html diff --git a/modelarts/api-ref/SendEmails.html b/docs/modelarts/api-ref/SendEmails.html similarity index 100% rename from modelarts/api-ref/SendEmails.html rename to docs/modelarts/api-ref/SendEmails.html diff --git a/modelarts/api-ref/ShowWorkspaceInfo.html b/docs/modelarts/api-ref/ShowWorkspaceInfo.html similarity index 100% rename from modelarts/api-ref/ShowWorkspaceInfo.html rename to docs/modelarts/api-ref/ShowWorkspaceInfo.html diff --git a/modelarts/api-ref/StartWorkforceSamplingTask.html b/docs/modelarts/api-ref/StartWorkforceSamplingTask.html similarity index 100% rename from modelarts/api-ref/StartWorkforceSamplingTask.html rename to docs/modelarts/api-ref/StartWorkforceSamplingTask.html diff --git a/modelarts/api-ref/StartWorkforceTask.html b/docs/modelarts/api-ref/StartWorkforceTask.html similarity index 100% rename from modelarts/api-ref/StartWorkforceTask.html rename to docs/modelarts/api-ref/StartWorkforceTask.html diff --git a/modelarts/api-ref/StopAutoAnnotation.html b/docs/modelarts/api-ref/StopAutoAnnotation.html similarity index 100% rename from modelarts/api-ref/StopAutoAnnotation.html rename to docs/modelarts/api-ref/StopAutoAnnotation.html diff --git a/modelarts/api-ref/StopProcessorTaskVersion.html b/docs/modelarts/api-ref/StopProcessorTaskVersion.html similarity index 100% rename from modelarts/api-ref/StopProcessorTaskVersion.html rename to docs/modelarts/api-ref/StopProcessorTaskVersion.html diff --git a/modelarts/api-ref/SyncDataSource.html b/docs/modelarts/api-ref/SyncDataSource.html similarity index 100% rename from modelarts/api-ref/SyncDataSource.html rename to docs/modelarts/api-ref/SyncDataSource.html diff --git a/modelarts/api-ref/SyncDataSourceState.html b/docs/modelarts/api-ref/SyncDataSourceState.html similarity index 100% rename from modelarts/api-ref/SyncDataSourceState.html rename to docs/modelarts/api-ref/SyncDataSourceState.html diff --git a/modelarts/api-ref/UpdateDataset.html b/docs/modelarts/api-ref/UpdateDataset.html similarity index 100% rename from modelarts/api-ref/UpdateDataset.html rename to docs/modelarts/api-ref/UpdateDataset.html diff --git a/modelarts/api-ref/UpdateLabel.html b/docs/modelarts/api-ref/UpdateLabel.html similarity index 100% rename from modelarts/api-ref/UpdateLabel.html rename to docs/modelarts/api-ref/UpdateLabel.html diff --git a/modelarts/api-ref/UpdateLabels.html b/docs/modelarts/api-ref/UpdateLabels.html similarity index 100% rename from modelarts/api-ref/UpdateLabels.html rename to docs/modelarts/api-ref/UpdateLabels.html diff --git a/modelarts/api-ref/UpdateProcessorTask.html b/docs/modelarts/api-ref/UpdateProcessorTask.html similarity index 100% rename from modelarts/api-ref/UpdateProcessorTask.html rename to docs/modelarts/api-ref/UpdateProcessorTask.html diff --git a/modelarts/api-ref/UpdateSamples.html b/docs/modelarts/api-ref/UpdateSamples.html similarity index 100% rename from modelarts/api-ref/UpdateSamples.html rename to docs/modelarts/api-ref/UpdateSamples.html diff --git a/modelarts/api-ref/UpdateWorker.html b/docs/modelarts/api-ref/UpdateWorker.html similarity index 100% rename from modelarts/api-ref/UpdateWorker.html rename to docs/modelarts/api-ref/UpdateWorker.html diff --git a/modelarts/api-ref/UpdateWorkforce.html b/docs/modelarts/api-ref/UpdateWorkforce.html similarity index 100% rename from modelarts/api-ref/UpdateWorkforce.html rename to docs/modelarts/api-ref/UpdateWorkforce.html diff --git a/modelarts/api-ref/UpdateWorkforceSamplingTask.html b/docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html similarity index 100% rename from modelarts/api-ref/UpdateWorkforceSamplingTask.html rename to docs/modelarts/api-ref/UpdateWorkforceSamplingTask.html diff --git a/modelarts/api-ref/UpdateWorkforceTask.html b/docs/modelarts/api-ref/UpdateWorkforceTask.html similarity index 100% rename from modelarts/api-ref/UpdateWorkforceTask.html rename to docs/modelarts/api-ref/UpdateWorkforceTask.html diff --git a/modelarts/api-ref/UpdateWorkforceTaskSamples.html b/docs/modelarts/api-ref/UpdateWorkforceTaskSamples.html similarity index 100% rename from modelarts/api-ref/UpdateWorkforceTaskSamples.html rename to docs/modelarts/api-ref/UpdateWorkforceTaskSamples.html diff --git a/modelarts/api-ref/UpdateWorkspace.html b/docs/modelarts/api-ref/UpdateWorkspace.html similarity index 100% rename from modelarts/api-ref/UpdateWorkspace.html rename to docs/modelarts/api-ref/UpdateWorkspace.html diff --git a/modelarts/api-ref/UpdateWorkspaceQuotas.html b/docs/modelarts/api-ref/UpdateWorkspaceQuotas.html similarity index 100% rename from modelarts/api-ref/UpdateWorkspaceQuotas.html rename to docs/modelarts/api-ref/UpdateWorkspaceQuotas.html diff --git a/modelarts/api-ref/UploadSamplesJson.html b/docs/modelarts/api-ref/UploadSamplesJson.html similarity index 100% rename from modelarts/api-ref/UploadSamplesJson.html rename to docs/modelarts/api-ref/UploadSamplesJson.html diff --git a/modelarts/api-ref/authorization.html b/docs/modelarts/api-ref/authorization.html similarity index 100% rename from modelarts/api-ref/authorization.html rename to docs/modelarts/api-ref/authorization.html diff --git a/modelarts/api-ref/auto_task.html b/docs/modelarts/api-ref/auto_task.html similarity index 100% rename from modelarts/api-ref/auto_task.html rename to docs/modelarts/api-ref/auto_task.html diff --git a/modelarts/api-ref/data_export.html b/docs/modelarts/api-ref/data_export.html similarity index 100% rename from modelarts/api-ref/data_export.html rename to docs/modelarts/api-ref/data_export.html diff --git a/modelarts/api-ref/data_import.html b/docs/modelarts/api-ref/data_import.html similarity index 100% rename from modelarts/api-ref/data_import.html rename to docs/modelarts/api-ref/data_import.html diff --git a/modelarts/api-ref/data_sync.html b/docs/modelarts/api-ref/data_sync.html similarity index 100% rename from modelarts/api-ref/data_sync.html rename to docs/modelarts/api-ref/data_sync.html diff --git a/modelarts/api-ref/dataset_management.html b/docs/modelarts/api-ref/dataset_management.html similarity index 100% rename from modelarts/api-ref/dataset_management.html rename to docs/modelarts/api-ref/dataset_management.html diff --git a/modelarts/api-ref/dataset_version_management.html b/docs/modelarts/api-ref/dataset_version_management.html similarity index 100% rename from modelarts/api-ref/dataset_version_management.html rename to docs/modelarts/api-ref/dataset_version_management.html diff --git a/modelarts/api-ref/en-us_image_0000001126894914.png b/docs/modelarts/api-ref/en-us_image_0000001126894914.png similarity index 100% rename from modelarts/api-ref/en-us_image_0000001126894914.png rename to docs/modelarts/api-ref/en-us_image_0000001126894914.png diff --git a/modelarts/api-ref/en-us_image_0000001126895190.png b/docs/modelarts/api-ref/en-us_image_0000001126895190.png similarity index 100% rename from modelarts/api-ref/en-us_image_0000001126895190.png rename to docs/modelarts/api-ref/en-us_image_0000001126895190.png diff --git a/modelarts/api-ref/en-us_image_0150916848.gif b/docs/modelarts/api-ref/en-us_image_0150916848.gif similarity index 100% rename from modelarts/api-ref/en-us_image_0150916848.gif rename to docs/modelarts/api-ref/en-us_image_0150916848.gif diff --git a/modelarts/api-ref/en-us_image_0150917346.gif b/docs/modelarts/api-ref/en-us_image_0150917346.gif similarity index 100% rename from modelarts/api-ref/en-us_image_0150917346.gif rename to docs/modelarts/api-ref/en-us_image_0150917346.gif diff --git a/modelarts/api-ref/en-us_image_0150917350.gif b/docs/modelarts/api-ref/en-us_image_0150917350.gif similarity index 100% rename from modelarts/api-ref/en-us_image_0150917350.gif rename to docs/modelarts/api-ref/en-us_image_0150917350.gif diff --git a/modelarts/api-ref/en-us_image_0150917353.gif b/docs/modelarts/api-ref/en-us_image_0150917353.gif similarity index 100% rename from modelarts/api-ref/en-us_image_0150917353.gif rename to docs/modelarts/api-ref/en-us_image_0150917353.gif diff --git a/modelarts/api-ref/en-us_image_0171113090.png b/docs/modelarts/api-ref/en-us_image_0171113090.png similarity index 100% rename from modelarts/api-ref/en-us_image_0171113090.png rename to docs/modelarts/api-ref/en-us_image_0171113090.png diff --git a/modelarts/api-ref/en-us_image_0171392261.gif b/docs/modelarts/api-ref/en-us_image_0171392261.gif similarity index 100% rename from modelarts/api-ref/en-us_image_0171392261.gif rename to docs/modelarts/api-ref/en-us_image_0171392261.gif diff --git a/modelarts/api-ref/en-us_topic_0000001147936839.html b/docs/modelarts/api-ref/en-us_topic_0000001147936839.html similarity index 100% rename from modelarts/api-ref/en-us_topic_0000001147936839.html rename to docs/modelarts/api-ref/en-us_topic_0000001147936839.html diff --git a/modelarts/api-ref/label_management.html b/docs/modelarts/api-ref/label_management.html similarity index 100% rename from modelarts/api-ref/label_management.html rename to docs/modelarts/api-ref/label_management.html diff --git a/modelarts/api-ref/label_task_management.html b/docs/modelarts/api-ref/label_task_management.html similarity index 100% rename from modelarts/api-ref/label_task_management.html rename to docs/modelarts/api-ref/label_task_management.html diff --git a/modelarts/api-ref/manual_annotation_management.html b/docs/modelarts/api-ref/manual_annotation_management.html similarity index 100% rename from modelarts/api-ref/manual_annotation_management.html rename to docs/modelarts/api-ref/manual_annotation_management.html diff --git a/modelarts/api-ref/modelarts_03_0001.html b/docs/modelarts/api-ref/modelarts_03_0001.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0001.html rename to docs/modelarts/api-ref/modelarts_03_0001.html diff --git a/modelarts/api-ref/modelarts_03_0002.html b/docs/modelarts/api-ref/modelarts_03_0002.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0002.html rename to docs/modelarts/api-ref/modelarts_03_0002.html diff --git a/modelarts/api-ref/modelarts_03_0003.html b/docs/modelarts/api-ref/modelarts_03_0003.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0003.html rename to docs/modelarts/api-ref/modelarts_03_0003.html diff --git a/modelarts/api-ref/modelarts_03_0004.html b/docs/modelarts/api-ref/modelarts_03_0004.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0004.html rename to docs/modelarts/api-ref/modelarts_03_0004.html diff --git a/modelarts/api-ref/modelarts_03_0005.html b/docs/modelarts/api-ref/modelarts_03_0005.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0005.html rename to docs/modelarts/api-ref/modelarts_03_0005.html diff --git a/modelarts/api-ref/modelarts_03_0006.html b/docs/modelarts/api-ref/modelarts_03_0006.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0006.html rename to docs/modelarts/api-ref/modelarts_03_0006.html diff --git a/modelarts/api-ref/modelarts_03_0043.html b/docs/modelarts/api-ref/modelarts_03_0043.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0043.html rename to docs/modelarts/api-ref/modelarts_03_0043.html diff --git a/modelarts/api-ref/modelarts_03_0044.html b/docs/modelarts/api-ref/modelarts_03_0044.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0044.html rename to docs/modelarts/api-ref/modelarts_03_0044.html diff --git a/modelarts/api-ref/modelarts_03_0045.html b/docs/modelarts/api-ref/modelarts_03_0045.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0045.html rename to docs/modelarts/api-ref/modelarts_03_0045.html diff --git a/modelarts/api-ref/modelarts_03_0046.html b/docs/modelarts/api-ref/modelarts_03_0046.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0046.html rename to docs/modelarts/api-ref/modelarts_03_0046.html diff --git a/modelarts/api-ref/modelarts_03_0047.html b/docs/modelarts/api-ref/modelarts_03_0047.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0047.html rename to docs/modelarts/api-ref/modelarts_03_0047.html diff --git a/modelarts/api-ref/modelarts_03_0048.html b/docs/modelarts/api-ref/modelarts_03_0048.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0048.html rename to docs/modelarts/api-ref/modelarts_03_0048.html diff --git a/modelarts/api-ref/modelarts_03_0049.html b/docs/modelarts/api-ref/modelarts_03_0049.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0049.html rename to docs/modelarts/api-ref/modelarts_03_0049.html diff --git a/modelarts/api-ref/modelarts_03_0050.html b/docs/modelarts/api-ref/modelarts_03_0050.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0050.html rename to docs/modelarts/api-ref/modelarts_03_0050.html diff --git a/modelarts/api-ref/modelarts_03_0051.html b/docs/modelarts/api-ref/modelarts_03_0051.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0051.html rename to docs/modelarts/api-ref/modelarts_03_0051.html diff --git a/modelarts/api-ref/modelarts_03_0052.html b/docs/modelarts/api-ref/modelarts_03_0052.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0052.html rename to docs/modelarts/api-ref/modelarts_03_0052.html diff --git a/modelarts/api-ref/modelarts_03_0053.html b/docs/modelarts/api-ref/modelarts_03_0053.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0053.html rename to docs/modelarts/api-ref/modelarts_03_0053.html diff --git a/modelarts/api-ref/modelarts_03_0054.html b/docs/modelarts/api-ref/modelarts_03_0054.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0054.html rename to docs/modelarts/api-ref/modelarts_03_0054.html diff --git a/modelarts/api-ref/modelarts_03_0056.html b/docs/modelarts/api-ref/modelarts_03_0056.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0056.html rename to docs/modelarts/api-ref/modelarts_03_0056.html diff --git a/modelarts/api-ref/modelarts_03_0057.html b/docs/modelarts/api-ref/modelarts_03_0057.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0057.html rename to docs/modelarts/api-ref/modelarts_03_0057.html diff --git a/modelarts/api-ref/modelarts_03_0058.html b/docs/modelarts/api-ref/modelarts_03_0058.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0058.html rename to docs/modelarts/api-ref/modelarts_03_0058.html diff --git a/modelarts/api-ref/modelarts_03_0059.html b/docs/modelarts/api-ref/modelarts_03_0059.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0059.html rename to docs/modelarts/api-ref/modelarts_03_0059.html diff --git a/modelarts/api-ref/modelarts_03_0060.html b/docs/modelarts/api-ref/modelarts_03_0060.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0060.html rename to docs/modelarts/api-ref/modelarts_03_0060.html diff --git a/modelarts/api-ref/modelarts_03_0061.html b/docs/modelarts/api-ref/modelarts_03_0061.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0061.html rename to docs/modelarts/api-ref/modelarts_03_0061.html diff --git a/modelarts/api-ref/modelarts_03_0062.html b/docs/modelarts/api-ref/modelarts_03_0062.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0062.html rename to docs/modelarts/api-ref/modelarts_03_0062.html diff --git a/modelarts/api-ref/modelarts_03_0063.html b/docs/modelarts/api-ref/modelarts_03_0063.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0063.html rename to docs/modelarts/api-ref/modelarts_03_0063.html diff --git a/modelarts/api-ref/modelarts_03_0064.html b/docs/modelarts/api-ref/modelarts_03_0064.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0064.html rename to docs/modelarts/api-ref/modelarts_03_0064.html diff --git a/modelarts/api-ref/modelarts_03_0065.html b/docs/modelarts/api-ref/modelarts_03_0065.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0065.html rename to docs/modelarts/api-ref/modelarts_03_0065.html diff --git a/modelarts/api-ref/modelarts_03_0066.html b/docs/modelarts/api-ref/modelarts_03_0066.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0066.html rename to docs/modelarts/api-ref/modelarts_03_0066.html diff --git a/modelarts/api-ref/modelarts_03_0067.html b/docs/modelarts/api-ref/modelarts_03_0067.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0067.html rename to docs/modelarts/api-ref/modelarts_03_0067.html diff --git a/modelarts/api-ref/modelarts_03_0068.html b/docs/modelarts/api-ref/modelarts_03_0068.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0068.html rename to docs/modelarts/api-ref/modelarts_03_0068.html diff --git a/modelarts/api-ref/modelarts_03_0069.html b/docs/modelarts/api-ref/modelarts_03_0069.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0069.html rename to docs/modelarts/api-ref/modelarts_03_0069.html diff --git a/modelarts/api-ref/modelarts_03_0070.html b/docs/modelarts/api-ref/modelarts_03_0070.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0070.html rename to docs/modelarts/api-ref/modelarts_03_0070.html diff --git a/modelarts/api-ref/modelarts_03_0071.html b/docs/modelarts/api-ref/modelarts_03_0071.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0071.html rename to docs/modelarts/api-ref/modelarts_03_0071.html diff --git a/modelarts/api-ref/modelarts_03_0072.html b/docs/modelarts/api-ref/modelarts_03_0072.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0072.html rename to docs/modelarts/api-ref/modelarts_03_0072.html diff --git a/modelarts/api-ref/modelarts_03_0073.html b/docs/modelarts/api-ref/modelarts_03_0073.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0073.html rename to docs/modelarts/api-ref/modelarts_03_0073.html diff --git a/modelarts/api-ref/modelarts_03_0074.html b/docs/modelarts/api-ref/modelarts_03_0074.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0074.html rename to docs/modelarts/api-ref/modelarts_03_0074.html diff --git a/modelarts/api-ref/modelarts_03_0075.html b/docs/modelarts/api-ref/modelarts_03_0075.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0075.html rename to docs/modelarts/api-ref/modelarts_03_0075.html diff --git a/modelarts/api-ref/modelarts_03_0076.html b/docs/modelarts/api-ref/modelarts_03_0076.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0076.html rename to docs/modelarts/api-ref/modelarts_03_0076.html diff --git a/modelarts/api-ref/modelarts_03_0077.html b/docs/modelarts/api-ref/modelarts_03_0077.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0077.html rename to docs/modelarts/api-ref/modelarts_03_0077.html diff --git a/modelarts/api-ref/modelarts_03_0078.html b/docs/modelarts/api-ref/modelarts_03_0078.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0078.html rename to docs/modelarts/api-ref/modelarts_03_0078.html diff --git a/modelarts/api-ref/modelarts_03_0079.html b/docs/modelarts/api-ref/modelarts_03_0079.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0079.html rename to docs/modelarts/api-ref/modelarts_03_0079.html diff --git a/modelarts/api-ref/modelarts_03_0081.html b/docs/modelarts/api-ref/modelarts_03_0081.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0081.html rename to docs/modelarts/api-ref/modelarts_03_0081.html diff --git a/modelarts/api-ref/modelarts_03_0082.html b/docs/modelarts/api-ref/modelarts_03_0082.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0082.html rename to docs/modelarts/api-ref/modelarts_03_0082.html diff --git a/modelarts/api-ref/modelarts_03_0083.html b/docs/modelarts/api-ref/modelarts_03_0083.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0083.html rename to docs/modelarts/api-ref/modelarts_03_0083.html diff --git a/modelarts/api-ref/modelarts_03_0084.html b/docs/modelarts/api-ref/modelarts_03_0084.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0084.html rename to docs/modelarts/api-ref/modelarts_03_0084.html diff --git a/modelarts/api-ref/modelarts_03_0086.html b/docs/modelarts/api-ref/modelarts_03_0086.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0086.html rename to docs/modelarts/api-ref/modelarts_03_0086.html diff --git a/modelarts/api-ref/modelarts_03_0087.html b/docs/modelarts/api-ref/modelarts_03_0087.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0087.html rename to docs/modelarts/api-ref/modelarts_03_0087.html diff --git a/modelarts/api-ref/modelarts_03_0088.html b/docs/modelarts/api-ref/modelarts_03_0088.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0088.html rename to docs/modelarts/api-ref/modelarts_03_0088.html diff --git a/modelarts/api-ref/modelarts_03_0089.html b/docs/modelarts/api-ref/modelarts_03_0089.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0089.html rename to docs/modelarts/api-ref/modelarts_03_0089.html diff --git a/modelarts/api-ref/modelarts_03_0093.html b/docs/modelarts/api-ref/modelarts_03_0093.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0093.html rename to docs/modelarts/api-ref/modelarts_03_0093.html diff --git a/modelarts/api-ref/modelarts_03_0094.html b/docs/modelarts/api-ref/modelarts_03_0094.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0094.html rename to docs/modelarts/api-ref/modelarts_03_0094.html diff --git a/modelarts/api-ref/modelarts_03_0095.html b/docs/modelarts/api-ref/modelarts_03_0095.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0095.html rename to docs/modelarts/api-ref/modelarts_03_0095.html diff --git a/modelarts/api-ref/modelarts_03_0097.html b/docs/modelarts/api-ref/modelarts_03_0097.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0097.html rename to docs/modelarts/api-ref/modelarts_03_0097.html diff --git a/modelarts/api-ref/modelarts_03_0108.html b/docs/modelarts/api-ref/modelarts_03_0108.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0108.html rename to docs/modelarts/api-ref/modelarts_03_0108.html diff --git a/modelarts/api-ref/modelarts_03_0109.html b/docs/modelarts/api-ref/modelarts_03_0109.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0109.html rename to docs/modelarts/api-ref/modelarts_03_0109.html diff --git a/modelarts/api-ref/modelarts_03_0110.html b/docs/modelarts/api-ref/modelarts_03_0110.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0110.html rename to docs/modelarts/api-ref/modelarts_03_0110.html diff --git a/modelarts/api-ref/modelarts_03_0111.html b/docs/modelarts/api-ref/modelarts_03_0111.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0111.html rename to docs/modelarts/api-ref/modelarts_03_0111.html diff --git a/modelarts/api-ref/modelarts_03_0112.html b/docs/modelarts/api-ref/modelarts_03_0112.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0112.html rename to docs/modelarts/api-ref/modelarts_03_0112.html diff --git a/modelarts/api-ref/modelarts_03_0113.html b/docs/modelarts/api-ref/modelarts_03_0113.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0113.html rename to docs/modelarts/api-ref/modelarts_03_0113.html diff --git a/modelarts/api-ref/modelarts_03_0114.html b/docs/modelarts/api-ref/modelarts_03_0114.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0114.html rename to docs/modelarts/api-ref/modelarts_03_0114.html diff --git a/modelarts/api-ref/modelarts_03_0115.html b/docs/modelarts/api-ref/modelarts_03_0115.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0115.html rename to docs/modelarts/api-ref/modelarts_03_0115.html diff --git a/modelarts/api-ref/modelarts_03_0139.html b/docs/modelarts/api-ref/modelarts_03_0139.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0139.html rename to docs/modelarts/api-ref/modelarts_03_0139.html diff --git a/modelarts/api-ref/modelarts_03_0140.html b/docs/modelarts/api-ref/modelarts_03_0140.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0140.html rename to docs/modelarts/api-ref/modelarts_03_0140.html diff --git a/modelarts/api-ref/modelarts_03_0141.html b/docs/modelarts/api-ref/modelarts_03_0141.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0141.html rename to docs/modelarts/api-ref/modelarts_03_0141.html diff --git a/modelarts/api-ref/modelarts_03_0143.html b/docs/modelarts/api-ref/modelarts_03_0143.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0143.html rename to docs/modelarts/api-ref/modelarts_03_0143.html diff --git a/modelarts/api-ref/modelarts_03_0144.html b/docs/modelarts/api-ref/modelarts_03_0144.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0144.html rename to docs/modelarts/api-ref/modelarts_03_0144.html diff --git a/modelarts/api-ref/modelarts_03_0147.html b/docs/modelarts/api-ref/modelarts_03_0147.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0147.html rename to docs/modelarts/api-ref/modelarts_03_0147.html diff --git a/modelarts/api-ref/modelarts_03_0148.html b/docs/modelarts/api-ref/modelarts_03_0148.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0148.html rename to docs/modelarts/api-ref/modelarts_03_0148.html diff --git a/modelarts/api-ref/modelarts_03_0149.html b/docs/modelarts/api-ref/modelarts_03_0149.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0149.html rename to docs/modelarts/api-ref/modelarts_03_0149.html diff --git a/modelarts/api-ref/modelarts_03_0150.html b/docs/modelarts/api-ref/modelarts_03_0150.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0150.html rename to docs/modelarts/api-ref/modelarts_03_0150.html diff --git a/modelarts/api-ref/modelarts_03_0151.html b/docs/modelarts/api-ref/modelarts_03_0151.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0151.html rename to docs/modelarts/api-ref/modelarts_03_0151.html diff --git a/modelarts/api-ref/modelarts_03_0152.html b/docs/modelarts/api-ref/modelarts_03_0152.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0152.html rename to docs/modelarts/api-ref/modelarts_03_0152.html diff --git a/modelarts/api-ref/modelarts_03_0153.html b/docs/modelarts/api-ref/modelarts_03_0153.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0153.html rename to docs/modelarts/api-ref/modelarts_03_0153.html diff --git a/modelarts/api-ref/modelarts_03_0155.html b/docs/modelarts/api-ref/modelarts_03_0155.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0155.html rename to docs/modelarts/api-ref/modelarts_03_0155.html diff --git a/modelarts/api-ref/modelarts_03_0200.html b/docs/modelarts/api-ref/modelarts_03_0200.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0200.html rename to docs/modelarts/api-ref/modelarts_03_0200.html diff --git a/modelarts/api-ref/modelarts_03_0202.html b/docs/modelarts/api-ref/modelarts_03_0202.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0202.html rename to docs/modelarts/api-ref/modelarts_03_0202.html diff --git a/modelarts/api-ref/modelarts_03_0299.html b/docs/modelarts/api-ref/modelarts_03_0299.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0299.html rename to docs/modelarts/api-ref/modelarts_03_0299.html diff --git a/modelarts/api-ref/modelarts_03_0400.html b/docs/modelarts/api-ref/modelarts_03_0400.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0400.html rename to docs/modelarts/api-ref/modelarts_03_0400.html diff --git a/modelarts/api-ref/modelarts_03_0401.html b/docs/modelarts/api-ref/modelarts_03_0401.html similarity index 100% rename from modelarts/api-ref/modelarts_03_0401.html rename to docs/modelarts/api-ref/modelarts_03_0401.html diff --git a/modelarts/api-ref/process_task.html b/docs/modelarts/api-ref/process_task.html similarity index 100% rename from modelarts/api-ref/process_task.html rename to docs/modelarts/api-ref/process_task.html diff --git a/modelarts/api-ref/sample_management.html b/docs/modelarts/api-ref/sample_management.html similarity index 100% rename from modelarts/api-ref/sample_management.html rename to docs/modelarts/api-ref/sample_management.html diff --git a/modelarts/api-ref/workforce_management.html b/docs/modelarts/api-ref/workforce_management.html similarity index 100% rename from modelarts/api-ref/workforce_management.html rename to docs/modelarts/api-ref/workforce_management.html diff --git a/modelarts/api-ref/workforce_process_management.html b/docs/modelarts/api-ref/workforce_process_management.html similarity index 100% rename from modelarts/api-ref/workforce_process_management.html rename to docs/modelarts/api-ref/workforce_process_management.html diff --git a/modelarts/api-ref/workforce_worker_management.html b/docs/modelarts/api-ref/workforce_worker_management.html similarity index 100% rename from modelarts/api-ref/workforce_worker_management.html rename to docs/modelarts/api-ref/workforce_worker_management.html diff --git a/modelarts/api-ref/workspace.html b/docs/modelarts/api-ref/workspace.html similarity index 100% rename from modelarts/api-ref/workspace.html rename to docs/modelarts/api-ref/workspace.html diff --git a/modelarts/umn/ALL_META.TXT.json b/docs/modelarts/umn/ALL_META.TXT.json similarity index 100% rename from modelarts/umn/ALL_META.TXT.json rename to docs/modelarts/umn/ALL_META.TXT.json diff --git a/modelarts/umn/CLASS.TXT.json b/docs/modelarts/umn/CLASS.TXT.json similarity index 100% rename from modelarts/umn/CLASS.TXT.json rename to docs/modelarts/umn/CLASS.TXT.json diff --git a/modelarts/umn/PARAMETERS.txt b/docs/modelarts/umn/PARAMETERS.txt similarity index 100% rename from modelarts/umn/PARAMETERS.txt rename to docs/modelarts/umn/PARAMETERS.txt diff --git a/modelarts/umn/en-us_image_0000001110760906.png b/docs/modelarts/umn/en-us_image_0000001110760906.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760906.png rename to docs/modelarts/umn/en-us_image_0000001110760906.png diff --git a/modelarts/umn/en-us_image_0000001110760908.png b/docs/modelarts/umn/en-us_image_0000001110760908.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760908.png rename to docs/modelarts/umn/en-us_image_0000001110760908.png diff --git a/modelarts/umn/en-us_image_0000001110760910.png b/docs/modelarts/umn/en-us_image_0000001110760910.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760910.png rename to docs/modelarts/umn/en-us_image_0000001110760910.png diff --git a/modelarts/umn/en-us_image_0000001110760912.png b/docs/modelarts/umn/en-us_image_0000001110760912.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760912.png rename to docs/modelarts/umn/en-us_image_0000001110760912.png diff --git a/modelarts/umn/en-us_image_0000001110760934.png b/docs/modelarts/umn/en-us_image_0000001110760934.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760934.png rename to docs/modelarts/umn/en-us_image_0000001110760934.png diff --git a/modelarts/umn/en-us_image_0000001110760936.png b/docs/modelarts/umn/en-us_image_0000001110760936.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760936.png rename to docs/modelarts/umn/en-us_image_0000001110760936.png diff --git a/modelarts/umn/en-us_image_0000001110760956.png b/docs/modelarts/umn/en-us_image_0000001110760956.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760956.png rename to docs/modelarts/umn/en-us_image_0000001110760956.png diff --git a/modelarts/umn/en-us_image_0000001110760968.png b/docs/modelarts/umn/en-us_image_0000001110760968.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760968.png rename to docs/modelarts/umn/en-us_image_0000001110760968.png diff --git a/modelarts/umn/en-us_image_0000001110760970.png b/docs/modelarts/umn/en-us_image_0000001110760970.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110760970.png rename to docs/modelarts/umn/en-us_image_0000001110760970.png diff --git a/modelarts/umn/en-us_image_0000001110761010.png b/docs/modelarts/umn/en-us_image_0000001110761010.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761010.png rename to docs/modelarts/umn/en-us_image_0000001110761010.png diff --git a/modelarts/umn/en-us_image_0000001110761012.png b/docs/modelarts/umn/en-us_image_0000001110761012.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761012.png rename to docs/modelarts/umn/en-us_image_0000001110761012.png diff --git a/modelarts/umn/en-us_image_0000001110761016.png b/docs/modelarts/umn/en-us_image_0000001110761016.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761016.png rename to docs/modelarts/umn/en-us_image_0000001110761016.png diff --git a/modelarts/umn/en-us_image_0000001110761018.png b/docs/modelarts/umn/en-us_image_0000001110761018.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761018.png rename to docs/modelarts/umn/en-us_image_0000001110761018.png diff --git a/modelarts/umn/en-us_image_0000001110761020.png b/docs/modelarts/umn/en-us_image_0000001110761020.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761020.png rename to docs/modelarts/umn/en-us_image_0000001110761020.png diff --git a/modelarts/umn/en-us_image_0000001110761034.png b/docs/modelarts/umn/en-us_image_0000001110761034.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761034.png rename to docs/modelarts/umn/en-us_image_0000001110761034.png diff --git a/modelarts/umn/en-us_image_0000001110761038.png b/docs/modelarts/umn/en-us_image_0000001110761038.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761038.png rename to docs/modelarts/umn/en-us_image_0000001110761038.png diff --git a/modelarts/umn/en-us_image_0000001110761044.png b/docs/modelarts/umn/en-us_image_0000001110761044.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761044.png rename to docs/modelarts/umn/en-us_image_0000001110761044.png diff --git a/modelarts/umn/en-us_image_0000001110761054.png b/docs/modelarts/umn/en-us_image_0000001110761054.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761054.png rename to docs/modelarts/umn/en-us_image_0000001110761054.png diff --git a/modelarts/umn/en-us_image_0000001110761058.png b/docs/modelarts/umn/en-us_image_0000001110761058.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761058.png rename to docs/modelarts/umn/en-us_image_0000001110761058.png diff --git a/modelarts/umn/en-us_image_0000001110761062.png b/docs/modelarts/umn/en-us_image_0000001110761062.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761062.png rename to docs/modelarts/umn/en-us_image_0000001110761062.png diff --git a/modelarts/umn/en-us_image_0000001110761072.png b/docs/modelarts/umn/en-us_image_0000001110761072.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761072.png rename to docs/modelarts/umn/en-us_image_0000001110761072.png diff --git a/modelarts/umn/en-us_image_0000001110761074.png b/docs/modelarts/umn/en-us_image_0000001110761074.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761074.png rename to docs/modelarts/umn/en-us_image_0000001110761074.png diff --git a/modelarts/umn/en-us_image_0000001110761076.png b/docs/modelarts/umn/en-us_image_0000001110761076.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761076.png rename to docs/modelarts/umn/en-us_image_0000001110761076.png diff --git a/modelarts/umn/en-us_image_0000001110761078.png b/docs/modelarts/umn/en-us_image_0000001110761078.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761078.png rename to docs/modelarts/umn/en-us_image_0000001110761078.png diff --git a/modelarts/umn/en-us_image_0000001110761080.png b/docs/modelarts/umn/en-us_image_0000001110761080.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761080.png rename to docs/modelarts/umn/en-us_image_0000001110761080.png diff --git a/modelarts/umn/en-us_image_0000001110761082.png b/docs/modelarts/umn/en-us_image_0000001110761082.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761082.png rename to docs/modelarts/umn/en-us_image_0000001110761082.png diff --git a/modelarts/umn/en-us_image_0000001110761086.gif b/docs/modelarts/umn/en-us_image_0000001110761086.gif similarity index 100% rename from modelarts/umn/en-us_image_0000001110761086.gif rename to docs/modelarts/umn/en-us_image_0000001110761086.gif diff --git a/modelarts/umn/en-us_image_0000001110761088.png b/docs/modelarts/umn/en-us_image_0000001110761088.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761088.png rename to docs/modelarts/umn/en-us_image_0000001110761088.png diff --git a/modelarts/umn/en-us_image_0000001110761092.png b/docs/modelarts/umn/en-us_image_0000001110761092.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761092.png rename to docs/modelarts/umn/en-us_image_0000001110761092.png diff --git a/modelarts/umn/en-us_image_0000001110761098.png b/docs/modelarts/umn/en-us_image_0000001110761098.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761098.png rename to docs/modelarts/umn/en-us_image_0000001110761098.png diff --git a/modelarts/umn/en-us_image_0000001110761112.png b/docs/modelarts/umn/en-us_image_0000001110761112.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761112.png rename to docs/modelarts/umn/en-us_image_0000001110761112.png diff --git a/modelarts/umn/en-us_image_0000001110761148.png b/docs/modelarts/umn/en-us_image_0000001110761148.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761148.png rename to docs/modelarts/umn/en-us_image_0000001110761148.png diff --git a/modelarts/umn/en-us_image_0000001110761158.png b/docs/modelarts/umn/en-us_image_0000001110761158.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761158.png rename to docs/modelarts/umn/en-us_image_0000001110761158.png diff --git a/modelarts/umn/en-us_image_0000001110761582.png b/docs/modelarts/umn/en-us_image_0000001110761582.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110761582.png rename to docs/modelarts/umn/en-us_image_0000001110761582.png diff --git a/modelarts/umn/en-us_image_0000001110920802.png b/docs/modelarts/umn/en-us_image_0000001110920802.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920802.png rename to docs/modelarts/umn/en-us_image_0000001110920802.png diff --git a/modelarts/umn/en-us_image_0000001110920824.png b/docs/modelarts/umn/en-us_image_0000001110920824.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920824.png rename to docs/modelarts/umn/en-us_image_0000001110920824.png diff --git a/modelarts/umn/en-us_image_0000001110920858.png b/docs/modelarts/umn/en-us_image_0000001110920858.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920858.png rename to docs/modelarts/umn/en-us_image_0000001110920858.png diff --git a/modelarts/umn/en-us_image_0000001110920874.png b/docs/modelarts/umn/en-us_image_0000001110920874.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920874.png rename to docs/modelarts/umn/en-us_image_0000001110920874.png diff --git a/modelarts/umn/en-us_image_0000001110920880.png b/docs/modelarts/umn/en-us_image_0000001110920880.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920880.png rename to docs/modelarts/umn/en-us_image_0000001110920880.png diff --git a/modelarts/umn/en-us_image_0000001110920910.png b/docs/modelarts/umn/en-us_image_0000001110920910.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920910.png rename to docs/modelarts/umn/en-us_image_0000001110920910.png diff --git a/modelarts/umn/en-us_image_0000001110920912.png b/docs/modelarts/umn/en-us_image_0000001110920912.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920912.png rename to docs/modelarts/umn/en-us_image_0000001110920912.png diff --git a/modelarts/umn/en-us_image_0000001110920914.png b/docs/modelarts/umn/en-us_image_0000001110920914.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920914.png rename to docs/modelarts/umn/en-us_image_0000001110920914.png diff --git a/modelarts/umn/en-us_image_0000001110920916.png b/docs/modelarts/umn/en-us_image_0000001110920916.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920916.png rename to docs/modelarts/umn/en-us_image_0000001110920916.png diff --git a/modelarts/umn/en-us_image_0000001110920918.png b/docs/modelarts/umn/en-us_image_0000001110920918.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920918.png rename to docs/modelarts/umn/en-us_image_0000001110920918.png diff --git a/modelarts/umn/en-us_image_0000001110920920.png b/docs/modelarts/umn/en-us_image_0000001110920920.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920920.png rename to docs/modelarts/umn/en-us_image_0000001110920920.png diff --git a/modelarts/umn/en-us_image_0000001110920924.png b/docs/modelarts/umn/en-us_image_0000001110920924.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920924.png rename to docs/modelarts/umn/en-us_image_0000001110920924.png diff --git a/modelarts/umn/en-us_image_0000001110920930.png b/docs/modelarts/umn/en-us_image_0000001110920930.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920930.png rename to docs/modelarts/umn/en-us_image_0000001110920930.png diff --git a/modelarts/umn/en-us_image_0000001110920934.png b/docs/modelarts/umn/en-us_image_0000001110920934.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920934.png rename to docs/modelarts/umn/en-us_image_0000001110920934.png diff --git a/modelarts/umn/en-us_image_0000001110920936.png b/docs/modelarts/umn/en-us_image_0000001110920936.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920936.png rename to docs/modelarts/umn/en-us_image_0000001110920936.png diff --git a/modelarts/umn/en-us_image_0000001110920938.png b/docs/modelarts/umn/en-us_image_0000001110920938.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920938.png rename to docs/modelarts/umn/en-us_image_0000001110920938.png diff --git a/modelarts/umn/en-us_image_0000001110920940.png b/docs/modelarts/umn/en-us_image_0000001110920940.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920940.png rename to docs/modelarts/umn/en-us_image_0000001110920940.png diff --git a/modelarts/umn/en-us_image_0000001110920960.png b/docs/modelarts/umn/en-us_image_0000001110920960.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920960.png rename to docs/modelarts/umn/en-us_image_0000001110920960.png diff --git a/modelarts/umn/en-us_image_0000001110920962.png b/docs/modelarts/umn/en-us_image_0000001110920962.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920962.png rename to docs/modelarts/umn/en-us_image_0000001110920962.png diff --git a/modelarts/umn/en-us_image_0000001110920964.png b/docs/modelarts/umn/en-us_image_0000001110920964.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920964.png rename to docs/modelarts/umn/en-us_image_0000001110920964.png diff --git a/modelarts/umn/en-us_image_0000001110920974.png b/docs/modelarts/umn/en-us_image_0000001110920974.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920974.png rename to docs/modelarts/umn/en-us_image_0000001110920974.png diff --git a/modelarts/umn/en-us_image_0000001110920976.png b/docs/modelarts/umn/en-us_image_0000001110920976.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920976.png rename to docs/modelarts/umn/en-us_image_0000001110920976.png diff --git a/modelarts/umn/en-us_image_0000001110920978.png b/docs/modelarts/umn/en-us_image_0000001110920978.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920978.png rename to docs/modelarts/umn/en-us_image_0000001110920978.png diff --git a/modelarts/umn/en-us_image_0000001110920980.png b/docs/modelarts/umn/en-us_image_0000001110920980.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920980.png rename to docs/modelarts/umn/en-us_image_0000001110920980.png diff --git a/modelarts/umn/en-us_image_0000001110920982.png b/docs/modelarts/umn/en-us_image_0000001110920982.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920982.png rename to docs/modelarts/umn/en-us_image_0000001110920982.png diff --git a/modelarts/umn/en-us_image_0000001110920984.png b/docs/modelarts/umn/en-us_image_0000001110920984.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920984.png rename to docs/modelarts/umn/en-us_image_0000001110920984.png diff --git a/modelarts/umn/en-us_image_0000001110920986.png b/docs/modelarts/umn/en-us_image_0000001110920986.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920986.png rename to docs/modelarts/umn/en-us_image_0000001110920986.png diff --git a/modelarts/umn/en-us_image_0000001110920992.png b/docs/modelarts/umn/en-us_image_0000001110920992.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920992.png rename to docs/modelarts/umn/en-us_image_0000001110920992.png diff --git a/modelarts/umn/en-us_image_0000001110920994.png b/docs/modelarts/umn/en-us_image_0000001110920994.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920994.png rename to docs/modelarts/umn/en-us_image_0000001110920994.png diff --git a/modelarts/umn/en-us_image_0000001110920996.png b/docs/modelarts/umn/en-us_image_0000001110920996.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920996.png rename to docs/modelarts/umn/en-us_image_0000001110920996.png diff --git a/modelarts/umn/en-us_image_0000001110920998.png b/docs/modelarts/umn/en-us_image_0000001110920998.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110920998.png rename to docs/modelarts/umn/en-us_image_0000001110920998.png diff --git a/modelarts/umn/en-us_image_0000001110921000.png b/docs/modelarts/umn/en-us_image_0000001110921000.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110921000.png rename to docs/modelarts/umn/en-us_image_0000001110921000.png diff --git a/modelarts/umn/en-us_image_0000001110921004.png b/docs/modelarts/umn/en-us_image_0000001110921004.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110921004.png rename to docs/modelarts/umn/en-us_image_0000001110921004.png diff --git a/modelarts/umn/en-us_image_0000001110921012.png b/docs/modelarts/umn/en-us_image_0000001110921012.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110921012.png rename to docs/modelarts/umn/en-us_image_0000001110921012.png diff --git a/modelarts/umn/en-us_image_0000001110921016.png b/docs/modelarts/umn/en-us_image_0000001110921016.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110921016.png rename to docs/modelarts/umn/en-us_image_0000001110921016.png diff --git a/modelarts/umn/en-us_image_0000001110921482.png b/docs/modelarts/umn/en-us_image_0000001110921482.png similarity index 100% rename from modelarts/umn/en-us_image_0000001110921482.png rename to docs/modelarts/umn/en-us_image_0000001110921482.png diff --git a/modelarts/umn/en-us_image_0000001156920767.png b/docs/modelarts/umn/en-us_image_0000001156920767.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920767.png rename to docs/modelarts/umn/en-us_image_0000001156920767.png diff --git a/modelarts/umn/en-us_image_0000001156920769.png b/docs/modelarts/umn/en-us_image_0000001156920769.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920769.png rename to docs/modelarts/umn/en-us_image_0000001156920769.png diff --git a/modelarts/umn/en-us_image_0000001156920823.png b/docs/modelarts/umn/en-us_image_0000001156920823.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920823.png rename to docs/modelarts/umn/en-us_image_0000001156920823.png diff --git a/modelarts/umn/en-us_image_0000001156920845.png b/docs/modelarts/umn/en-us_image_0000001156920845.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920845.png rename to docs/modelarts/umn/en-us_image_0000001156920845.png diff --git a/modelarts/umn/en-us_image_0000001156920871.png b/docs/modelarts/umn/en-us_image_0000001156920871.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920871.png rename to docs/modelarts/umn/en-us_image_0000001156920871.png diff --git a/modelarts/umn/en-us_image_0000001156920885.png b/docs/modelarts/umn/en-us_image_0000001156920885.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920885.png rename to docs/modelarts/umn/en-us_image_0000001156920885.png diff --git a/modelarts/umn/en-us_image_0000001156920887.png b/docs/modelarts/umn/en-us_image_0000001156920887.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920887.png rename to docs/modelarts/umn/en-us_image_0000001156920887.png diff --git a/modelarts/umn/en-us_image_0000001156920893.png b/docs/modelarts/umn/en-us_image_0000001156920893.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920893.png rename to docs/modelarts/umn/en-us_image_0000001156920893.png diff --git a/modelarts/umn/en-us_image_0000001156920897.png b/docs/modelarts/umn/en-us_image_0000001156920897.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920897.png rename to docs/modelarts/umn/en-us_image_0000001156920897.png diff --git a/modelarts/umn/en-us_image_0000001156920899.png b/docs/modelarts/umn/en-us_image_0000001156920899.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920899.png rename to docs/modelarts/umn/en-us_image_0000001156920899.png diff --git a/modelarts/umn/en-us_image_0000001156920901.png b/docs/modelarts/umn/en-us_image_0000001156920901.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920901.png rename to docs/modelarts/umn/en-us_image_0000001156920901.png diff --git a/modelarts/umn/en-us_image_0000001156920903.png b/docs/modelarts/umn/en-us_image_0000001156920903.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920903.png rename to docs/modelarts/umn/en-us_image_0000001156920903.png diff --git a/modelarts/umn/en-us_image_0000001156920919.png b/docs/modelarts/umn/en-us_image_0000001156920919.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920919.png rename to docs/modelarts/umn/en-us_image_0000001156920919.png diff --git a/modelarts/umn/en-us_image_0000001156920929.png b/docs/modelarts/umn/en-us_image_0000001156920929.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920929.png rename to docs/modelarts/umn/en-us_image_0000001156920929.png diff --git a/modelarts/umn/en-us_image_0000001156920931.png b/docs/modelarts/umn/en-us_image_0000001156920931.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920931.png rename to docs/modelarts/umn/en-us_image_0000001156920931.png diff --git a/modelarts/umn/en-us_image_0000001156920933.png b/docs/modelarts/umn/en-us_image_0000001156920933.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920933.png rename to docs/modelarts/umn/en-us_image_0000001156920933.png diff --git a/modelarts/umn/en-us_image_0000001156920935.png b/docs/modelarts/umn/en-us_image_0000001156920935.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920935.png rename to docs/modelarts/umn/en-us_image_0000001156920935.png diff --git a/modelarts/umn/en-us_image_0000001156920939.png b/docs/modelarts/umn/en-us_image_0000001156920939.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920939.png rename to docs/modelarts/umn/en-us_image_0000001156920939.png diff --git a/modelarts/umn/en-us_image_0000001156920943.png b/docs/modelarts/umn/en-us_image_0000001156920943.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920943.png rename to docs/modelarts/umn/en-us_image_0000001156920943.png diff --git a/modelarts/umn/en-us_image_0000001156920951.png b/docs/modelarts/umn/en-us_image_0000001156920951.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920951.png rename to docs/modelarts/umn/en-us_image_0000001156920951.png diff --git a/modelarts/umn/en-us_image_0000001156920955.gif b/docs/modelarts/umn/en-us_image_0000001156920955.gif similarity index 100% rename from modelarts/umn/en-us_image_0000001156920955.gif rename to docs/modelarts/umn/en-us_image_0000001156920955.gif diff --git a/modelarts/umn/en-us_image_0000001156920959.png b/docs/modelarts/umn/en-us_image_0000001156920959.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920959.png rename to docs/modelarts/umn/en-us_image_0000001156920959.png diff --git a/modelarts/umn/en-us_image_0000001156920961.png b/docs/modelarts/umn/en-us_image_0000001156920961.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920961.png rename to docs/modelarts/umn/en-us_image_0000001156920961.png diff --git a/modelarts/umn/en-us_image_0000001156920965.png b/docs/modelarts/umn/en-us_image_0000001156920965.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920965.png rename to docs/modelarts/umn/en-us_image_0000001156920965.png diff --git a/modelarts/umn/en-us_image_0000001156920967.png b/docs/modelarts/umn/en-us_image_0000001156920967.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920967.png rename to docs/modelarts/umn/en-us_image_0000001156920967.png diff --git a/modelarts/umn/en-us_image_0000001156920969.png b/docs/modelarts/umn/en-us_image_0000001156920969.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920969.png rename to docs/modelarts/umn/en-us_image_0000001156920969.png diff --git a/modelarts/umn/en-us_image_0000001156920971.png b/docs/modelarts/umn/en-us_image_0000001156920971.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920971.png rename to docs/modelarts/umn/en-us_image_0000001156920971.png diff --git a/modelarts/umn/en-us_image_0000001156920973.png b/docs/modelarts/umn/en-us_image_0000001156920973.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920973.png rename to docs/modelarts/umn/en-us_image_0000001156920973.png diff --git a/modelarts/umn/en-us_image_0000001156920981.png b/docs/modelarts/umn/en-us_image_0000001156920981.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920981.png rename to docs/modelarts/umn/en-us_image_0000001156920981.png diff --git a/modelarts/umn/en-us_image_0000001156920983.png b/docs/modelarts/umn/en-us_image_0000001156920983.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920983.png rename to docs/modelarts/umn/en-us_image_0000001156920983.png diff --git a/modelarts/umn/en-us_image_0000001156920985.png b/docs/modelarts/umn/en-us_image_0000001156920985.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920985.png rename to docs/modelarts/umn/en-us_image_0000001156920985.png diff --git a/modelarts/umn/en-us_image_0000001156920989.png b/docs/modelarts/umn/en-us_image_0000001156920989.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156920989.png rename to docs/modelarts/umn/en-us_image_0000001156920989.png diff --git a/modelarts/umn/en-us_image_0000001156921011.png b/docs/modelarts/umn/en-us_image_0000001156921011.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156921011.png rename to docs/modelarts/umn/en-us_image_0000001156921011.png diff --git a/modelarts/umn/en-us_image_0000001156921015.png b/docs/modelarts/umn/en-us_image_0000001156921015.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156921015.png rename to docs/modelarts/umn/en-us_image_0000001156921015.png diff --git a/modelarts/umn/en-us_image_0000001156921017.png b/docs/modelarts/umn/en-us_image_0000001156921017.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156921017.png rename to docs/modelarts/umn/en-us_image_0000001156921017.png diff --git a/modelarts/umn/en-us_image_0000001156921451.png b/docs/modelarts/umn/en-us_image_0000001156921451.png similarity index 100% rename from modelarts/umn/en-us_image_0000001156921451.png rename to docs/modelarts/umn/en-us_image_0000001156921451.png diff --git a/modelarts/umn/en-us_image_0000001157080759.png b/docs/modelarts/umn/en-us_image_0000001157080759.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080759.png rename to docs/modelarts/umn/en-us_image_0000001157080759.png diff --git a/modelarts/umn/en-us_image_0000001157080805.png b/docs/modelarts/umn/en-us_image_0000001157080805.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080805.png rename to docs/modelarts/umn/en-us_image_0000001157080805.png diff --git a/modelarts/umn/en-us_image_0000001157080847.png b/docs/modelarts/umn/en-us_image_0000001157080847.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080847.png rename to docs/modelarts/umn/en-us_image_0000001157080847.png diff --git a/modelarts/umn/en-us_image_0000001157080853.png b/docs/modelarts/umn/en-us_image_0000001157080853.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080853.png rename to docs/modelarts/umn/en-us_image_0000001157080853.png diff --git a/modelarts/umn/en-us_image_0000001157080859.png b/docs/modelarts/umn/en-us_image_0000001157080859.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080859.png rename to docs/modelarts/umn/en-us_image_0000001157080859.png diff --git a/modelarts/umn/en-us_image_0000001157080869.png b/docs/modelarts/umn/en-us_image_0000001157080869.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080869.png rename to docs/modelarts/umn/en-us_image_0000001157080869.png diff --git a/modelarts/umn/en-us_image_0000001157080871.png b/docs/modelarts/umn/en-us_image_0000001157080871.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080871.png rename to docs/modelarts/umn/en-us_image_0000001157080871.png diff --git a/modelarts/umn/en-us_image_0000001157080873.png b/docs/modelarts/umn/en-us_image_0000001157080873.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080873.png rename to docs/modelarts/umn/en-us_image_0000001157080873.png diff --git a/modelarts/umn/en-us_image_0000001157080875.png b/docs/modelarts/umn/en-us_image_0000001157080875.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080875.png rename to docs/modelarts/umn/en-us_image_0000001157080875.png diff --git a/modelarts/umn/en-us_image_0000001157080879.png b/docs/modelarts/umn/en-us_image_0000001157080879.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080879.png rename to docs/modelarts/umn/en-us_image_0000001157080879.png diff --git a/modelarts/umn/en-us_image_0000001157080885.png b/docs/modelarts/umn/en-us_image_0000001157080885.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080885.png rename to docs/modelarts/umn/en-us_image_0000001157080885.png diff --git a/modelarts/umn/en-us_image_0000001157080893.png b/docs/modelarts/umn/en-us_image_0000001157080893.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080893.png rename to docs/modelarts/umn/en-us_image_0000001157080893.png diff --git a/modelarts/umn/en-us_image_0000001157080895.png b/docs/modelarts/umn/en-us_image_0000001157080895.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080895.png rename to docs/modelarts/umn/en-us_image_0000001157080895.png diff --git a/modelarts/umn/en-us_image_0000001157080897.png b/docs/modelarts/umn/en-us_image_0000001157080897.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080897.png rename to docs/modelarts/umn/en-us_image_0000001157080897.png diff --git a/modelarts/umn/en-us_image_0000001157080899.png b/docs/modelarts/umn/en-us_image_0000001157080899.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080899.png rename to docs/modelarts/umn/en-us_image_0000001157080899.png diff --git a/modelarts/umn/en-us_image_0000001157080903.png b/docs/modelarts/umn/en-us_image_0000001157080903.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080903.png rename to docs/modelarts/umn/en-us_image_0000001157080903.png diff --git a/modelarts/umn/en-us_image_0000001157080905.png b/docs/modelarts/umn/en-us_image_0000001157080905.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080905.png rename to docs/modelarts/umn/en-us_image_0000001157080905.png diff --git a/modelarts/umn/en-us_image_0000001157080907.png b/docs/modelarts/umn/en-us_image_0000001157080907.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080907.png rename to docs/modelarts/umn/en-us_image_0000001157080907.png diff --git a/modelarts/umn/en-us_image_0000001157080911.png b/docs/modelarts/umn/en-us_image_0000001157080911.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080911.png rename to docs/modelarts/umn/en-us_image_0000001157080911.png diff --git a/modelarts/umn/en-us_image_0000001157080919.png b/docs/modelarts/umn/en-us_image_0000001157080919.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080919.png rename to docs/modelarts/umn/en-us_image_0000001157080919.png diff --git a/modelarts/umn/en-us_image_0000001157080923.png b/docs/modelarts/umn/en-us_image_0000001157080923.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080923.png rename to docs/modelarts/umn/en-us_image_0000001157080923.png diff --git a/modelarts/umn/en-us_image_0000001157080931.png b/docs/modelarts/umn/en-us_image_0000001157080931.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080931.png rename to docs/modelarts/umn/en-us_image_0000001157080931.png diff --git a/modelarts/umn/en-us_image_0000001157080933.png b/docs/modelarts/umn/en-us_image_0000001157080933.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080933.png rename to docs/modelarts/umn/en-us_image_0000001157080933.png diff --git a/modelarts/umn/en-us_image_0000001157080935.png b/docs/modelarts/umn/en-us_image_0000001157080935.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080935.png rename to docs/modelarts/umn/en-us_image_0000001157080935.png diff --git a/modelarts/umn/en-us_image_0000001157080965.png b/docs/modelarts/umn/en-us_image_0000001157080965.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080965.png rename to docs/modelarts/umn/en-us_image_0000001157080965.png diff --git a/modelarts/umn/en-us_image_0000001157080983.png b/docs/modelarts/umn/en-us_image_0000001157080983.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157080983.png rename to docs/modelarts/umn/en-us_image_0000001157080983.png diff --git a/modelarts/umn/en-us_image_0000001157081001.png b/docs/modelarts/umn/en-us_image_0000001157081001.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157081001.png rename to docs/modelarts/umn/en-us_image_0000001157081001.png diff --git a/modelarts/umn/en-us_image_0000001157081003.png b/docs/modelarts/umn/en-us_image_0000001157081003.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157081003.png rename to docs/modelarts/umn/en-us_image_0000001157081003.png diff --git a/modelarts/umn/en-us_image_0000001157081267.png b/docs/modelarts/umn/en-us_image_0000001157081267.png similarity index 100% rename from modelarts/umn/en-us_image_0000001157081267.png rename to docs/modelarts/umn/en-us_image_0000001157081267.png diff --git a/modelarts/umn/en-us_image_0000001214778791.png b/docs/modelarts/umn/en-us_image_0000001214778791.png similarity index 100% rename from modelarts/umn/en-us_image_0000001214778791.png rename to docs/modelarts/umn/en-us_image_0000001214778791.png diff --git a/modelarts/umn/modelarts_01_0000.html b/docs/modelarts/umn/modelarts_01_0000.html similarity index 100% rename from modelarts/umn/modelarts_01_0000.html rename to docs/modelarts/umn/modelarts_01_0000.html diff --git a/modelarts/umn/modelarts_01_0001.html b/docs/modelarts/umn/modelarts_01_0001.html similarity index 100% rename from modelarts/umn/modelarts_01_0001.html rename to docs/modelarts/umn/modelarts_01_0001.html diff --git a/modelarts/umn/modelarts_01_0003.html b/docs/modelarts/umn/modelarts_01_0003.html similarity index 100% rename from modelarts/umn/modelarts_01_0003.html rename to docs/modelarts/umn/modelarts_01_0003.html diff --git a/modelarts/umn/modelarts_01_0005.html b/docs/modelarts/umn/modelarts_01_0005.html similarity index 100% rename from modelarts/umn/modelarts_01_0005.html rename to docs/modelarts/umn/modelarts_01_0005.html diff --git a/modelarts/umn/modelarts_01_0006.html b/docs/modelarts/umn/modelarts_01_0006.html similarity index 100% rename from modelarts/umn/modelarts_01_0006.html rename to docs/modelarts/umn/modelarts_01_0006.html diff --git a/modelarts/umn/modelarts_01_0009.html b/docs/modelarts/umn/modelarts_01_0009.html similarity index 100% rename from modelarts/umn/modelarts_01_0009.html rename to docs/modelarts/umn/modelarts_01_0009.html diff --git a/modelarts/umn/modelarts_01_0010.html b/docs/modelarts/umn/modelarts_01_0010.html similarity index 100% rename from modelarts/umn/modelarts_01_0010.html rename to docs/modelarts/umn/modelarts_01_0010.html diff --git a/modelarts/umn/modelarts_01_0011.html b/docs/modelarts/umn/modelarts_01_0011.html similarity index 100% rename from modelarts/umn/modelarts_01_0011.html rename to docs/modelarts/umn/modelarts_01_0011.html diff --git a/modelarts/umn/modelarts_01_0012.html b/docs/modelarts/umn/modelarts_01_0012.html similarity index 100% rename from modelarts/umn/modelarts_01_0012.html rename to docs/modelarts/umn/modelarts_01_0012.html diff --git a/modelarts/umn/modelarts_01_0013.html b/docs/modelarts/umn/modelarts_01_0013.html similarity index 100% rename from modelarts/umn/modelarts_01_0013.html rename to docs/modelarts/umn/modelarts_01_0013.html diff --git a/modelarts/umn/modelarts_01_0014.html b/docs/modelarts/umn/modelarts_01_0014.html similarity index 100% rename from modelarts/umn/modelarts_01_0014.html rename to docs/modelarts/umn/modelarts_01_0014.html diff --git a/modelarts/umn/modelarts_01_0015.html b/docs/modelarts/umn/modelarts_01_0015.html similarity index 100% rename from modelarts/umn/modelarts_01_0015.html rename to docs/modelarts/umn/modelarts_01_0015.html diff --git a/modelarts/umn/modelarts_01_0016.html b/docs/modelarts/umn/modelarts_01_0016.html similarity index 100% rename from modelarts/umn/modelarts_01_0016.html rename to docs/modelarts/umn/modelarts_01_0016.html diff --git a/modelarts/umn/modelarts_01_0017.html b/docs/modelarts/umn/modelarts_01_0017.html similarity index 100% rename from modelarts/umn/modelarts_01_0017.html rename to docs/modelarts/umn/modelarts_01_0017.html diff --git a/modelarts/umn/modelarts_04_0099.html b/docs/modelarts/umn/modelarts_04_0099.html similarity index 100% rename from modelarts/umn/modelarts_04_0099.html rename to docs/modelarts/umn/modelarts_04_0099.html diff --git a/modelarts/umn/modelarts_05_0000.html b/docs/modelarts/umn/modelarts_05_0000.html similarity index 100% rename from modelarts/umn/modelarts_05_0000.html rename to docs/modelarts/umn/modelarts_05_0000.html diff --git a/modelarts/umn/modelarts_05_0001.html b/docs/modelarts/umn/modelarts_05_0001.html similarity index 100% rename from modelarts/umn/modelarts_05_0001.html rename to docs/modelarts/umn/modelarts_05_0001.html diff --git a/modelarts/umn/modelarts_05_0002.html b/docs/modelarts/umn/modelarts_05_0002.html similarity index 100% rename from modelarts/umn/modelarts_05_0002.html rename to docs/modelarts/umn/modelarts_05_0002.html diff --git a/modelarts/umn/modelarts_05_0003.html b/docs/modelarts/umn/modelarts_05_0003.html similarity index 100% rename from modelarts/umn/modelarts_05_0003.html rename to docs/modelarts/umn/modelarts_05_0003.html diff --git a/modelarts/umn/modelarts_05_0004.html b/docs/modelarts/umn/modelarts_05_0004.html similarity index 100% rename from modelarts/umn/modelarts_05_0004.html rename to docs/modelarts/umn/modelarts_05_0004.html diff --git a/modelarts/umn/modelarts_05_0005.html b/docs/modelarts/umn/modelarts_05_0005.html similarity index 100% rename from modelarts/umn/modelarts_05_0005.html rename to docs/modelarts/umn/modelarts_05_0005.html diff --git a/modelarts/umn/modelarts_05_0006.html b/docs/modelarts/umn/modelarts_05_0006.html similarity index 100% rename from modelarts/umn/modelarts_05_0006.html rename to docs/modelarts/umn/modelarts_05_0006.html diff --git a/modelarts/umn/modelarts_05_0008.html b/docs/modelarts/umn/modelarts_05_0008.html similarity index 100% rename from modelarts/umn/modelarts_05_0008.html rename to docs/modelarts/umn/modelarts_05_0008.html diff --git a/modelarts/umn/modelarts_05_0010.html b/docs/modelarts/umn/modelarts_05_0010.html similarity index 100% rename from modelarts/umn/modelarts_05_0010.html rename to docs/modelarts/umn/modelarts_05_0010.html diff --git a/modelarts/umn/modelarts_05_0012.html b/docs/modelarts/umn/modelarts_05_0012.html similarity index 100% rename from modelarts/umn/modelarts_05_0012.html rename to docs/modelarts/umn/modelarts_05_0012.html diff --git a/modelarts/umn/modelarts_05_0013.html b/docs/modelarts/umn/modelarts_05_0013.html similarity index 100% rename from modelarts/umn/modelarts_05_0013.html rename to docs/modelarts/umn/modelarts_05_0013.html diff --git a/modelarts/umn/modelarts_05_0014.html b/docs/modelarts/umn/modelarts_05_0014.html similarity index 100% rename from modelarts/umn/modelarts_05_0014.html rename to docs/modelarts/umn/modelarts_05_0014.html diff --git a/modelarts/umn/modelarts_05_0015.html b/docs/modelarts/umn/modelarts_05_0015.html similarity index 100% rename from modelarts/umn/modelarts_05_0015.html rename to docs/modelarts/umn/modelarts_05_0015.html diff --git a/modelarts/umn/modelarts_05_0016.html b/docs/modelarts/umn/modelarts_05_0016.html similarity index 100% rename from modelarts/umn/modelarts_05_0016.html rename to docs/modelarts/umn/modelarts_05_0016.html diff --git a/modelarts/umn/modelarts_05_0017.html b/docs/modelarts/umn/modelarts_05_0017.html similarity index 100% rename from modelarts/umn/modelarts_05_0017.html rename to docs/modelarts/umn/modelarts_05_0017.html diff --git a/modelarts/umn/modelarts_05_0018.html b/docs/modelarts/umn/modelarts_05_0018.html similarity index 100% rename from modelarts/umn/modelarts_05_0018.html rename to docs/modelarts/umn/modelarts_05_0018.html diff --git a/modelarts/umn/modelarts_05_0020.html b/docs/modelarts/umn/modelarts_05_0020.html similarity index 100% rename from modelarts/umn/modelarts_05_0020.html rename to docs/modelarts/umn/modelarts_05_0020.html diff --git a/modelarts/umn/modelarts_05_0030.html b/docs/modelarts/umn/modelarts_05_0030.html similarity index 100% rename from modelarts/umn/modelarts_05_0030.html rename to docs/modelarts/umn/modelarts_05_0030.html diff --git a/modelarts/umn/modelarts_05_0031.html b/docs/modelarts/umn/modelarts_05_0031.html similarity index 100% rename from modelarts/umn/modelarts_05_0031.html rename to docs/modelarts/umn/modelarts_05_0031.html diff --git a/modelarts/umn/modelarts_05_0032.html b/docs/modelarts/umn/modelarts_05_0032.html similarity index 100% rename from modelarts/umn/modelarts_05_0032.html rename to docs/modelarts/umn/modelarts_05_0032.html diff --git a/modelarts/umn/modelarts_05_0045.html b/docs/modelarts/umn/modelarts_05_0045.html similarity index 100% rename from modelarts/umn/modelarts_05_0045.html rename to docs/modelarts/umn/modelarts_05_0045.html diff --git a/modelarts/umn/modelarts_05_0063.html b/docs/modelarts/umn/modelarts_05_0063.html similarity index 100% rename from modelarts/umn/modelarts_05_0063.html rename to docs/modelarts/umn/modelarts_05_0063.html diff --git a/modelarts/umn/modelarts_05_0067.html b/docs/modelarts/umn/modelarts_05_0067.html similarity index 100% rename from modelarts/umn/modelarts_05_0067.html rename to docs/modelarts/umn/modelarts_05_0067.html diff --git a/modelarts/umn/modelarts_05_0071.html b/docs/modelarts/umn/modelarts_05_0071.html similarity index 100% rename from modelarts/umn/modelarts_05_0071.html rename to docs/modelarts/umn/modelarts_05_0071.html diff --git a/modelarts/umn/modelarts_05_0080.html b/docs/modelarts/umn/modelarts_05_0080.html similarity index 100% rename from modelarts/umn/modelarts_05_0080.html rename to docs/modelarts/umn/modelarts_05_0080.html diff --git a/modelarts/umn/modelarts_05_0081.html b/docs/modelarts/umn/modelarts_05_0081.html similarity index 100% rename from modelarts/umn/modelarts_05_0081.html rename to docs/modelarts/umn/modelarts_05_0081.html diff --git a/modelarts/umn/modelarts_05_0090.html b/docs/modelarts/umn/modelarts_05_0090.html similarity index 100% rename from modelarts/umn/modelarts_05_0090.html rename to docs/modelarts/umn/modelarts_05_0090.html diff --git a/modelarts/umn/modelarts_05_0100.html b/docs/modelarts/umn/modelarts_05_0100.html similarity index 100% rename from modelarts/umn/modelarts_05_0100.html rename to docs/modelarts/umn/modelarts_05_0100.html diff --git a/modelarts/umn/modelarts_05_0101.html b/docs/modelarts/umn/modelarts_05_0101.html similarity index 100% rename from modelarts/umn/modelarts_05_0101.html rename to docs/modelarts/umn/modelarts_05_0101.html diff --git a/modelarts/umn/modelarts_05_0103.html b/docs/modelarts/umn/modelarts_05_0103.html similarity index 100% rename from modelarts/umn/modelarts_05_0103.html rename to docs/modelarts/umn/modelarts_05_0103.html diff --git a/modelarts/umn/modelarts_05_0124.html b/docs/modelarts/umn/modelarts_05_0124.html similarity index 100% rename from modelarts/umn/modelarts_05_0124.html rename to docs/modelarts/umn/modelarts_05_0124.html diff --git a/modelarts/umn/modelarts_05_0128.html b/docs/modelarts/umn/modelarts_05_0128.html similarity index 100% rename from modelarts/umn/modelarts_05_0128.html rename to docs/modelarts/umn/modelarts_05_0128.html diff --git a/modelarts/umn/modelarts_05_0161.html b/docs/modelarts/umn/modelarts_05_0161.html similarity index 100% rename from modelarts/umn/modelarts_05_0161.html rename to docs/modelarts/umn/modelarts_05_0161.html diff --git a/modelarts/umn/modelarts_08_0000.html b/docs/modelarts/umn/modelarts_08_0000.html similarity index 100% rename from modelarts/umn/modelarts_08_0000.html rename to docs/modelarts/umn/modelarts_08_0000.html diff --git a/modelarts/umn/modelarts_08_0002.html b/docs/modelarts/umn/modelarts_08_0002.html similarity index 100% rename from modelarts/umn/modelarts_08_0002.html rename to docs/modelarts/umn/modelarts_08_0002.html diff --git a/modelarts/umn/modelarts_08_0003.html b/docs/modelarts/umn/modelarts_08_0003.html similarity index 100% rename from modelarts/umn/modelarts_08_0003.html rename to docs/modelarts/umn/modelarts_08_0003.html diff --git a/modelarts/umn/modelarts_08_0005.html b/docs/modelarts/umn/modelarts_08_0005.html similarity index 100% rename from modelarts/umn/modelarts_08_0005.html rename to docs/modelarts/umn/modelarts_08_0005.html diff --git a/modelarts/umn/modelarts_08_0006.html b/docs/modelarts/umn/modelarts_08_0006.html similarity index 100% rename from modelarts/umn/modelarts_08_0006.html rename to docs/modelarts/umn/modelarts_08_0006.html diff --git a/modelarts/umn/modelarts_08_0007.html b/docs/modelarts/umn/modelarts_08_0007.html similarity index 100% rename from modelarts/umn/modelarts_08_0007.html rename to docs/modelarts/umn/modelarts_08_0007.html diff --git a/modelarts/umn/modelarts_21_0000.html b/docs/modelarts/umn/modelarts_21_0000.html similarity index 100% rename from modelarts/umn/modelarts_21_0000.html rename to docs/modelarts/umn/modelarts_21_0000.html diff --git a/modelarts/umn/modelarts_21_0001.html b/docs/modelarts/umn/modelarts_21_0001.html similarity index 100% rename from modelarts/umn/modelarts_21_0001.html rename to docs/modelarts/umn/modelarts_21_0001.html diff --git a/modelarts/umn/modelarts_21_0002.html b/docs/modelarts/umn/modelarts_21_0002.html similarity index 100% rename from modelarts/umn/modelarts_21_0002.html rename to docs/modelarts/umn/modelarts_21_0002.html diff --git a/modelarts/umn/modelarts_21_0003.html b/docs/modelarts/umn/modelarts_21_0003.html similarity index 100% rename from modelarts/umn/modelarts_21_0003.html rename to docs/modelarts/umn/modelarts_21_0003.html diff --git a/modelarts/umn/modelarts_21_0004.html b/docs/modelarts/umn/modelarts_21_0004.html similarity index 100% rename from modelarts/umn/modelarts_21_0004.html rename to docs/modelarts/umn/modelarts_21_0004.html diff --git a/modelarts/umn/modelarts_21_0005.html b/docs/modelarts/umn/modelarts_21_0005.html similarity index 100% rename from modelarts/umn/modelarts_21_0005.html rename to docs/modelarts/umn/modelarts_21_0005.html diff --git a/modelarts/umn/modelarts_21_0006.html b/docs/modelarts/umn/modelarts_21_0006.html similarity index 100% rename from modelarts/umn/modelarts_21_0006.html rename to docs/modelarts/umn/modelarts_21_0006.html diff --git a/modelarts/umn/modelarts_21_0007.html b/docs/modelarts/umn/modelarts_21_0007.html similarity index 100% rename from modelarts/umn/modelarts_21_0007.html rename to docs/modelarts/umn/modelarts_21_0007.html diff --git a/modelarts/umn/modelarts_21_0008.html b/docs/modelarts/umn/modelarts_21_0008.html similarity index 100% rename from modelarts/umn/modelarts_21_0008.html rename to docs/modelarts/umn/modelarts_21_0008.html diff --git a/modelarts/umn/modelarts_21_0009.html b/docs/modelarts/umn/modelarts_21_0009.html similarity index 100% rename from modelarts/umn/modelarts_21_0009.html rename to docs/modelarts/umn/modelarts_21_0009.html diff --git a/modelarts/umn/modelarts_21_0010.html b/docs/modelarts/umn/modelarts_21_0010.html similarity index 100% rename from modelarts/umn/modelarts_21_0010.html rename to docs/modelarts/umn/modelarts_21_0010.html diff --git a/modelarts/umn/modelarts_21_0011.html b/docs/modelarts/umn/modelarts_21_0011.html similarity index 100% rename from modelarts/umn/modelarts_21_0011.html rename to docs/modelarts/umn/modelarts_21_0011.html diff --git a/modelarts/umn/modelarts_21_0012.html b/docs/modelarts/umn/modelarts_21_0012.html similarity index 100% rename from modelarts/umn/modelarts_21_0012.html rename to docs/modelarts/umn/modelarts_21_0012.html diff --git a/modelarts/umn/modelarts_21_0013.html b/docs/modelarts/umn/modelarts_21_0013.html similarity index 100% rename from modelarts/umn/modelarts_21_0013.html rename to docs/modelarts/umn/modelarts_21_0013.html diff --git a/modelarts/umn/modelarts_21_0030.html b/docs/modelarts/umn/modelarts_21_0030.html similarity index 100% rename from modelarts/umn/modelarts_21_0030.html rename to docs/modelarts/umn/modelarts_21_0030.html diff --git a/modelarts/umn/modelarts_21_0031.html b/docs/modelarts/umn/modelarts_21_0031.html similarity index 100% rename from modelarts/umn/modelarts_21_0031.html rename to docs/modelarts/umn/modelarts_21_0031.html diff --git a/modelarts/umn/modelarts_21_0032.html b/docs/modelarts/umn/modelarts_21_0032.html similarity index 100% rename from modelarts/umn/modelarts_21_0032.html rename to docs/modelarts/umn/modelarts_21_0032.html diff --git a/modelarts/umn/modelarts_21_0033.html b/docs/modelarts/umn/modelarts_21_0033.html similarity index 100% rename from modelarts/umn/modelarts_21_0033.html rename to docs/modelarts/umn/modelarts_21_0033.html diff --git a/modelarts/umn/modelarts_21_0034.html b/docs/modelarts/umn/modelarts_21_0034.html similarity index 100% rename from modelarts/umn/modelarts_21_0034.html rename to docs/modelarts/umn/modelarts_21_0034.html diff --git a/modelarts/umn/modelarts_23_0002.html b/docs/modelarts/umn/modelarts_23_0002.html similarity index 100% rename from modelarts/umn/modelarts_23_0002.html rename to docs/modelarts/umn/modelarts_23_0002.html diff --git a/modelarts/umn/modelarts_23_0003.html b/docs/modelarts/umn/modelarts_23_0003.html similarity index 100% rename from modelarts/umn/modelarts_23_0003.html rename to docs/modelarts/umn/modelarts_23_0003.html diff --git a/modelarts/umn/modelarts_23_0004.html b/docs/modelarts/umn/modelarts_23_0004.html similarity index 100% rename from modelarts/umn/modelarts_23_0004.html rename to docs/modelarts/umn/modelarts_23_0004.html diff --git a/modelarts/umn/modelarts_23_0005.html b/docs/modelarts/umn/modelarts_23_0005.html similarity index 100% rename from modelarts/umn/modelarts_23_0005.html rename to docs/modelarts/umn/modelarts_23_0005.html diff --git a/modelarts/umn/modelarts_23_0006.html b/docs/modelarts/umn/modelarts_23_0006.html similarity index 100% rename from modelarts/umn/modelarts_23_0006.html rename to docs/modelarts/umn/modelarts_23_0006.html diff --git a/modelarts/umn/modelarts_23_0008.html b/docs/modelarts/umn/modelarts_23_0008.html similarity index 100% rename from modelarts/umn/modelarts_23_0008.html rename to docs/modelarts/umn/modelarts_23_0008.html diff --git a/modelarts/umn/modelarts_23_0009.html b/docs/modelarts/umn/modelarts_23_0009.html similarity index 100% rename from modelarts/umn/modelarts_23_0009.html rename to docs/modelarts/umn/modelarts_23_0009.html diff --git a/modelarts/umn/modelarts_23_0010.html b/docs/modelarts/umn/modelarts_23_0010.html similarity index 100% rename from modelarts/umn/modelarts_23_0010.html rename to docs/modelarts/umn/modelarts_23_0010.html diff --git a/modelarts/umn/modelarts_23_0011.html b/docs/modelarts/umn/modelarts_23_0011.html similarity index 100% rename from modelarts/umn/modelarts_23_0011.html rename to docs/modelarts/umn/modelarts_23_0011.html diff --git a/modelarts/umn/modelarts_23_0012.html b/docs/modelarts/umn/modelarts_23_0012.html similarity index 100% rename from modelarts/umn/modelarts_23_0012.html rename to docs/modelarts/umn/modelarts_23_0012.html diff --git a/modelarts/umn/modelarts_23_0013.html b/docs/modelarts/umn/modelarts_23_0013.html similarity index 100% rename from modelarts/umn/modelarts_23_0013.html rename to docs/modelarts/umn/modelarts_23_0013.html diff --git a/modelarts/umn/modelarts_23_0014.html b/docs/modelarts/umn/modelarts_23_0014.html similarity index 100% rename from modelarts/umn/modelarts_23_0014.html rename to docs/modelarts/umn/modelarts_23_0014.html diff --git a/modelarts/umn/modelarts_23_0015.html b/docs/modelarts/umn/modelarts_23_0015.html similarity index 100% rename from modelarts/umn/modelarts_23_0015.html rename to docs/modelarts/umn/modelarts_23_0015.html diff --git a/modelarts/umn/modelarts_23_0016.html b/docs/modelarts/umn/modelarts_23_0016.html similarity index 100% rename from modelarts/umn/modelarts_23_0016.html rename to docs/modelarts/umn/modelarts_23_0016.html diff --git a/modelarts/umn/modelarts_23_0017.html b/docs/modelarts/umn/modelarts_23_0017.html similarity index 100% rename from modelarts/umn/modelarts_23_0017.html rename to docs/modelarts/umn/modelarts_23_0017.html diff --git a/modelarts/umn/modelarts_23_0018.html b/docs/modelarts/umn/modelarts_23_0018.html similarity index 100% rename from modelarts/umn/modelarts_23_0018.html rename to docs/modelarts/umn/modelarts_23_0018.html diff --git a/modelarts/umn/modelarts_23_0019.html b/docs/modelarts/umn/modelarts_23_0019.html similarity index 100% rename from modelarts/umn/modelarts_23_0019.html rename to docs/modelarts/umn/modelarts_23_0019.html diff --git a/modelarts/umn/modelarts_23_0020.html b/docs/modelarts/umn/modelarts_23_0020.html similarity index 100% rename from modelarts/umn/modelarts_23_0020.html rename to docs/modelarts/umn/modelarts_23_0020.html diff --git a/modelarts/umn/modelarts_23_0021.html b/docs/modelarts/umn/modelarts_23_0021.html similarity index 100% rename from modelarts/umn/modelarts_23_0021.html rename to docs/modelarts/umn/modelarts_23_0021.html diff --git a/modelarts/umn/modelarts_23_0032.html b/docs/modelarts/umn/modelarts_23_0032.html similarity index 100% rename from modelarts/umn/modelarts_23_0032.html rename to docs/modelarts/umn/modelarts_23_0032.html diff --git a/modelarts/umn/modelarts_23_0033.html b/docs/modelarts/umn/modelarts_23_0033.html similarity index 100% rename from modelarts/umn/modelarts_23_0033.html rename to docs/modelarts/umn/modelarts_23_0033.html diff --git a/modelarts/umn/modelarts_23_0034.html b/docs/modelarts/umn/modelarts_23_0034.html similarity index 100% rename from modelarts/umn/modelarts_23_0034.html rename to docs/modelarts/umn/modelarts_23_0034.html diff --git a/modelarts/umn/modelarts_23_0035.html b/docs/modelarts/umn/modelarts_23_0035.html similarity index 100% rename from modelarts/umn/modelarts_23_0035.html rename to docs/modelarts/umn/modelarts_23_0035.html diff --git a/modelarts/umn/modelarts_23_0037.html b/docs/modelarts/umn/modelarts_23_0037.html similarity index 100% rename from modelarts/umn/modelarts_23_0037.html rename to docs/modelarts/umn/modelarts_23_0037.html diff --git a/modelarts/umn/modelarts_23_0038.html b/docs/modelarts/umn/modelarts_23_0038.html similarity index 100% rename from modelarts/umn/modelarts_23_0038.html rename to docs/modelarts/umn/modelarts_23_0038.html diff --git a/modelarts/umn/modelarts_23_0040.html b/docs/modelarts/umn/modelarts_23_0040.html similarity index 100% rename from modelarts/umn/modelarts_23_0040.html rename to docs/modelarts/umn/modelarts_23_0040.html diff --git a/modelarts/umn/modelarts_23_0041.html b/docs/modelarts/umn/modelarts_23_0041.html similarity index 100% rename from modelarts/umn/modelarts_23_0041.html rename to docs/modelarts/umn/modelarts_23_0041.html diff --git a/modelarts/umn/modelarts_23_0042.html b/docs/modelarts/umn/modelarts_23_0042.html similarity index 100% rename from modelarts/umn/modelarts_23_0042.html rename to docs/modelarts/umn/modelarts_23_0042.html diff --git a/modelarts/umn/modelarts_23_0043.html b/docs/modelarts/umn/modelarts_23_0043.html similarity index 100% rename from modelarts/umn/modelarts_23_0043.html rename to docs/modelarts/umn/modelarts_23_0043.html diff --git a/modelarts/umn/modelarts_23_0044.html b/docs/modelarts/umn/modelarts_23_0044.html similarity index 100% rename from modelarts/umn/modelarts_23_0044.html rename to docs/modelarts/umn/modelarts_23_0044.html diff --git a/modelarts/umn/modelarts_23_0046.html b/docs/modelarts/umn/modelarts_23_0046.html similarity index 100% rename from modelarts/umn/modelarts_23_0046.html rename to docs/modelarts/umn/modelarts_23_0046.html diff --git a/modelarts/umn/modelarts_23_0047.html b/docs/modelarts/umn/modelarts_23_0047.html similarity index 100% rename from modelarts/umn/modelarts_23_0047.html rename to docs/modelarts/umn/modelarts_23_0047.html diff --git a/modelarts/umn/modelarts_23_0048.html b/docs/modelarts/umn/modelarts_23_0048.html similarity index 100% rename from modelarts/umn/modelarts_23_0048.html rename to docs/modelarts/umn/modelarts_23_0048.html diff --git a/modelarts/umn/modelarts_23_0049.html b/docs/modelarts/umn/modelarts_23_0049.html similarity index 100% rename from modelarts/umn/modelarts_23_0049.html rename to docs/modelarts/umn/modelarts_23_0049.html diff --git a/modelarts/umn/modelarts_23_0050.html b/docs/modelarts/umn/modelarts_23_0050.html similarity index 100% rename from modelarts/umn/modelarts_23_0050.html rename to docs/modelarts/umn/modelarts_23_0050.html diff --git a/modelarts/umn/modelarts_23_0051.html b/docs/modelarts/umn/modelarts_23_0051.html similarity index 100% rename from modelarts/umn/modelarts_23_0051.html rename to docs/modelarts/umn/modelarts_23_0051.html diff --git a/modelarts/umn/modelarts_23_0052.html b/docs/modelarts/umn/modelarts_23_0052.html similarity index 100% rename from modelarts/umn/modelarts_23_0052.html rename to docs/modelarts/umn/modelarts_23_0052.html diff --git a/modelarts/umn/modelarts_23_0054.html b/docs/modelarts/umn/modelarts_23_0054.html similarity index 100% rename from modelarts/umn/modelarts_23_0054.html rename to docs/modelarts/umn/modelarts_23_0054.html diff --git a/modelarts/umn/modelarts_23_0055.html b/docs/modelarts/umn/modelarts_23_0055.html similarity index 100% rename from modelarts/umn/modelarts_23_0055.html rename to docs/modelarts/umn/modelarts_23_0055.html diff --git a/modelarts/umn/modelarts_23_0057.html b/docs/modelarts/umn/modelarts_23_0057.html similarity index 100% rename from modelarts/umn/modelarts_23_0057.html rename to docs/modelarts/umn/modelarts_23_0057.html diff --git a/modelarts/umn/modelarts_23_0058.html b/docs/modelarts/umn/modelarts_23_0058.html similarity index 100% rename from modelarts/umn/modelarts_23_0058.html rename to docs/modelarts/umn/modelarts_23_0058.html diff --git a/modelarts/umn/modelarts_23_0059.html b/docs/modelarts/umn/modelarts_23_0059.html similarity index 100% rename from modelarts/umn/modelarts_23_0059.html rename to docs/modelarts/umn/modelarts_23_0059.html diff --git a/modelarts/umn/modelarts_23_0060.html b/docs/modelarts/umn/modelarts_23_0060.html similarity index 100% rename from modelarts/umn/modelarts_23_0060.html rename to docs/modelarts/umn/modelarts_23_0060.html diff --git a/modelarts/umn/modelarts_23_0061.html b/docs/modelarts/umn/modelarts_23_0061.html similarity index 100% rename from modelarts/umn/modelarts_23_0061.html rename to docs/modelarts/umn/modelarts_23_0061.html diff --git a/modelarts/umn/modelarts_23_0062.html b/docs/modelarts/umn/modelarts_23_0062.html similarity index 100% rename from modelarts/umn/modelarts_23_0062.html rename to docs/modelarts/umn/modelarts_23_0062.html diff --git a/modelarts/umn/modelarts_23_0063.html b/docs/modelarts/umn/modelarts_23_0063.html similarity index 100% rename from modelarts/umn/modelarts_23_0063.html rename to docs/modelarts/umn/modelarts_23_0063.html diff --git a/modelarts/umn/modelarts_23_0065.html b/docs/modelarts/umn/modelarts_23_0065.html similarity index 100% rename from modelarts/umn/modelarts_23_0065.html rename to docs/modelarts/umn/modelarts_23_0065.html diff --git a/modelarts/umn/modelarts_23_0066.html b/docs/modelarts/umn/modelarts_23_0066.html similarity index 100% rename from modelarts/umn/modelarts_23_0066.html rename to docs/modelarts/umn/modelarts_23_0066.html diff --git a/modelarts/umn/modelarts_23_0067.html b/docs/modelarts/umn/modelarts_23_0067.html similarity index 100% rename from modelarts/umn/modelarts_23_0067.html rename to docs/modelarts/umn/modelarts_23_0067.html diff --git a/modelarts/umn/modelarts_23_0071.html b/docs/modelarts/umn/modelarts_23_0071.html similarity index 100% rename from modelarts/umn/modelarts_23_0071.html rename to docs/modelarts/umn/modelarts_23_0071.html diff --git a/modelarts/umn/modelarts_23_0072.html b/docs/modelarts/umn/modelarts_23_0072.html similarity index 100% rename from modelarts/umn/modelarts_23_0072.html rename to docs/modelarts/umn/modelarts_23_0072.html diff --git a/modelarts/umn/modelarts_23_0073.html b/docs/modelarts/umn/modelarts_23_0073.html similarity index 100% rename from modelarts/umn/modelarts_23_0073.html rename to docs/modelarts/umn/modelarts_23_0073.html diff --git a/modelarts/umn/modelarts_23_0076.html b/docs/modelarts/umn/modelarts_23_0076.html similarity index 100% rename from modelarts/umn/modelarts_23_0076.html rename to docs/modelarts/umn/modelarts_23_0076.html diff --git a/modelarts/umn/modelarts_23_0077.html b/docs/modelarts/umn/modelarts_23_0077.html similarity index 100% rename from modelarts/umn/modelarts_23_0077.html rename to docs/modelarts/umn/modelarts_23_0077.html diff --git a/modelarts/umn/modelarts_23_0078.html b/docs/modelarts/umn/modelarts_23_0078.html similarity index 100% rename from modelarts/umn/modelarts_23_0078.html rename to docs/modelarts/umn/modelarts_23_0078.html diff --git a/modelarts/umn/modelarts_23_0079.html b/docs/modelarts/umn/modelarts_23_0079.html similarity index 100% rename from modelarts/umn/modelarts_23_0079.html rename to docs/modelarts/umn/modelarts_23_0079.html diff --git a/modelarts/umn/modelarts_23_0080.html b/docs/modelarts/umn/modelarts_23_0080.html similarity index 100% rename from modelarts/umn/modelarts_23_0080.html rename to docs/modelarts/umn/modelarts_23_0080.html diff --git a/modelarts/umn/modelarts_23_0083.html b/docs/modelarts/umn/modelarts_23_0083.html similarity index 100% rename from modelarts/umn/modelarts_23_0083.html rename to docs/modelarts/umn/modelarts_23_0083.html diff --git a/modelarts/umn/modelarts_23_0084.html b/docs/modelarts/umn/modelarts_23_0084.html similarity index 100% rename from modelarts/umn/modelarts_23_0084.html rename to docs/modelarts/umn/modelarts_23_0084.html diff --git a/modelarts/umn/modelarts_23_0085.html b/docs/modelarts/umn/modelarts_23_0085.html similarity index 100% rename from modelarts/umn/modelarts_23_0085.html rename to docs/modelarts/umn/modelarts_23_0085.html diff --git a/modelarts/umn/modelarts_23_0086.html b/docs/modelarts/umn/modelarts_23_0086.html similarity index 100% rename from modelarts/umn/modelarts_23_0086.html rename to docs/modelarts/umn/modelarts_23_0086.html diff --git a/modelarts/umn/modelarts_23_0087.html b/docs/modelarts/umn/modelarts_23_0087.html similarity index 100% rename from modelarts/umn/modelarts_23_0087.html rename to docs/modelarts/umn/modelarts_23_0087.html diff --git a/modelarts/umn/modelarts_23_0090.html b/docs/modelarts/umn/modelarts_23_0090.html similarity index 100% rename from modelarts/umn/modelarts_23_0090.html rename to docs/modelarts/umn/modelarts_23_0090.html diff --git a/modelarts/umn/modelarts_23_0091.html b/docs/modelarts/umn/modelarts_23_0091.html similarity index 100% rename from modelarts/umn/modelarts_23_0091.html rename to docs/modelarts/umn/modelarts_23_0091.html diff --git a/modelarts/umn/modelarts_23_0092.html b/docs/modelarts/umn/modelarts_23_0092.html similarity index 100% rename from modelarts/umn/modelarts_23_0092.html rename to docs/modelarts/umn/modelarts_23_0092.html diff --git a/modelarts/umn/modelarts_23_0093.html b/docs/modelarts/umn/modelarts_23_0093.html similarity index 100% rename from modelarts/umn/modelarts_23_0093.html rename to docs/modelarts/umn/modelarts_23_0093.html diff --git a/modelarts/umn/modelarts_23_0097.html b/docs/modelarts/umn/modelarts_23_0097.html similarity index 100% rename from modelarts/umn/modelarts_23_0097.html rename to docs/modelarts/umn/modelarts_23_0097.html diff --git a/modelarts/umn/modelarts_23_0098.html b/docs/modelarts/umn/modelarts_23_0098.html similarity index 100% rename from modelarts/umn/modelarts_23_0098.html rename to docs/modelarts/umn/modelarts_23_0098.html diff --git a/modelarts/umn/modelarts_23_0099.html b/docs/modelarts/umn/modelarts_23_0099.html similarity index 100% rename from modelarts/umn/modelarts_23_0099.html rename to docs/modelarts/umn/modelarts_23_0099.html diff --git a/modelarts/umn/modelarts_23_0100.html b/docs/modelarts/umn/modelarts_23_0100.html similarity index 100% rename from modelarts/umn/modelarts_23_0100.html rename to docs/modelarts/umn/modelarts_23_0100.html diff --git a/modelarts/umn/modelarts_23_0101.html b/docs/modelarts/umn/modelarts_23_0101.html similarity index 100% rename from modelarts/umn/modelarts_23_0101.html rename to docs/modelarts/umn/modelarts_23_0101.html diff --git a/modelarts/umn/modelarts_23_0102.html b/docs/modelarts/umn/modelarts_23_0102.html similarity index 100% rename from modelarts/umn/modelarts_23_0102.html rename to docs/modelarts/umn/modelarts_23_0102.html diff --git a/modelarts/umn/modelarts_23_0103.html b/docs/modelarts/umn/modelarts_23_0103.html similarity index 100% rename from modelarts/umn/modelarts_23_0103.html rename to docs/modelarts/umn/modelarts_23_0103.html diff --git a/modelarts/umn/modelarts_23_0106.html b/docs/modelarts/umn/modelarts_23_0106.html similarity index 100% rename from modelarts/umn/modelarts_23_0106.html rename to docs/modelarts/umn/modelarts_23_0106.html diff --git a/modelarts/umn/modelarts_23_0107.html b/docs/modelarts/umn/modelarts_23_0107.html similarity index 100% rename from modelarts/umn/modelarts_23_0107.html rename to docs/modelarts/umn/modelarts_23_0107.html diff --git a/modelarts/umn/modelarts_23_0108.html b/docs/modelarts/umn/modelarts_23_0108.html similarity index 100% rename from modelarts/umn/modelarts_23_0108.html rename to docs/modelarts/umn/modelarts_23_0108.html diff --git a/modelarts/umn/modelarts_23_0109.html b/docs/modelarts/umn/modelarts_23_0109.html similarity index 100% rename from modelarts/umn/modelarts_23_0109.html rename to docs/modelarts/umn/modelarts_23_0109.html diff --git a/modelarts/umn/modelarts_23_0110.html b/docs/modelarts/umn/modelarts_23_0110.html similarity index 100% rename from modelarts/umn/modelarts_23_0110.html rename to docs/modelarts/umn/modelarts_23_0110.html diff --git a/modelarts/umn/modelarts_23_0111.html b/docs/modelarts/umn/modelarts_23_0111.html similarity index 100% rename from modelarts/umn/modelarts_23_0111.html rename to docs/modelarts/umn/modelarts_23_0111.html diff --git a/modelarts/umn/modelarts_23_0117.html b/docs/modelarts/umn/modelarts_23_0117.html similarity index 100% rename from modelarts/umn/modelarts_23_0117.html rename to docs/modelarts/umn/modelarts_23_0117.html diff --git a/modelarts/umn/modelarts_23_0118.html b/docs/modelarts/umn/modelarts_23_0118.html similarity index 100% rename from modelarts/umn/modelarts_23_0118.html rename to docs/modelarts/umn/modelarts_23_0118.html diff --git a/modelarts/umn/modelarts_23_0120.html b/docs/modelarts/umn/modelarts_23_0120.html similarity index 100% rename from modelarts/umn/modelarts_23_0120.html rename to docs/modelarts/umn/modelarts_23_0120.html diff --git a/modelarts/umn/modelarts_23_0159.html b/docs/modelarts/umn/modelarts_23_0159.html similarity index 100% rename from modelarts/umn/modelarts_23_0159.html rename to docs/modelarts/umn/modelarts_23_0159.html diff --git a/modelarts/umn/modelarts_23_0162.html b/docs/modelarts/umn/modelarts_23_0162.html similarity index 100% rename from modelarts/umn/modelarts_23_0162.html rename to docs/modelarts/umn/modelarts_23_0162.html diff --git a/modelarts/umn/modelarts_23_0164.html b/docs/modelarts/umn/modelarts_23_0164.html similarity index 100% rename from modelarts/umn/modelarts_23_0164.html rename to docs/modelarts/umn/modelarts_23_0164.html diff --git a/modelarts/umn/modelarts_23_0166.html b/docs/modelarts/umn/modelarts_23_0166.html similarity index 100% rename from modelarts/umn/modelarts_23_0166.html rename to docs/modelarts/umn/modelarts_23_0166.html diff --git a/modelarts/umn/modelarts_23_0169.html b/docs/modelarts/umn/modelarts_23_0169.html similarity index 100% rename from modelarts/umn/modelarts_23_0169.html rename to docs/modelarts/umn/modelarts_23_0169.html diff --git a/modelarts/umn/modelarts_23_0170.html b/docs/modelarts/umn/modelarts_23_0170.html similarity index 100% rename from modelarts/umn/modelarts_23_0170.html rename to docs/modelarts/umn/modelarts_23_0170.html diff --git a/modelarts/umn/modelarts_23_0172.html b/docs/modelarts/umn/modelarts_23_0172.html similarity index 100% rename from modelarts/umn/modelarts_23_0172.html rename to docs/modelarts/umn/modelarts_23_0172.html diff --git a/modelarts/umn/modelarts_23_0173.html b/docs/modelarts/umn/modelarts_23_0173.html similarity index 100% rename from modelarts/umn/modelarts_23_0173.html rename to docs/modelarts/umn/modelarts_23_0173.html diff --git a/modelarts/umn/modelarts_23_0175.html b/docs/modelarts/umn/modelarts_23_0175.html similarity index 100% rename from modelarts/umn/modelarts_23_0175.html rename to docs/modelarts/umn/modelarts_23_0175.html diff --git a/modelarts/umn/modelarts_23_0176.html b/docs/modelarts/umn/modelarts_23_0176.html similarity index 100% rename from modelarts/umn/modelarts_23_0176.html rename to docs/modelarts/umn/modelarts_23_0176.html diff --git a/modelarts/umn/modelarts_23_0177.html b/docs/modelarts/umn/modelarts_23_0177.html similarity index 100% rename from modelarts/umn/modelarts_23_0177.html rename to docs/modelarts/umn/modelarts_23_0177.html diff --git a/modelarts/umn/modelarts_23_0178.html b/docs/modelarts/umn/modelarts_23_0178.html similarity index 100% rename from modelarts/umn/modelarts_23_0178.html rename to docs/modelarts/umn/modelarts_23_0178.html diff --git a/modelarts/umn/modelarts_23_0179.html b/docs/modelarts/umn/modelarts_23_0179.html similarity index 100% rename from modelarts/umn/modelarts_23_0179.html rename to docs/modelarts/umn/modelarts_23_0179.html diff --git a/modelarts/umn/modelarts_23_0180.html b/docs/modelarts/umn/modelarts_23_0180.html similarity index 100% rename from modelarts/umn/modelarts_23_0180.html rename to docs/modelarts/umn/modelarts_23_0180.html diff --git a/modelarts/umn/modelarts_23_0181.html b/docs/modelarts/umn/modelarts_23_0181.html similarity index 100% rename from modelarts/umn/modelarts_23_0181.html rename to docs/modelarts/umn/modelarts_23_0181.html diff --git a/modelarts/umn/modelarts_23_0182.html b/docs/modelarts/umn/modelarts_23_0182.html similarity index 100% rename from modelarts/umn/modelarts_23_0182.html rename to docs/modelarts/umn/modelarts_23_0182.html diff --git a/modelarts/umn/modelarts_23_0183.html b/docs/modelarts/umn/modelarts_23_0183.html similarity index 100% rename from modelarts/umn/modelarts_23_0183.html rename to docs/modelarts/umn/modelarts_23_0183.html diff --git a/modelarts/umn/modelarts_23_0186.html b/docs/modelarts/umn/modelarts_23_0186.html similarity index 100% rename from modelarts/umn/modelarts_23_0186.html rename to docs/modelarts/umn/modelarts_23_0186.html diff --git a/modelarts/umn/modelarts_23_0187.html b/docs/modelarts/umn/modelarts_23_0187.html similarity index 100% rename from modelarts/umn/modelarts_23_0187.html rename to docs/modelarts/umn/modelarts_23_0187.html diff --git a/modelarts/umn/modelarts_23_0188.html b/docs/modelarts/umn/modelarts_23_0188.html similarity index 100% rename from modelarts/umn/modelarts_23_0188.html rename to docs/modelarts/umn/modelarts_23_0188.html diff --git a/modelarts/umn/modelarts_23_0189.html b/docs/modelarts/umn/modelarts_23_0189.html similarity index 100% rename from modelarts/umn/modelarts_23_0189.html rename to docs/modelarts/umn/modelarts_23_0189.html diff --git a/modelarts/umn/modelarts_23_0204.html b/docs/modelarts/umn/modelarts_23_0204.html similarity index 100% rename from modelarts/umn/modelarts_23_0204.html rename to docs/modelarts/umn/modelarts_23_0204.html diff --git a/modelarts/umn/modelarts_23_0205.html b/docs/modelarts/umn/modelarts_23_0205.html similarity index 100% rename from modelarts/umn/modelarts_23_0205.html rename to docs/modelarts/umn/modelarts_23_0205.html diff --git a/modelarts/umn/modelarts_23_0206.html b/docs/modelarts/umn/modelarts_23_0206.html similarity index 100% rename from modelarts/umn/modelarts_23_0206.html rename to docs/modelarts/umn/modelarts_23_0206.html diff --git a/modelarts/umn/modelarts_23_0207.html b/docs/modelarts/umn/modelarts_23_0207.html similarity index 100% rename from modelarts/umn/modelarts_23_0207.html rename to docs/modelarts/umn/modelarts_23_0207.html diff --git a/modelarts/umn/modelarts_23_0209.html b/docs/modelarts/umn/modelarts_23_0209.html similarity index 100% rename from modelarts/umn/modelarts_23_0209.html rename to docs/modelarts/umn/modelarts_23_0209.html diff --git a/modelarts/umn/modelarts_23_0210.html b/docs/modelarts/umn/modelarts_23_0210.html similarity index 100% rename from modelarts/umn/modelarts_23_0210.html rename to docs/modelarts/umn/modelarts_23_0210.html diff --git a/modelarts/umn/modelarts_23_0211.html b/docs/modelarts/umn/modelarts_23_0211.html similarity index 100% rename from modelarts/umn/modelarts_23_0211.html rename to docs/modelarts/umn/modelarts_23_0211.html diff --git a/modelarts/umn/modelarts_23_0214.html b/docs/modelarts/umn/modelarts_23_0214.html similarity index 100% rename from modelarts/umn/modelarts_23_0214.html rename to docs/modelarts/umn/modelarts_23_0214.html diff --git a/modelarts/umn/modelarts_23_0216.html b/docs/modelarts/umn/modelarts_23_0216.html similarity index 100% rename from modelarts/umn/modelarts_23_0216.html rename to docs/modelarts/umn/modelarts_23_0216.html diff --git a/modelarts/umn/modelarts_23_0217.html b/docs/modelarts/umn/modelarts_23_0217.html similarity index 100% rename from modelarts/umn/modelarts_23_0217.html rename to docs/modelarts/umn/modelarts_23_0217.html diff --git a/modelarts/umn/modelarts_23_0218.html b/docs/modelarts/umn/modelarts_23_0218.html similarity index 100% rename from modelarts/umn/modelarts_23_0218.html rename to docs/modelarts/umn/modelarts_23_0218.html diff --git a/modelarts/umn/modelarts_23_0219.html b/docs/modelarts/umn/modelarts_23_0219.html similarity index 100% rename from modelarts/umn/modelarts_23_0219.html rename to docs/modelarts/umn/modelarts_23_0219.html diff --git a/modelarts/umn/modelarts_23_0235.html b/docs/modelarts/umn/modelarts_23_0235.html similarity index 100% rename from modelarts/umn/modelarts_23_0235.html rename to docs/modelarts/umn/modelarts_23_0235.html diff --git a/modelarts/umn/modelarts_23_0238.html b/docs/modelarts/umn/modelarts_23_0238.html similarity index 100% rename from modelarts/umn/modelarts_23_0238.html rename to docs/modelarts/umn/modelarts_23_0238.html diff --git a/modelarts/umn/modelarts_23_0239.html b/docs/modelarts/umn/modelarts_23_0239.html similarity index 100% rename from modelarts/umn/modelarts_23_0239.html rename to docs/modelarts/umn/modelarts_23_0239.html diff --git a/modelarts/umn/modelarts_23_0254.html b/docs/modelarts/umn/modelarts_23_0254.html similarity index 100% rename from modelarts/umn/modelarts_23_0254.html rename to docs/modelarts/umn/modelarts_23_0254.html diff --git a/modelarts/umn/modelarts_23_0280.html b/docs/modelarts/umn/modelarts_23_0280.html similarity index 100% rename from modelarts/umn/modelarts_23_0280.html rename to docs/modelarts/umn/modelarts_23_0280.html diff --git a/modelarts/umn/modelarts_23_0282.html b/docs/modelarts/umn/modelarts_23_0282.html similarity index 100% rename from modelarts/umn/modelarts_23_0282.html rename to docs/modelarts/umn/modelarts_23_0282.html diff --git a/modelarts/umn/modelarts_23_0325.html b/docs/modelarts/umn/modelarts_23_0325.html similarity index 100% rename from modelarts/umn/modelarts_23_0325.html rename to docs/modelarts/umn/modelarts_23_0325.html diff --git a/modelarts/umn/modelarts_23_0326.html b/docs/modelarts/umn/modelarts_23_0326.html similarity index 100% rename from modelarts/umn/modelarts_23_0326.html rename to docs/modelarts/umn/modelarts_23_0326.html diff --git a/modelarts/umn/modelarts_23_0327.html b/docs/modelarts/umn/modelarts_23_0327.html similarity index 100% rename from modelarts/umn/modelarts_23_0327.html rename to docs/modelarts/umn/modelarts_23_0327.html diff --git a/modelarts/umn/modelarts_23_0330.html b/docs/modelarts/umn/modelarts_23_0330.html similarity index 100% rename from modelarts/umn/modelarts_23_0330.html rename to docs/modelarts/umn/modelarts_23_0330.html diff --git a/modelarts/umn/modelarts_23_0331.html b/docs/modelarts/umn/modelarts_23_0331.html similarity index 100% rename from modelarts/umn/modelarts_23_0331.html rename to docs/modelarts/umn/modelarts_23_0331.html diff --git a/modelarts/umn/modelarts_23_0332.html b/docs/modelarts/umn/modelarts_23_0332.html similarity index 100% rename from modelarts/umn/modelarts_23_0332.html rename to docs/modelarts/umn/modelarts_23_0332.html diff --git a/modelarts/umn/modelarts_23_0333.html b/docs/modelarts/umn/modelarts_23_0333.html similarity index 100% rename from modelarts/umn/modelarts_23_0333.html rename to docs/modelarts/umn/modelarts_23_0333.html diff --git a/modelarts/umn/modelarts_23_0335.html b/docs/modelarts/umn/modelarts_23_0335.html similarity index 100% rename from modelarts/umn/modelarts_23_0335.html rename to docs/modelarts/umn/modelarts_23_0335.html diff --git a/modelarts/umn/modelarts_23_0345.html b/docs/modelarts/umn/modelarts_23_0345.html similarity index 100% rename from modelarts/umn/modelarts_23_0345.html rename to docs/modelarts/umn/modelarts_23_0345.html diff --git a/modelarts/umn/public_sys-resources/ExpandCollapse.js b/docs/modelarts/umn/public_sys-resources/ExpandCollapse.js similarity index 100% rename from modelarts/umn/public_sys-resources/ExpandCollapse.js rename to docs/modelarts/umn/public_sys-resources/ExpandCollapse.js diff --git a/modelarts/umn/public_sys-resources/caution_3.0-en-us.png b/docs/modelarts/umn/public_sys-resources/caution_3.0-en-us.png similarity index 100% rename from modelarts/umn/public_sys-resources/caution_3.0-en-us.png rename to docs/modelarts/umn/public_sys-resources/caution_3.0-en-us.png diff --git a/modelarts/umn/public_sys-resources/commonltr.css b/docs/modelarts/umn/public_sys-resources/commonltr.css similarity index 100% rename from modelarts/umn/public_sys-resources/commonltr.css rename to docs/modelarts/umn/public_sys-resources/commonltr.css diff --git a/modelarts/umn/public_sys-resources/commonltr_print.css b/docs/modelarts/umn/public_sys-resources/commonltr_print.css similarity index 100% rename from modelarts/umn/public_sys-resources/commonltr_print.css rename to docs/modelarts/umn/public_sys-resources/commonltr_print.css diff --git a/modelarts/umn/public_sys-resources/commonrtl.css b/docs/modelarts/umn/public_sys-resources/commonrtl.css similarity index 100% rename from modelarts/umn/public_sys-resources/commonrtl.css rename to docs/modelarts/umn/public_sys-resources/commonrtl.css diff --git a/modelarts/umn/public_sys-resources/danger_3.0-en-us.png b/docs/modelarts/umn/public_sys-resources/danger_3.0-en-us.png similarity index 100% rename from modelarts/umn/public_sys-resources/danger_3.0-en-us.png rename to docs/modelarts/umn/public_sys-resources/danger_3.0-en-us.png diff --git a/modelarts/umn/public_sys-resources/delta.gif b/docs/modelarts/umn/public_sys-resources/delta.gif similarity index 100% rename from modelarts/umn/public_sys-resources/delta.gif rename to docs/modelarts/umn/public_sys-resources/delta.gif diff --git a/modelarts/umn/public_sys-resources/deltaend.gif b/docs/modelarts/umn/public_sys-resources/deltaend.gif similarity index 100% rename from modelarts/umn/public_sys-resources/deltaend.gif rename to docs/modelarts/umn/public_sys-resources/deltaend.gif diff --git a/modelarts/umn/public_sys-resources/icon-arrowdn.gif b/docs/modelarts/umn/public_sys-resources/icon-arrowdn.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-arrowdn.gif rename to docs/modelarts/umn/public_sys-resources/icon-arrowdn.gif diff --git a/modelarts/umn/public_sys-resources/icon-arrowrt.gif b/docs/modelarts/umn/public_sys-resources/icon-arrowrt.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-arrowrt.gif rename to docs/modelarts/umn/public_sys-resources/icon-arrowrt.gif diff --git a/modelarts/umn/public_sys-resources/icon-caution.gif b/docs/modelarts/umn/public_sys-resources/icon-caution.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-caution.gif rename to docs/modelarts/umn/public_sys-resources/icon-caution.gif diff --git a/modelarts/umn/public_sys-resources/icon-danger.gif b/docs/modelarts/umn/public_sys-resources/icon-danger.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-danger.gif rename to docs/modelarts/umn/public_sys-resources/icon-danger.gif diff --git a/modelarts/umn/public_sys-resources/icon-huawei.gif b/docs/modelarts/umn/public_sys-resources/icon-huawei.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-huawei.gif rename to docs/modelarts/umn/public_sys-resources/icon-huawei.gif diff --git a/modelarts/umn/public_sys-resources/icon-note.gif b/docs/modelarts/umn/public_sys-resources/icon-note.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-note.gif rename to docs/modelarts/umn/public_sys-resources/icon-note.gif diff --git a/modelarts/umn/public_sys-resources/icon-notice.gif b/docs/modelarts/umn/public_sys-resources/icon-notice.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-notice.gif rename to docs/modelarts/umn/public_sys-resources/icon-notice.gif diff --git a/modelarts/umn/public_sys-resources/icon-tip.gif b/docs/modelarts/umn/public_sys-resources/icon-tip.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-tip.gif rename to docs/modelarts/umn/public_sys-resources/icon-tip.gif diff --git a/modelarts/umn/public_sys-resources/icon-warning.gif b/docs/modelarts/umn/public_sys-resources/icon-warning.gif similarity index 100% rename from modelarts/umn/public_sys-resources/icon-warning.gif rename to docs/modelarts/umn/public_sys-resources/icon-warning.gif diff --git a/modelarts/umn/public_sys-resources/note_3.0-en-us.png b/docs/modelarts/umn/public_sys-resources/note_3.0-en-us.png similarity index 100% rename from modelarts/umn/public_sys-resources/note_3.0-en-us.png rename to docs/modelarts/umn/public_sys-resources/note_3.0-en-us.png diff --git a/modelarts/umn/public_sys-resources/notice_3.0-en-us.png b/docs/modelarts/umn/public_sys-resources/notice_3.0-en-us.png similarity index 100% rename from modelarts/umn/public_sys-resources/notice_3.0-en-us.png rename to docs/modelarts/umn/public_sys-resources/notice_3.0-en-us.png diff --git a/modelarts/umn/public_sys-resources/popup.js b/docs/modelarts/umn/public_sys-resources/popup.js similarity index 100% rename from modelarts/umn/public_sys-resources/popup.js rename to docs/modelarts/umn/public_sys-resources/popup.js diff --git a/modelarts/umn/public_sys-resources/pygments.css b/docs/modelarts/umn/public_sys-resources/pygments.css similarity index 100% rename from modelarts/umn/public_sys-resources/pygments.css rename to docs/modelarts/umn/public_sys-resources/pygments.css diff --git a/modelarts/umn/public_sys-resources/warning_3.0-en-us.png b/docs/modelarts/umn/public_sys-resources/warning_3.0-en-us.png similarity index 100% rename from modelarts/umn/public_sys-resources/warning_3.0-en-us.png rename to docs/modelarts/umn/public_sys-resources/warning_3.0-en-us.png diff --git a/psd/umn/sd-usermanual.doc b/docs/psd/umn/sd-usermanual.doc similarity index 100% rename from psd/umn/sd-usermanual.doc rename to docs/psd/umn/sd-usermanual.doc diff --git a/psd/umn/sd-usermanual.docx b/docs/psd/umn/sd-usermanual.docx similarity index 100% rename from psd/umn/sd-usermanual.docx rename to docs/psd/umn/sd-usermanual.docx diff --git a/ecs/api-ref/result/api_usage_guidelines.rst b/ecs/api-ref/result/api_usage_guidelines.rst deleted file mode 100644 index 6bceb061..00000000 --- a/ecs/api-ref/result/api_usage_guidelines.rst +++ /dev/null @@ -1,12 +0,0 @@ -:original_name: en-us_topic_0020805967.html - -.. _en-us_topic_0020805967: - -API Usage Guidelines -==================== - -Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: *https://Endpoint/uri*. In the URL, **uri** indicates the resource path, that is, the API access path. - -Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**. - -For details about how to use APIs, see `API Usage Guidelines `__. diff --git a/ecs/api-ref/result/apis_recommended/batch_operations/index.rst b/ecs/api-ref/result/apis_recommended/batch_operations/index.rst deleted file mode 100644 index 8b2fc9ed..00000000 --- a/ecs/api-ref/result/apis_recommended/batch_operations/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0167816247: - -================ -Batch Operations -================ - -.. toctree:: - :maxdepth: 1 - - starting_ecss_in_a_batch - restarting_ecss_in_a_batch - stopping_ecss_in_a_batch diff --git a/ecs/api-ref/result/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst deleted file mode 100644 index 198793dd..00000000 --- a/ecs/api-ref/result/apis_recommended/batch_operations/restarting_ecss_in_a_batch.rst +++ /dev/null @@ -1,114 +0,0 @@ -:original_name: en-us_topic_0020212649.html - -.. _en-us_topic_0020212649: - -Restarting ECSs in a Batch -========================== - -Function --------- - -This API is used to restart ECSs in a batch based on specified ECS IDs. A maximum of 1000 ECSs can be restarted at a time. - -URI ---- - -POST /v1/{project_id}/cloudservers/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212649__table33008913: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212649__table54749715: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================================================================================+ - | reboot | Yes | Object | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212649__table64591731162222: - -.. table:: **Table 3** **reboot** field description - - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+===================================================================================================+ - | type | Yes | String | Specifies the type of the restart operation. | - | | | | | - | | | | - **SOFT**: soft restart | - | | | | - **HARD**: forcible restart (hard restart) | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212649__table26785545162223: - -.. table:: **Table 4** **servers** field description - - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -In the request, the parameters to restart ECSs must be sent with field **reboot**. For details, see the example request. - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/action - -.. code-block:: - - { - "reboot": { - "type":"SOFT", - "servers": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" - }, - { - "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" - } - - ] - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst deleted file mode 100644 index 61c5aefa..00000000 --- a/ecs/api-ref/result/apis_recommended/batch_operations/starting_ecss_in_a_batch.rst +++ /dev/null @@ -1,103 +0,0 @@ -:original_name: en-us_topic_0020212207.html - -.. _en-us_topic_0020212207: - -Starting ECSs in a Batch -======================== - -Function --------- - -This API is used to start ECSs in a batch based on specified ECS IDs. A maximum of 1000 ECSs can be started at a time. - -URI ---- - -POST /v1/{project_id}/cloudservers/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212207__table58892473: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==========================================================================================================================+ - | os-start | Yes | Object | Specifies the operation to start the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212207__table52132698163051: - -.. table:: **Table 3** **os-start** field description - - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+=============================================================================================+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212207__table23507505: - -.. table:: **Table 4** **servers** field description - - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -In the request, the parameters to start ECSs must be sent with field **os-start**. For details, see the example request. - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/action - -.. code-block:: - - { - "os-start": { - "servers": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" - }, - { - "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" - } - ] - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst deleted file mode 100644 index 05af503e..00000000 --- a/ecs/api-ref/result/apis_recommended/batch_operations/stopping_ecss_in_a_batch.rst +++ /dev/null @@ -1,111 +0,0 @@ -:original_name: en-us_topic_0020212651.html - -.. _en-us_topic_0020212651: - -Stopping ECSs in a Batch -======================== - -Function --------- - -This API is used to stop ECSs in a batch based on the specified ECS ID list. A maximum of 1000 ECSs can be stopped at a time. - -URI ---- - -POST /v1/{project_id}/cloudservers/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212651__table66418347: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=========================================================================================================================+ - | os-stop | Yes | Object | Specifies the operation to stop the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212651__table51053190162024: - -.. table:: **Table 3** **os-stop** field description - - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+=============================================================================================+ - | servers | Yes | Array of objects | Specifies ECS IDs. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ - | type | No | String | Specifies an ECS stop type. The default value is **SOFT**. | - | | | | | - | | | | **SOFT**: normal ECS stop (default) | - | | | | | - | | | | **HARD**: forcible ECS stop | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212651__table48932206: - -.. table:: **Table 4** **servers** field description - - ========= ========= ====== ===================== - Parameter Mandatory Type Description - ========= ========= ====== ===================== - id Yes String Specifies the ECS ID. - ========= ========= ====== ===================== - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -In the request parameters, the request for stopping the ECS must be issued with field **os-stop**, as shown in the example request. - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/action - -.. code-block:: - - { - "os-stop": { - "type":"HARD", - "servers": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" - }, - { - "id": "726fb98f-46ca-475e-917e-2563e5a8cd20" - } - - ] - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst b/ecs/api-ref/result/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst deleted file mode 100644 index 42e70571..00000000 --- a/ecs/api-ref/result/apis_recommended/disk_management/attaching_a_disk_to_an_ecs.rst +++ /dev/null @@ -1,97 +0,0 @@ -:original_name: en-us_topic_0022472987.html - -.. _en-us_topic_0022472987: - -Attaching a Disk to an ECS -========================== - -Function --------- - -This API is used to attach a disk to an ECS. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/attachvolume - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0022472987__table35528365105553: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -.. table:: **Table 2** Request parameters - - +------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+========+==========================================================================================================================+ - | volumeAttachment | Yes | Object | Specifies the ECS attachment information. For details, see :ref:`Table 3 `. | - +------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0022472987__table40707503151632: - -.. table:: **Table 3** **volumeAttachment** field description - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | volumeId | Yes | String | Specifies the ID of the disk to be attached. The value is in UUID format. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device | No | String | Indicates the disk device name. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The new disk device name cannot be the same as an existing one. | - | | | | - For KVM ECSs, set the parameter value to **/dev/vda** for system disks. The device names for data disks of KVM ECSs are optional. If the device names of data disks are required, set them in alphabetical order. For example, if there are two data disks, set the device names of the two data disks to **/dev/vdb** and **/dev/vdc**, respectively. If you set a device name starting with **/dev/sd**, the system uses **/dev/vd** by default. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/attachvolume - -.. code-block:: - - { - "volumeAttachment": { - "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803", - "device": "/dev/sda" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst b/ecs/api-ref/result/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst deleted file mode 100644 index 4fd5ee49..00000000 --- a/ecs/api-ref/result/apis_recommended/disk_management/detaching_an_evs_disk_from_an_ecs.rst +++ /dev/null @@ -1,71 +0,0 @@ -:original_name: en-us_topic_0022472988.html - -.. _en-us_topic_0022472988: - -Detaching an EVS Disk from an ECS -================================= - -Function --------- - -This API is used to detach an EVS disk from an ECS. - -URI ---- - -DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id}?delete_flag=0 - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0022472988__table2814978410562: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+---------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+===================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | - +-----------------------+-----------------------+---------------------------------------------------+ - | volume_id | Yes | Specifies the disk ID. | - +-----------------------+-----------------------+---------------------------------------------------+ - | delete_flag | No | Indicates whether to forcibly detach a data disk. | - | | | | - | | | - If yes, set it to **1**. | - | | | - If no, set it to **0**. | - | | | | - | | | It is set to **0** by default. | - +-----------------------+-----------------------+---------------------------------------------------+ - -Request -------- - -None - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/detachvolume/{volume_id} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/disk_management/index.rst b/ecs/api-ref/result/apis_recommended/disk_management/index.rst deleted file mode 100644 index 0d2e2313..00000000 --- a/ecs/api-ref/result/apis_recommended/disk_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0111860831: - -=============== -Disk Management -=============== - -.. toctree:: - :maxdepth: 1 - - attaching_a_disk_to_an_ecs - detaching_an_evs_disk_from_an_ecs - querying_disk_attachment_of_an_ecs - querying_a_single_disk_attached_to_an_ecs diff --git a/ecs/api-ref/result/apis_recommended/disk_management/querying_a_single_disk_attached_to_an_ecs.rst b/ecs/api-ref/result/apis_recommended/disk_management/querying_a_single_disk_attached_to_an_ecs.rst deleted file mode 100644 index f3b9d0a3..00000000 --- a/ecs/api-ref/result/apis_recommended/disk_management/querying_a_single_disk_attached_to_an_ecs.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: en-us_topic_0101860614.html - -.. _en-us_topic_0101860614: - -Querying a Single Disk Attached to an ECS -========================================= - -Function --------- - -This API is used to query a disk attached to an ECS. - -URI ---- - -GET /v2.1/servers/{server_id}/block_device/{volume_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0101860614__table35893824: - -.. table:: **Table 1** Parameter description - - ========= ========= ========================================= - Parameter Mandatory Description - ========= ========= ========================================= - server_id Yes Specifies the ECS ID in UUID format. - volume_id Yes Specifies the EVS disk ID in UUID format. - ========= ========= ========================================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0101860614__table57959838: - -.. table:: **Table 2** Response parameters - - +------------------+--------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+========+================================================================================================================+ - | volumeAttachment | Object | Specifies the disk attached to an ECS. For details, see :ref:`Table 3 `. | - +------------------+--------+----------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0101860614__table7886611: - -.. table:: **Table 3** **volumeAttachment** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================================================+ - | serverId | String | Specifies the ECS ID in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | volumeId | String | Specifies the EVS disk ID in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | id | String | Specifies the mount ID, which is the same as the EVS disk ID. | - | | | | - | | | The value is in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | size | Integer | Specifies the EVS disk size in GB. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | device | String | Specifies the drive letter of the EVS disk, which is the device name of the EVS disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | pciAddress | String | Specifies the PCI address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | bootIndex | Boolean | Specifies the EVS disk boot sequence. | - | | | | - | | | - **0** indicates the system disk. | - | | | - Non-0 indicates a data disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | bus | String | Specifies the disk bus type. | - | | | | - | | | Options: **virtio** and **scsi** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2.1/servers/{server_id}/block_device/{volume_id} - -Example Response ----------------- - -.. code-block:: - - { - "volumeAttachment": { - "pciAddress": "0000:02:01.0", - "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r", - "device": "/dev/vda", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "id": "a26887c6-c47b-4654-abb5-asdf234r234r", - "size": "40", - "bootIndex": 0, - "bus":"virtio" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/disk_management/querying_disk_attachment_of_an_ecs.rst b/ecs/api-ref/result/apis_recommended/disk_management/querying_disk_attachment_of_an_ecs.rst deleted file mode 100644 index c824657a..00000000 --- a/ecs/api-ref/result/apis_recommended/disk_management/querying_disk_attachment_of_an_ecs.rst +++ /dev/null @@ -1,147 +0,0 @@ -:original_name: en-us_topic_0101860613.html - -.. _en-us_topic_0101860613: - -Querying Disk Attachment of an ECS -================================== - -Function --------- - -This API is used to query disk attachment of an ECS. - -URI ---- - -GET /v2.1/servers/{server_id}/block_device - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0101860613__table35893824: - -.. table:: **Table 1** Parameter description - - ========= ========= ==================================== - Parameter Mandatory Description - ========= ========= ==================================== - server_id Yes Specifies the ECS ID in UUID format. - ========= ========= ==================================== - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0101860613__table57959838: - -.. table:: **Table 2** Response parameters - - +--------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+=============================================================================================================================================+ - | volumeAttachments | Array of objects | Specifies the disks attached to an ECS. For details, see :ref:`Table 3 `. | - +--------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | attachableQuantity | Object | Specifies the number of disks that can be attached to an ECS. For details, see :ref:`Table 4 `. | - +--------------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0101860613__table7886611: - -.. table:: **Table 3** **volumeAttachments** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================================================+ - | serverId | String | Specifies the ECS ID in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | volumeId | String | Specifies the EVS disk ID in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | id | String | Specifies the mount ID, which is the same as the EVS disk ID. | - | | | | - | | | The value is in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | size | Integer | Specifies the EVS disk size in GB. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | device | String | Specifies the drive letter of the EVS disk, which is the device name of the EVS disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | pciAddress | String | Specifies the PCI address. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | bootIndex | Boolean | Specifies the EVS disk boot sequence. | - | | | | - | | | - **0** indicates the system disk. | - | | | - Non-0 indicates a data disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | bus | String | Indicates the disk bus type. | - | | | | - | | | Options: **virtio** and **scsi** | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - -.. _en-us_topic_0101860613__table1635814953813: - -.. table:: **Table 4** **attachableQuantity** parameters - - +-----------+---------+--------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+==========================================================================+ - | free_scsi | Integer | Specifies the number of SCSI disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ - | free_blk | Integer | Specifies the number of virtio_blk disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ - | free_disk | Integer | Specifies the total number of disks that can be attached to an ECS. | - +-----------+---------+--------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2.1/servers/4d8c3732-a248-40ed-bebc-539a6ffd25c0/block_device - -Example Response ----------------- - -.. code-block:: - - { - "attachableQuantity": { - "free_scsi": 23, - "free_blk": 15, - "free_disk": 23 - }, - "volumeAttachments": [ - { - "pciAddress": "0000:02:01.0", - "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803", - "device": "/dev/vda", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", - "size": "40", - "bootIndex": 0, - "bus":"virtio" - }, - { - "pciAddress": "0000:02:02.0", - "volumeId": "a26887c6-c47b-4654-abb5-asdf234r234r", - "device": "/dev/vdb", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "id": "a26887c6-c47b-4654-abb5-asdf234r234r", - "size": "10", - "bootIndex": 1, - "bus":"virtio" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst deleted file mode 100644 index 09e5ebc0..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/adding_an_ecs_to_an_ecs_group.rst +++ /dev/null @@ -1,98 +0,0 @@ -:original_name: en-us_topic_0133622595.html - -.. _en-us_topic_0133622595: - -Adding an ECS to an ECS Group -============================= - -Function --------- - -This API is used to add an ECS to an ECS group. The system automatically deploys the newly added ECS to a host that is different from the ones accommodating other ECSs in the ECS group. - -Constraints ------------ - -- The ECS to be added has been stopped. -- Only KVM ECSs can be added. -- Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability. - -URI ---- - -POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0133622595__table042161072218: - -.. table:: **Table 1** Parameter description - - =============== ========= =========================== - Parameter Mandatory Description - =============== ========= =========================== - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group ID. - =============== ========= =========================== - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0133622595__table125642531229: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================+ - | add_member | Yes | Object | Specifies the information of the ECS to be added to an ECS group. | - | | | | | - | | | | For details, see :ref:`Table 3 `. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ - -.. _en-us_topic_0133622595__table532112610239: - -.. table:: **Table 3** **add_member** parameters - - ============= ========= ====== ======================= - Parameter Mandatory Type Description - ============= ========= ====== ======================= - instance_uuid Yes String Specifies the ECS UUID. - ============= ========= ====== ======================= - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action - -.. code-block:: - - { - "add_member": { - "instance_uuid":"34dac9a0-c4a7-457b-bab2-e2c696e0e401" - } - } - -Example Response ----------------- - -Status code 200, indicating that the operation is successful - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/creating_an_ecs_group.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/creating_an_ecs_group.rst deleted file mode 100644 index 50a36c11..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/creating_an_ecs_group.rst +++ /dev/null @@ -1,150 +0,0 @@ -:original_name: en-us_topic_0161097718.html - -.. _en-us_topic_0161097718: - -Creating an ECS Group -===================== - -Function --------- - -This API is used to create an ECS group. - -Constraints ------------ - -Only anti-affinity policies are supported. - -URI ---- - -POST /v1/{project_id}/cloudservers/os-server-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0161097718__table11729101619308: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0161097718__table146581144163019: - -.. table:: **Table 2** Request parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+======================================================================================================================================+ - | server_group | Yes | Object | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0161097718__en-us_topic_0057973153_table19917766: - -.. table:: **Table 3** **server_group** parameters - - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+======================================================================================================================================================================================================================+ - | name | Yes | String | Specifies the ECS group name. The value contains 1 to 255 characters. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Yes | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | | - | | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Only anti-affinity policies are supported. You are not advised to use other policies. If other policies are used, creating the ECS group will fail. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0161097718__table776421293115: - -.. table:: **Table 4** Response parameters - - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=====================================================================================================================================+ - | server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 5 `. | - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0161097718__en-us_topic_0057973153_table7944126: - -.. table:: **Table 5** **server_group** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================================================================================+ - | id | String | Specifies the ECS group UUID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | - | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the IDs of the ECSs in an ECS group. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups - -.. code-block:: - - { - "server_group": { - "name": "test", - "policies": ["anti-affinity"] - } - } - -Example Response ----------------- - -.. code-block:: - - { - "server_group": { - "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", - "name": "test", - "policies": [ - "anti-affinity" - ], - "members": [], - "metadata": {} - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst deleted file mode 100644 index 41180f82..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/deleting_an_ecs_group.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0161097719.html - -.. _en-us_topic_0161097719: - -Deleting an ECS Group -===================== - -Function --------- - -This API is used to delete an ECS group. - -URI ---- - -DELETE /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0161097719__table1962114910318: - -.. table:: **Table 1** Parameter description - - =============== ========= ============================= - Parameter Mandatory Description - =============== ========= ============================= - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group UUID. - =============== ========= ============================= - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/index.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/index.rst deleted file mode 100644 index 6df4950e..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0161097717: - -==================== -ECS Group Management -==================== - -.. toctree:: - :maxdepth: 1 - - creating_an_ecs_group - deleting_an_ecs_group - adding_an_ecs_to_an_ecs_group - removing_an_ecs_from_an_ecs_group - querying_ecs_groups - querying_details_about_an_ecs_group diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst deleted file mode 100644 index acda284a..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_details_about_an_ecs_group.rst +++ /dev/null @@ -1,99 +0,0 @@ -:original_name: en-us_topic_0175597847.html - -.. _en-us_topic_0175597847: - -Querying Details About an ECS Group -=================================== - -Function --------- - -This API is used to query details bout an ECS group. - -URI ---- - -GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0175597847__table050833691012: - -.. table:: **Table 1** Parameter description - - =============== ========= ============================ - Parameter Mandatory Description - =============== ========= ============================ - project_id Yes Specifies the project ID. - server_group_id Yes Specifies an ECS group UUID. - =============== ========= ============================ - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0175597847__table4683214181116: - -.. table:: **Table 2** Response parameters - - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=====================================================================================================================================+ - | server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0175597847__en-us_topic_0057973159_table5520021: - -.. table:: **Table 3** **server_group** parameters - - +-----------+------------------+-------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+=======================================================+ - | id | String | Specifies an ECS group UUID. | - +-----------+------------------+-------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------+------------------+-------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. | - +-----------+------------------+-------------------------------------------------------+ - | members | Array of strings | Specifies the ECS contained in an ECS group. | - +-----------+------------------+-------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------+------------------+-------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id} - -Example Response ----------------- - -.. code-block:: - - { - "server_group": { - "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", - "name": "test", - "policies": ["anti-affinity"], - "members": [], - "metadata": {} - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_ecs_groups.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_ecs_groups.rst deleted file mode 100644 index c5a11e05..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/querying_ecs_groups.rst +++ /dev/null @@ -1,136 +0,0 @@ -:original_name: en-us_topic_0175597846.html - -.. _en-us_topic_0175597846: - -Querying ECS Groups -=================== - -Function --------- - -This API is used to query ECS groups. - -URI ---- - -GET /v1/{project_id}/cloudservers/os-server-groups?limit={limit}&marker={marker} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0175597846__table566015531780: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================================================================================+ - | limit | No | Integer | Specifies the upper limit on the number of returned server groups. The maximum value is 1000. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies the marker that points to the ECS group. The query starts from the next piece of data indexed by this parameter. | - | | | | | - | | | | Parameters marker and limit must be used together. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0175597846__table696924014912: - -.. table:: **Table 3** Response parameters - - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+=====================================================================================================================================================================================+ - | server_groups | Array of objects | Specifies ECS groups. For details, see :ref:`Table 4 `. | - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page_info | Object | If the pagination function is enabled, the UUID of the last ECS group on the current page is returned. For details, see :ref:`Table 5 `. | - +---------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0175597846__en-us_topic_0057973158_table47937085: - -.. table:: **Table 4** **server_groups** parameter information - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================================================================================+ - | id | String | Specifies the ECS group UUID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the ECSs contained in an ECS group. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | - | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - | | | | - | | | .. note:: | - | | | | - | | | Only anti-affinity policies are supported. You are not advised to use other policies. If other policies are used, creating the ECS group will fail. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0175597846__table139805663519: - -.. table:: **Table 5** **page_info** field description - - =========== ====== ============================ - Parameter Type Description - =========== ====== ============================ - next_marker String Specifies an ECS group UUID. - =========== ====== ============================ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups - -Example Response ----------------- - -.. code-block:: - - { - "server_groups": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", - "name": "test", - "policies": ["anti-affinity"], - "members": [], - "metadata": {} - } - ], - "page_info": { - "next_marker": "616fb98f-46ca-475e-917e-2563e5a8cd19" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst b/ecs/api-ref/result/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst deleted file mode 100644 index c01158e3..00000000 --- a/ecs/api-ref/result/apis_recommended/ecs_group_management/removing_an_ecs_from_an_ecs_group.rst +++ /dev/null @@ -1,92 +0,0 @@ -:original_name: en-us_topic_0133622596.html - -.. _en-us_topic_0133622596: - -Removing an ECS from an ECS Group -================================= - -Function --------- - -This API is used to remove an ECS from an ECS group. After being removed, the anti-affinity policy will not take effect on this ECS and other ECSs in the same ECS group. - -Constraints ------------ - -Only the anti-affinity policy is supported. ECSs in the same ECS group are deployed on different hosts, improving service reliability. - -URI ---- - -POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0133622596__table10769113472410: - -.. table:: **Table 1** Parameter description - - =============== ========= =========================== - Parameter Mandatory Description - =============== ========= =========================== - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group ID. - =============== ========= =========================== - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0133622596__table45526613251: - -.. table:: **Table 2** Request parameters - - +---------------+-----------+--------+-----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+========+=======================================================================+ - | remove_member | Yes | Object | Specifies the information of the ECS to be removed from an ECS group. | - +---------------+-----------+--------+-----------------------------------------------------------------------+ - -.. table:: **Table 3** **remove_member** parameters - - ============= ========= ====== ======================= - Parameter Mandatory Type Description - ============= ========= ====== ======================= - instance_uuid Yes String Specifies the ECS UUID. - ============= ========= ====== ======================= - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action - -.. code-block:: - - { - "remove_member": { - "instance_uuid": "34dac9a0-c4a7-457b-bab2-e2c696e0e401" - } - } - -Example Response ----------------- - -Status code 200, indicating that the operation is successful - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/flavor_management/index.rst b/ecs/api-ref/result/apis_recommended/flavor_management/index.rst deleted file mode 100644 index 7b025d97..00000000 --- a/ecs/api-ref/result/apis_recommended/flavor_management/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0112708160: - -================= -Flavor Management -================= - -.. toctree:: - :maxdepth: 1 - - querying_details_about_flavors_and_extended_flavor_information - querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed diff --git a/ecs/api-ref/result/apis_recommended/flavor_management/querying_details_about_flavors_and_extended_flavor_information.rst b/ecs/api-ref/result/apis_recommended/flavor_management/querying_details_about_flavors_and_extended_flavor_information.rst deleted file mode 100644 index ececf17b..00000000 --- a/ecs/api-ref/result/apis_recommended/flavor_management/querying_details_about_flavors_and_extended_flavor_information.rst +++ /dev/null @@ -1,316 +0,0 @@ -:original_name: en-us_topic_0020212656.html - -.. _en-us_topic_0020212656: - -Querying Details About Flavors and Extended Flavor Information -============================================================== - -Function --------- - -This API is used to query details about ECS flavors and extended flavor information. - -URI ---- - -GET /v1/{project_id}/cloudservers/flavors?availability_zone={availability_zone} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212656__table50905282: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Query parameters - - +-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+==============================================================================================================================+ - | availability_zone | No | String | Specify an AZ. If this parameter is not left blank, flavors in the **normal**, **obt**, or **promotion** state are returned. | - +-------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0020212656__table17679057: - -.. table:: **Table 3** Response parameters - - +-----------+------------------+-------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+=================================================================================================+ - | flavors | Array of objects | Specifies ECS flavors. For details, see :ref:`Table 4 `. | - +-----------+------------------+-------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212656__table15697576: - -.. table:: **Table 4** **flavors** field description - - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+=======================+==========================================================================================================================+ - | id | String | Specifies the ID of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the name of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | vcpus | String | Specifies the number of vCPUs in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | disk | String | Specifies the system disk size in the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | swap | String | Specifies the swap partition size required by the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **""**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-EXT-DATA:ephemeral | Integer | Specifies the temporary disk size. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-DISABLED:disabled | Boolean | Specifies whether the ECS flavor has been disabled. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **false**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | rxtx_factor | Float | Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS. | - | | | | - | | | This parameter has not been used. Its default value is **1.0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | rxtx_quota | String | Specifies the software constraints of the network bandwidth that can be used by the ECS. | - | | | | - | | | This parameter has not been used. Its default value is **null**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | rxtx_cap | String | Specifies the hardware constraints of the network bandwidth that can be used by the ECS. | - | | | | - | | | This parameter has not been used. Its default value is **null**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | os-flavor-access:is_public | Boolean | Specifies whether a flavor is available to all tenants. This is an extended attribute. | - | | | | - | | | - **true**: indicates that a flavor is available to all tenants. | - | | | - **false**: indicates that a flavor is available only to certain tenants. | - | | | | - | | | Default value: **true** | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS flavors. For details, see :ref:`Table 5 `. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | os_extra_specs | Object | Specifies extended ECS specifications. For details, see :ref:`Table 6 `. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212656__table35958848194647: - -.. table:: **Table 5** **links** field description - - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================+ - | rel | String | Specifies the shortcut link marker name. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | href | String | Provides the corresponding shortcut link. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | type | String | Specifies the shortcut link type. This parameter has not been used. Its default value is **null**. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212656__table59078165: - -.. table:: **Table 6** **os_extra_specs** field description - - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================================+=======================+============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ecs:performancetype | String | Specifies the ECS flavor type: | - | | | | - | | | - **normal**: general computing | - | | | - **cpuv1**: computing I | - | | | - **cpuv2**: computing II | - | | | - **computingv3**: general computing-plus | - | | | - **highmem**: memory-optimized | - | | | - **saphana**: large-memory | - | | | - **saphana**: large-memory HANA ECS | - | | | - **diskintensive**: disk-intensive | - | | | - **highcpu**: high-performance computing | - | | | - **gpu**: GPU-accelerated | - | | | - **fpga**: FPGA-accelerated | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:type | String | Specifies the NIC type. The value of this parameter is consistently **enhanced**, indicating that network enhancement ECSs are to be created. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:instance_bandwidth | String | Specifies the maximum bandwidth in the unit of Mbit/s. The maximum value of this parameter is **10000**. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:max_count | String | Specifies the maximum number of NICs. The maximum value of this parameter is 4. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:local_disk | String | The value of this parameter is in format of "{type}:{count}:{size}:{safeFormat}", where, | - | | | | - | | | - **type**: indicates the disk type, which can only be HDD. | - | | | - **count**: indicates the number of local disks. | - | | | | - | | | - For D2 ECSs, the value can be 2, 4, 8, 12, 16, or 24. | - | | | - For D3 ECSs, the value can be 2, 4, 8, 12, 16, 24, or 28. | - | | | | - | | | - **size**: indicates the capacity of a single disk, in GB. Currently, only **1675** is supported. The actual disk size is **1800**, and the available size after formatting is **1675**. | - | | | - **safeFormat**: indicates whether the local disks of the ECS are securely formatted. | - | | | | - | | | - For D2 or D3 ECSs, the value is **True**. | - | | | | - | | | .. note:: | - | | | | - | | | This field is dedicated for disk-intensive ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:nvme_ssd | String | The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}:. | - | | | | - | | | - **type**: indicates the capacity of a single NVME SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB. | - | | | | - | | | - **spec**: indicates the specification of the NVME SSD disk, which can be **large** or **small**. | - | | | | - | | | If the value is **large**, only I3 ECSs are supported. | - | | | | - | | | - **num**: indicates the number of partitions on the disk. | - | | | | - | | | - **size**: indicates the capacity, in the unit of GB, of the disk used by the guest user. If the **spec** value is **large**, the value of this parameter is the size of a single disk attached to the ECS. If the **spec** value is **small**, the value of this parameter is 1/4 or 1/2 of the specification. | - | | | | - | | | - **safeFormat**: indicates whether the local disks of the ECS are securely formatted. | - | | | | - | | | If the value is **True**, only I3 ECSs are supported. | - | | | | - | | | .. note:: | - | | | | - | | | This field is dedicated for ultra-high I/O ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:generation | String | Specifies the generation of an ECS type. | - | | | | - | | | For example, **3** in **s3** indicates the general-purpose third-generation ECSs. For details about flavors and generations, see `ECS Specifications `__ in *Elastic Cloud Server User Guide*. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:virtualization_env_types | String | Specifies a virtualization type. | - | | | | - | | | - If the parameter value is **FusionCompute**, the ECS uses Xen virtualization. Currently, the Xen virtualization technology is not supported. | - | | | - If the parameter value is **CloudCompute**, the ECS uses KVM virtualization. | - | | | | - | | | .. note:: | - | | | | - | | | This field is optional. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:enable_gpu | String | Indicates whether the GPU is passthrough. | - | | | | - | | | If the value is **true**, the GPU is passthrough. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:alias | String | Indicates the model and quantity of passthrough-enabled GPUs on P1 ECSs. The parameter value can be set to **nvidia-p100:1**, indicating that the ECS using this specification will occupy one NVIDIA P100 GPU. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:status | String | This parameter takes effect region-wide. If an AZ is not configured in the **cond:operation:az** parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of **normal** applies. Options: | - | | | | - | | | - **normal**: indicates normal commercial use of the flavor. | - | | | - **abandon**: indicates that the flavor has been canceled (not displayed). | - | | | - **sellout**: indicates that the flavor has been sold out. | - | | | - **obt**: indicates that the flavor is under open beta testing (OBT). | - | | | - **obt_sellout**: indicates that the OBT resources are sold out. | - | | | - **promotion**: indicates the recommended flavor (commercial use, which is similar to **normal**). | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:az | String | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | - | | | | - | | | For example, a flavor is for commercial use in AZs 0 and 3, sold out in AZ 1, for OBT in AZ 2, and is canceled in other AZs. Then, set parameters as follows: | - | | | | - | | | - **cond:operation:status**: **abandon** | - | | | - **cond:operation:az**: **az0(normal), az1(sellout), az2(obt), az3(normal)** | - | | | | - | | | .. note:: | - | | | | - | | | Configure this parameter if the flavor status in an AZ is different from the **cond:operation:status** value. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_rate | String | Specifies the maximum bandwidth. | - | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:min_rate | String | Specified the assured bandwidth. | - | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_pps | String | Specifies the maximum intranet PPS. | - | | | | - | | | - Unit: number. If a value is in the unit of 10000, it must be divided by 10000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:charge | String | Specifies a billing type. | - | | | | - | | | - Both billing types are supported if this parameter is not set. | - | | | - Pay-per-use | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:compute | String | Specifies computing constraints. | - | | | | - | | | - **autorecovery**: indicates that automatic recovery is supported. | - | | | - If this parameter does not exist, automatic recovery is not supported. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. note:: - - For more information, see "ECS Specifications and Types" in *Elastic Cloud Server User Guide*. - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/flavors?availability_zone=availability_value - -Example Response ----------------- - -.. code-block:: - - { - "flavors": [ - { - "id": "c3.2xlarge.2", - "name": "c3.2xlarge.2", - "vcpus": "8", - "ram": 16384, - "disk": "0", - "swap": "", - "links": [ - { - "rel": "self", - "href": "https://ecs.region.xxx.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "type": null - }, - { - "rel": "bookmark", - "href": "https://ecs.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "type": null - } - ], - "OS-FLV-EXT-DATA:ephemeral": 0, - "rxtx_factor": 1, - "OS-FLV-DISABLED:disabled": false, - "rxtx_quota": null, - "rxtx_cap": null, - "os-flavor-access:is_public": true, - "os_extra_specs": { - "ecs:virtualization_env_types": "CloudCompute", - "ecs:generation": "c3", - "ecs:performancetype": "computingv3", - "resource_type": "IOoptimizedC3_2" - } - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/flavor_management/querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed.rst b/ecs/api-ref/result/apis_recommended/flavor_management/querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed.rst deleted file mode 100644 index 965ce047..00000000 --- a/ecs/api-ref/result/apis_recommended/flavor_management/querying_the_target_flavors_to_which_an_ecs_flavor_can_be_changed.rst +++ /dev/null @@ -1,230 +0,0 @@ -:original_name: en-us_topic_0110472767.html - -.. _en-us_topic_0110472767: - -Querying the Target Flavors to Which an ECS Flavor Can Be Changed -================================================================= - -Function --------- - -An ECS flavor cannot be changed to certain flavors. This API is used to query the target flavors to which a specified ECS flavor can be changed. - -URI ---- - -GET /v2.1/{project_id}/resize_flavors?instance_uuid={instance_uuid}&source_flavor_id={source_flavor_id}&source_flavor_name={source_flavor_name}&sort_key={sort_key}&sort_dir={sort_dir}&limit={limit}&marker={marker} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0110472767__table46110007: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. note:: - - One of the **instance_uuid**, **source_flavor_id**, and **source_flavor_name** parameters must be configured. If multiple parameters are configured, the system processes the **instance_uuid**, **source_flavor_id**, and **source_flavor_name** parameters in descending order by default. - -:ref:`Table 2 ` describes the query parameters. - -.. _en-us_topic_0110472767__table96861454162513: - -.. table:: **Table 2** Query parameters - - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+===========================================================================================================+ - | instance_uuid | No | String | Specifies the ID, in UUID format, of the target ECS. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | source_flavor_id | No | String | Specifies the source flavor ID. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | source_flavor_name | No | String | Specifies the source flavor name. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | sort_key | No | String | Indicates the field for sorting. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **flavorid**: indicates the flavor ID. The default value is **flavorid**. | - | | | | - **name**: indicates the flavor name. | - | | | | - **memory_mb**: indicates the memory size. | - | | | | - **vcpus**: indicates the number of vCPUs. | - | | | | - **root_gb**: indicates the system disk size. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | sort_dir | No | String | Specifies the ascending or descending sorting. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **asc**: indicates the ascending order. | - | | | | - **desc**: indicates the descending order. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the maximum number of flavors that can be displayed on one page. The default value is **1000**. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | marker | No | String | Uses the ID of the last flavor on one page as the paging marker. | - +--------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0110472767__table23477058: - -.. table:: **Table 3** Response parameters - - +-----------------+-----------------+------------------+--------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+================================================================================+ - | flavors | Yes | Array of objects | Specifies ECS flavors. | - | | | | | - | | | | For details, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+--------------------------------------------------------------------------------+ - -.. _en-us_topic_0110472767__table68941918122818: - -.. table:: **Table 4** **flavors** field description - - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============================+=================+==================+==========================================================================================+ - | id | Yes | String | Specifies the ECS flavor ID. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the name of the ECS flavor. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | vcpus | Yes | Integer | Specifies the number of vCPUs in the ECS flavor. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | ram | Yes | Integer | Specifies the memory size (MB) in the ECS flavor. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | disk | Yes | Integer | Specifies the system disk size in the ECS flavor. | - | | | | | - | | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | swap | No | String | Specifies the swap partition size required by the ECS flavor. | - | | | | | - | | | | This parameter has not been used. Its default value is **""**. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | OS-FLV-EXT-DATA:ephemeral | Yes | Integer | Specifies the temporary disk size. This is an extended attribute. | - | | | | | - | | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | OS-FLV-DISABLED:disabled | Yes | Boolean | This is an extended attribute, specifying whether a flavor is available. | - | | | | | - | | | | - **true**: indicates that a flavor is available. | - | | | | - **false**: indicates that a flavor is unavailable. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is not used. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | rxtx_factor | Yes | Float | This is an extended attribute. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is not used. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | rxtx_quota | Yes | String | Specifies the software constraints of the network bandwidth that can be used by the ECS. | - | | | | | - | | | | This parameter has not been used. Its default value is **null**. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | rxtx_cap | Yes | String | Specifies the hardware constraints of the network bandwidth that can be used by the ECS. | - | | | | | - | | | | This parameter has not been used. Its default value is **null**. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | os-flavor-access:is_public | Yes | Boolean | Specifies whether a flavor is available to all tenants. This is an extended attribute. | - | | | | | - | | | | - **true**: indicates that a flavor is available to all tenants. | - | | | | - **false**: indicates that a flavor is available only to certain tenants. | - | | | | | - | | | | Default value: **true** | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | links | Yes | Array of objects | Specifies the shortcut link of the ECS flavor. | - | | | | | - | | | | For details, see :ref:`Table 5 `. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - | extra_specs | Yes | Array of objects | Specifies the extended field of the ECS specifications. | - | | | | | - | | | | For details, see :ref:`Table 6 `. | - +----------------------------+-----------------+------------------+------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0110472767__table15913898194628: - -.. table:: **Table 5** **links** field description - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+====================================================================================================+ - | rel | Yes | String | Specifies the shortcut link marker name. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------+ - | href | Yes | String | Specifies the shortcut link. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------+ - | type | Yes | String | Specifies the shortcut link type. This parameter has not been used. Its default value is **null**. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/resize_flavors?source_flavor_id=c3.xlarge.2 - -Example Response ----------------- - -.. code-block:: - - { - "flavors": [ - { - "id": "c3.15xlarge.2", - "name": "c3.15xlarge.2", - "vcpus": "60", - "ram": 131072, - "disk": "0", - "swap": "", - "links": [ - { - "rel": "self", - "href": "https://compute-ext.region.xxx.com/v1.0/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", - "type": null - }, - { - "rel": "bookmark", - "href": "https://compute-ext.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.15xlarge.2", - "type": null - } - ], - "OS-FLV-EXT-DATA:ephemeral": 0, - "rxtx_factor": 1, - "OS-FLV-DISABLED:disabled": false, - "rxtx_quota": null, - "rxtx_cap": null, - "os-flavor-access:is_public": true, - "extra_specs": { - "ecs:virtualization_env_types": "CloudCompute", - "ecs:generation": "c3", - "ecs:performancetype": "computingv3", - "resource_type": "IOoptimizedC3_2" - } - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/index.rst b/ecs/api-ref/result/apis_recommended/index.rst deleted file mode 100644 index cee0918d..00000000 --- a/ecs/api-ref/result/apis_recommended/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _en-us_topic_0124385011: - -================== -APIs (Recommended) -================== - -.. toctree:: - :maxdepth: 1 - - lifecycle_management/index - status_management/index - batch_operations/index - flavor_management/index - nic_management/index - disk_management/index - tenant_quota_management/index - task_status_management/index - tag_management/index - ecs_group_management/index diff --git a/ecs/api-ref/result/apis_recommended/lifecycle_management/creating_an_ecs.rst b/ecs/api-ref/result/apis_recommended/lifecycle_management/creating_an_ecs.rst deleted file mode 100644 index 6262cac2..00000000 --- a/ecs/api-ref/result/apis_recommended/lifecycle_management/creating_an_ecs.rst +++ /dev/null @@ -1,611 +0,0 @@ -:original_name: en-us_topic_0020212668.html - -.. _en-us_topic_0020212668: - -Creating an ECS -=============== - -.. _en-us_topic_0020212668__section61372619: - -Function --------- - -This API is used to create one or more ECSs. - -This is an asynchronous API. After the ECS creation request is issued, the system will return **job_id**. The ECS creation is still in progress. Therefore, you need to call the API described in :ref:`Querying Task Execution Status ` to obtain the task status. When the status changes to **SUCCESS**, the ECS has been created. - -Before calling this API, you need to obtain `Regions and Endpoints `__. - -Logging in to an ECS can be authenticated using either a key pair or password. For security purposes, you are advised to use key pair authentication. - -- Key pair - - A key pair is used for ECS login authentication. - - Method of calling APIs: Use the **key_name** field to specify the key file used for logging in to the ECS. - -- Password - - If you choose the initial password for authentication in an ECS, you can log in to the ECS using the username and its initial password. The initial password of user **root** is used for authentication in Linux, while that of user **Administrator** is used for authentication in Windows. - - Method of calling APIs: Use the **adminPass** field to specify the initial login password of the administrator account. For details about how to use the **adminPass** field, see :ref:`Table 3 `. If an encrypted password is required for logging in to a Linux ECS that is created using an image with Cloud-Init installed, you can use the **user_data** field to inject the password. For details, see :ref:`Table 3 `. - - .. note:: - - If the **user_data** field is specified for a Linux ECS that is created using an image with Cloud-Init installed, the **adminPass** field becomes invalid. - -- Image password - - If you use a Linux private image to create an ECS, you can use the image password for login authentication. - - Method of calling APIs: If the image password is used, the **key_name** and **adminPass** fields do not need to be specified. - -URI ---- - -POST /v1/{project_id}/cloudservers - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212668__table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. _en-us_topic_0020212668__section5126234: - -Request -------- - -**Request parameters** - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212668__en-us_topic_0057972661_table40519951: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================+ - | server | Yes | Object | Specifies the ECS information. For details, see :ref:`Table 3 `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | dry_run | No | Boolean | Specifies whether to check the request and create the ECS. | - | | | | | - | | | | - **true**: indicates that only the request is sent, but the ECS will not be created. Check items include mandatory parameters and request format. | - | | | | | - | | | | - If the check fails, the system returns an error. | - | | | | - If the check is successful, the system returns status code 202. | - | | | | | - | | | | - **false**: indicates that the request is sent and the ECS will be created if the check result is as expected. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212668__table761103195216: - -.. table:: **Table 3** Parameters for creating an ECS - - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+==================+========================================================================================================================================================================================================================================================================================================================================================================================+ - | imageRef | Yes | String | Specifies the ID of the system image used for creating ECSs. The ID is in Universally Unique Identifier (UUID) format. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - Certain ECS flavors cannot support all public images provided on the public cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the **Create ECS** page, and obtain the image IDs on the **Image Management Service** page. | - | | | | - If the creation fails, modify the parameter settings. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavorRef | Yes | String | Specifies the flavor ID of the ECS to be created. | - | | | | | - | | | | For details about the flavors that have been released, see "Instances" in *Elastic Cloud Server User Guide*. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the ECS name. | - | | | | | - | | | | Value requirements: | - | | | | | - | | | | - Consists of 1 to 64 characters, including letters, digits, underscores (_), hyphens (-), periods (.). | - | | | | - If more than one ECS is to be created (the **count** value is greater than **1**), the system automatically adds a hyphen followed by a four-digit incremental number, such as **-0000**, to the end of each ECS name. If you specify a number, the name of the first new ECS will start from the specified number. In this case, the ECS name contains a maximum of 59 characters. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | ECS hostnames comply with `RFC952 `__ and `RFC1123 `__ naming rules. It is recommended that you configure hostnames using digits, letters (case sensitive), and hyphens (-). Underscores (_) are converted into hyphens (-) by default. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_data | No | String | Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The content of **user_data** must be encoded with base64. | - | | | | - The maximum size of the content to be injected (before encoding) is 32 KB. | - | | | | | - | | | | For more information about the user data to be injected, see "Injecting User Data into ECSs" in *Elastic Cloud Server User Guide*. | - | | | | | - | | | | Examples | - | | | | | - | | | | Before base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | #! /bin/bash | - | | | | echo user_test >> /home/user.txt | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | rem cmd | - | | | | echo 111 > c:\aaa.txt | - | | | | | - | | | | After base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA== | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0 | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | adminPass | No | String | Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is **root**, and the Windows administrator is **Administrator**. For details, see :ref:`Function `. | - | | | | | - | | | | Password complexity requirements: | - | | | | | - | | | | - Consists of 8 to 26 characters. | - | | | | - The password must contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters (!@$%^-_=+[{}]:,./?~#*). | - | | | | - The password cannot contain the username or the username in reverse. | - | | | | - The Windows ECS password cannot contain the username, the username in reverse, or more than two consecutive characters in the username. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_name | No | String | Specifies the name of the SSH key used for logging in to the ECS. | - | | | | | - | | | | Keys can be created using the key creating API (:ref:`Creating and Importing an SSH Key Pair `) or obtained using the SSH key query API (:ref:`Querying SSH Key Pairs `). | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpcid | Yes | String | Specifies the ID of the VPC to which the ECS belongs. The value is in the format of the UUID. | - | | | | | - | | | | You can obtain the VPC ID from the management console or by following the instructions provided in "Querying VPCs" in *Virtual Private Cloud API Reference*. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nics | Yes | Array of objects | Specifies the NIC information of the ECS. For details, see :ref:`Table 4 `. | - | | | | | - | | | | Constraints: | - | | | | | - | | | | - The value must be the ID of the subnet created in the VPC specified by **vpcid** and in the format of the UUID. | - | | | | | - | | | | - A maximum of 12 NICs can be attached to an ECS. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publicip | No | Object | Specifies the EIP of the ECS, which can be configured in the following ways: | - | | | | | - | | | | - Do not use: In such a case, this field is unavailable. | - | | | | - Automatically assign: The system will automatically assign an EIP to your ECS. | - | | | | - Use existing: You need to specify an existing EIP for your ECS. | - | | | | | - | | | | For details, see :ref:`Table 1 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | count | No | Integer | Specifies the number of ECSs to be created. | - | | | | | - | | | | Constraints: | - | | | | | - | | | | - If this parameter is not specified, the default value is **1**. | - | | | | - If the quota is sufficient, the maximum value is **500**. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | root_volume | Yes | Object | Specifies ECS system disk configurations. | - | | | | | - | | | | For details, see :ref:`Table 5 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_volumes | No | Array of objects | Specifies ECS data disk configurations. Each data structure represents a data disk to be created. | - | | | | | - | | | | An ECS can be attached with a maximum of 59 data disks (certain flavors support only 23 data disks). | - | | | | | - | | | | For details, see :ref:`Table 6 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of objects | Specifies the security groups of the ECS. | - | | | | | - | | | | If this parameter is left blank, the default security group is bound to the ECS by default. | - | | | | | - | | | | For details, see :ref:`Table 2 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | Specifies the name of the AZ where the ECS is located. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If this parameter is not specified, the system automatically selects an AZ. | - | | | | | - | | | | See :ref:`Querying AZs `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extendparam | No | Object | Provides the supplementary information about the ECS to be created. | - | | | | | - | | | | For details, see :ref:`Table 6 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the metadata of the ECS to be created. | - | | | | | - | | | | You can use metadata to customize key-value pairs. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - A maximum of 10 key-value pairs can be injected. | - | | | | - A metadata key consists of 1 to 255 characters and contains only uppercase letters, lowercase letters, digits, hyphens (-), underscores (_), colons (:), and decimal points (.). | - | | | | - A metadata value consists of a maximum of 255 characters. | - | | | | | - | | | | For details about reserved key-value pairs, see :ref:`Table 8 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os:scheduler_hints | No | Object | Schedules ECSs, for example, by configuring an ECS group. | - | | | | | - | | | | For details, see :ref:`Table 9 `. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | Array of strings | Specifies ECS tags. | - | | | | | - | | | | A tag is in the format of "key.value", where the maximum lengths of **key** and **value** are 36 and 43 characters, respectively. | - | | | | | - | | | | When adding a tag to an ECS, ensure that the tag complies with the following requirements: | - | | | | | - | | | | - The key of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). | - | | | | - The value of the tag can contain only uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-). | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - When you create ECSs, one ECS supports up to 10 tags. | - +--------------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212668__table9120223: - -.. table:: **Table 4** **nics** field description - - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+=================================================================================================================================================+ - | subnet_id | Yes | String | Specifies the subnet of the ECS. | - | | | | | - | | | | The value must be the ID of the subnet created in the VPC specified by **vpcid** and in the format of the UUID. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | Specifies the IP address of the NIC used by the ECS. The value is an IPv4 address. | - | | | | | - | | | | Constraints: | - | | | | | - | | | | - If this parameter is left blank or set to **""**, an unused IP address in the subnet is automatically assigned as the IP address of the NIC. | - | | | | - If this parameter is specified, its value must be an unused IP address in the network segment of the subnet. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | binding:profile | No | Object | Allows you to customize data. Configure this parameter when creating a HANA ECS. | - | | | | | - | | | | For details, see :ref:`Table 11 `. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra_dhcp_opts | No | Array of objects | Indicates extended DHCP options. | - | | | | | - | | | | For details, see :ref:`Table 12 `. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212668__table53188122: - -.. table:: **Table 5** **root_volume** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================================================================================================================================================================================================================================================================================================================================+ - | volumetype | Yes | String | Specifies the ECS system disk type, which must be one of available disk types. | - | | | | | - | | | | Currently, the value can be **SSD**, **SAS**, **SATA**, **co-p1**, or **uh-l1**. | - | | | | | - | | | | - **SSD**: specifies the ultra-high I/O disk type. | - | | | | | - | | | | - **SAS**: specifies the high I/O disk type. | - | | | | | - | | | | - **SATA**: specifies the common I/O disk type. | - | | | | | - | | | | - **co-p1**: specifies the high I/O (performance-optimized I) disk type. | - | | | | | - | | | | - **uh-l1**: specifies the ultra-high I/O (latency-optimized) disk type. | - | | | | | - | | | | Disks of the **co-p1** and **uh-l1** types are used exclusively for HPC ECSs and SAP HANA ECSs. | - | | | | | - | | | | If the specified disk type is not available in the AZ, the disk will fail to create. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - When the disk is created from a backup: | - | | | | | - | | | | If the type of the backup's source disk is **SSD**, **SAS**, or **SATA**, you can create disks of any of these types. | - | | | | | - | | | | If the type of the backup's source disk is **co-p1** or **uh-l1**, you can create disks of any of the two types. | - | | | | | - | | | | - For details about disk types, see **Disk Types and Disk Performance** in the *Elastic Volume Service User Guide*. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | No | Integer | Specifies the system disk size, in GB. The value ranges from 1 to 1024. | - | | | | | - | | | | Constraints: | - | | | | | - | | | | - The system disk size must be greater than or equal to the minimum system disk size supported by the image (**min_disk** attribute of the image). | - | | | | - If this parameter is not specified or is set to **0**, the default system disk size is the minimum value of the system disk in the image (**min_disk** attribute of the image). | - | | | | | - | | | | .. note:: | - | | | | | - | | | | To obtain the minimum system disk size (**min_disk**) of an image, click the image on the management console for its details. Alternatively, call the native OpenStack API for querying details about an image. For details, see "Querying Image Details (Native OpenStack)" in *Image Management Service API Reference*. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hw:passthrough | No | Boolean | Pay attention to this parameter if your ECS is SDI-compliant. If the value of this parameter is **true**, the created disk is of SCSI type. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is of boolean type. If a non-boolean character is imported, the parameter value is set to **false**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the EVS disk metadata. Ensure that **key** and **value** in the metadata contain at most 255 bytes. | - | | | | | - | | | | This field is used only when an encrypted disk is created. | - | | | | | - | | | | For details, see :ref:`metadata Field Description for Creating Disks `. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212668__table66739923: - -.. table:: **Table 6** **data_volumes** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================================================+ - | volumetype | Yes | String | Specifies the type of the ECS data disk, which must be one of available disk types. | - | | | | | - | | | | Currently, the value can be **SSD**, **SAS**, **SATA**, **co-p1**, or **uh-l1**. | - | | | | | - | | | | - **SSD**: specifies the ultra-high I/O disk type. | - | | | | | - | | | | - **SAS**: specifies the high I/O disk type. | - | | | | | - | | | | - **SATA**: specifies the common I/O disk type. | - | | | | | - | | | | - **co-p1**: specifies the high I/O (performance-optimized I) disk type. | - | | | | | - | | | | - **uh-l1**: specifies the ultra-high I/O (latency-optimized) disk type. | - | | | | | - | | | | Disks of the **co-p1** and **uh-l1** types are used exclusively for HPC ECSs and SAP HANA ECSs. | - | | | | | - | | | | If the specified disk type is not available in the AZ, the disk will fail to create. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - When the disk is created from a backup: | - | | | | | - | | | | If the type of the backup's source disk is **SSD**, **SAS**, or **SATA**, you can create disks of any of these types. | - | | | | | - | | | | If the type of the backup's source disk is **co-p1** or **uh-l1**, you can create disks of any of the two types. | - | | | | | - | | | | - For details about disk types, see **Disk Types and Disk Performance** in the *Elastic Volume Service User Guide*. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Integer | Specifies the data disk size, in GB. The value ranges from 10 to 32768. | - | | | | | - | | | | When you use a data disk image to create a data disk, ensure that the value of this parameter is greater than or equal to the size of the source data disk that is used to create the data disk image. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shareable | No | Boolean | Specifies whether the disk is shared. The value can be **true** (specifies a shared disk) or **false** (a common EVS disk). | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This field has been discarded. Use **multiattach**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | multiattach | No | Boolean | Specifies the shared disk information. | - | | | | | - | | | | - **true**: indicates that the created disk is a shared disk. | - | | | | - **false**: indicates that the created disk is a common EVS disk. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | The **shareable** field is not used anymore. If both **shareable** and **multiattach** must be used, ensure that the values of the two fields are the same. If this parameter is not specified, common EVS disks are created by default. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hw:passthrough | No | Boolean | Indicates whether the data volume uses a SCSI lock. | - | | | | | - | | | | - If this parameter is set to **true**, the disk device type is SCSI, which allows ECS OSs to directly access the underlying storage media. SCSI reservation commands are supported. | - | | | | - If this parameter is set to **false**, the disk device type is VBD, which supports only simple SCSI read/write commands. | - | | | | - If this parameter does not appear, the disk device type is VBD. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is of boolean type. If a non-boolean character is imported, the parameter value is set to **false**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extendparam | No | Object | Provides the disk information. | - | | | | | - | | | | For details, see :ref:`Table 5 `. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_image_id | No | String | Specifies ID of the data image. The value is in UUID format. | - | | | | | - | | | | If data disks are created using a data disk image, this parameter is mandatory and it does not support metadata. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the EVS disk metadata. Ensure that **key** and **value** in the metadata contain at most 255 bytes. | - | | | | | - | | | | This field is used only when an encrypted disk is created. | - | | | | | - | | | | If data disks are created using a data disk image, this field cannot be used. | - | | | | | - | | | | For details, see :ref:`metadata Field Description for Creating Disks `. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter | Type | Description | -+===========+========+====================================================================================================================================================================================================================================================+ -| job_id | String | Specifies the returned task ID after delivering the task. You can query the task progress using this ID. For details about how to query the task execution status based on **job_id**, see :ref:`Task Status Management `. | -+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -For details about abnormal responses, see :ref:`Responses (Task) `. - -Example Request ---------------- - -The public cloud platform provides various ECS types. The flavor name/ID varies depending on ECS types and specifications. When you use APIs to create ECSs with different specifications, the request bodies are the same. You only need to change the parameter values in the following request example based on the parameters described in :ref:`Request `. - -- Example URL request - - .. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers - -- An ECS with flavor ID **m3.larger** is to be created, where the image ID is **imageid_123**, disk type is **SSD**, and VPC ID is **0dae26c9-9a70-4392-93f3-87d53115d171**. An example request is as follows: - - .. code-block:: - - { - "server": { - "availability_zone":"az1-dc1", - "name": "newserver", - "imageRef": "imageid_123", - "root_volume": { - "volumetype": "SSD" - }, - "data_volumes": [ - { - "volumetype": "SSD", - "size": 100 - }, - { - "volumetype": "SSD", - "size": 100, - "multiattach": true, - "hw:passthrough": true - } - ], - "flavorRef": "m3.larger", - "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", - "security_groups": [ - { - "id": "507ca48f-814c-4293-8706-300564d54620" - } - ], - "nics": [ - { - "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83", - "extra_dhcp_opts":[ - { - "opt_value": 8888, - "opt_name": "26" - } - ] - } - ], - "publicip": { - "eip": { - "iptype": "5_bgp", - "bandwidth": { - "size": 10, - "sharetype": "PER" - } - } - }, - "key_name": "sshkey-123", - "count": 1 - } - } - -- An ECS is to be created using a full-ECS image, in which two data disks are contained. The disk settings of the newly created ECS are as follows: - - - The system disk is encrypted. - - For the two data disks to be restored, one uses default settings, and the other uses the changed settings, SSD, 100 GB. - - In addition to the two data disks to be restored, a new data disk is to be attached to the ECS, and the settings of the disk are SSD, 50 GB. - - An example request is as follows: - - .. code-block:: - - { - "server": { - "availability_zone":"az1-dc1", - "name": "wholeImageServer", - "imageRef": "ff49b1f1-3e3e-4913-89c6-a026041661e8", - "root_volume": { - "volumetype": "SSD", - "metadata": { - "__system__encrypted": "1", - "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" - } - }, - "data_volumes": [ - { - "volumetype": "SSD", - "size": 100, - "extendparam":{ - "snapshotId": "ef020653-9742-4d24-8672-10af42c9702b" - } - }, - { - "volumetype": "SSD", - "size": 50 - } - ], - "flavorRef": "s2.large.2", - "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", - "security_groups": [ - { - "id": "507ca48f-814c-4293-8706-300564d54620" - } - ], - "nics": [ - { - "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" - } - ], - "key_name": "sshkey-123" - } - } - -- An example pre-verification request body is as follows: - - .. code-block:: - - { - "dry_run": true - "server": { - "availability_zone":"az1-dc1", - "name": "newserver", - "imageRef": "1189efbf-d48b-46ad-a823-94b942e2a000", - "root_volume": { - "volumetype": "SSD" - }, - "data_volumes": [ ], - "flavorRef": "s3.xlarge.2", - "vpcid": "0dae26c9-9a70-4392-93f3-87d53115d171", - "security_groups": [ - { - "id": "507ca48f-814c-4293-8706-300564d54620" - } - ], - "nics": [ - { - "subnet_id": "157ee789-03ea-45b1-a698-76c92660dd83" - } - ], - "key_name": "sshkey-123", - "count": 1 - } - } - -Example Response ----------------- - -.. code-block:: - - { - "job_id": "93c82933d6b7827d3016b8771f2070873" - } - -Or - -.. code-block:: - - { - "error": { - "code": "request body is illegal.", - "message": "Ecs.0005" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/lifecycle_management/deleting_ecss.rst b/ecs/api-ref/result/apis_recommended/lifecycle_management/deleting_ecss.rst deleted file mode 100644 index 9a2507ec..00000000 --- a/ecs/api-ref/result/apis_recommended/lifecycle_management/deleting_ecss.rst +++ /dev/null @@ -1,130 +0,0 @@ -:original_name: en-us_topic_0020212679.html - -.. _en-us_topic_0020212679: - -Deleting ECSs -============= - -Function --------- - -This API is used to delete ECSs based on a specified ECS ID list. - -You can delete a single ECS or multiple ECSs in a batch. A maximum of 1000 ECSs can be deleted in a batch. - -URI ---- - -POST /v1/{project_id}/cloudservers/delete - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212679__table52652517: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212679__table8361976: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+===========================================================================================================================================================================================================================================+ - | servers | Yes | Array of objects | Specifies the ECSs to be deleted. For details, see :ref:`Table 3 `. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | delete_publicip | No | Boolean | Specifies whether to delete the EIP bound to the ECS when deleting the ECS. If you do not want to delete the EIP, the system only unbinds the EIP from the ECS and reserves the IP address. | - | | | | | - | | | | The value can be **true** or **false**. | - | | | | | - | | | | - **true**: When an ECS is deleted, the EIP bound to the ECS is also released regardless of whether **delete_on_termination** of the EIP is **true** or **false**. | - | | | | - **false**: When an ECS is deleted, the EIP is only unbound from the ECS and will not be released regardless of whether **delete_on_termination** of the EIP is **true** or **false**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If **delete_publicip** is not specified, the **delete_on_termination** value of the EIP decides whether the EIP is released when the ECS is deleted. | - | | | | | - | | | | - If **delete_on_termination** is **true** and **delete_public** is **null**, the EIP is released when the ECS is deleted. | - | | | | - If **delete_on_termination** is **false** and **delete_public** is **null**, the EIP is only unbound from the ECS and will not be released when the ECS is deleted. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | delete_volume | No | Boolean | Specifies whether to delete the data disks attached to an ECS when deleting the ECS. If you set the parameter value to **false**, the system only detaches the disks from the ECS and reserves the disks. The default value is **false**. | - | | | | | - | | | | - **true**: indicates to delete the data disks attached to the ECS when deleting the ECS. | - | | | | - **false**: indicates only to detach the data disks attached to the ECS when deleting the ECS. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212679__table32603030: - -.. table:: **Table 3** **servers** field description - - ========= ========= ====== ========================================== - Parameter Mandatory Type Description - ========= ========= ====== ========================================== - id Yes String Specifies the ID of the ECS to be deleted. - ========= ========= ====== ========================================== - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -Example request - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/delete - -.. code-block:: - - { - "servers": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" - } - ], - "delete_publicip": false, - "delete_volume": false - } - -Example Response ----------------- - -.. code-block:: - - { - "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" - } - -Or - -.. code-block:: - - { - "error": { - "message": "request body is illegal.", - "code": "Ecs.0005" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/lifecycle_management/index.rst b/ecs/api-ref/result/apis_recommended/lifecycle_management/index.rst deleted file mode 100644 index e300152d..00000000 --- a/ecs/api-ref/result/apis_recommended/lifecycle_management/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0020212657: - -==================== -Lifecycle Management -==================== - -.. toctree:: - :maxdepth: 1 - - creating_an_ecs - deleting_ecss diff --git a/ecs/api-ref/result/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst deleted file mode 100644 index 7b541e5a..00000000 --- a/ecs/api-ref/result/apis_recommended/nic_management/adding_nics_to_an_ecs_in_a_batch.rst +++ /dev/null @@ -1,112 +0,0 @@ -:original_name: en-us_topic_0020212663.html - -.. _en-us_topic_0020212663: - -Adding NICs to an ECS in a Batch -================================ - -Function --------- - -This API is used to add one or multiple NICs to an ECS. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/nics - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212663__table54800025: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212663__table23831236: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+==========================================================================================================+ - | nics | Yes | Array of objects | Specifies the NICs to be added. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212663__table58396974: - -.. table:: **Table 3** **nics** field description - - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+==================================================================================================================+ - | subnet_id | Yes | String | Specifies the information about the NICs to be added to an ECS. | - | | | | | - | | | | The value must be the ID of a created network in UUID format. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of objects | Specifies the security groups for NICs. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------+ - | ip_address | No | String | Specifies the IP address. If this parameter is unavailable, the IP address is automatically assigned. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212663__table16100147: - -.. table:: **Table 4** **security_groups** field description - - ========= ========= ====== ======================================= - Parameter Mandatory Type Description - ========= ========= ====== ======================================= - id Yes String Specifies the ID of the security group. - ========= ========= ====== ======================================= - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics - -.. code-block:: - - { - "nics": [ - { - "subnet_id": "d32019d3-bc6e-4319-9c1d-6722fc136a23", - "security_groups": [ - { - "id": "f0ac4394-7e4a-4409-9701-ba8be283dbc3" - } - ] - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst deleted file mode 100644 index 5cd69c44..00000000 --- a/ecs/api-ref/result/apis_recommended/nic_management/deleting_nics_from_an_ecs_in_a_batch.rst +++ /dev/null @@ -1,100 +0,0 @@ -:original_name: en-us_topic_0020212665.html - -.. _en-us_topic_0020212665: - -Deleting NICs from an ECS in a Batch -==================================== - -Function --------- - -This API is used to uninstall and delete one or multiple NICs from an ECS. - -Constraints ------------ - -The primary NIC of an ECS has routing rules configured and cannot be deleted. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/nics/delete - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212665__table42885739: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212665__table35856517: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================+ - | nics | Yes | Array of objects | Specifies the NICs to be deleted. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212665__table43212049: - -.. table:: **Table 3** **nics** field description - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================================+ - | id | Yes | String | Specifies the port ID of the NIC. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | When the ID is the same as the ECS primary NIC ID, the system will return error code 403. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/nics/delete - -.. code-block:: - - { - "nics": [ - { - "id": "d32019d3-bc6e-4319-9c1d-6722fc136a23" - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/nic_management/index.rst b/ecs/api-ref/result/apis_recommended/nic_management/index.rst deleted file mode 100644 index 9edd6dfb..00000000 --- a/ecs/api-ref/result/apis_recommended/nic_management/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0124385012: - -============== -NIC Management -============== - -.. toctree:: - :maxdepth: 1 - - adding_nics_to_an_ecs_in_a_batch - deleting_nics_from_an_ecs_in_a_batch diff --git a/ecs/api-ref/result/apis_recommended/status_management/adding_an_ecs_to_the_monitoring_list.rst b/ecs/api-ref/result/apis_recommended/status_management/adding_an_ecs_to_the_monitoring_list.rst deleted file mode 100644 index e48f5427..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/adding_an_ecs_to_the_monitoring_list.rst +++ /dev/null @@ -1,78 +0,0 @@ -:original_name: en-us_topic_0081529857.html - -.. _en-us_topic_0081529857: - -Adding an ECS to the Monitoring List -==================================== - -Function --------- - -This API is used to add an ECS to the monitoring list. - -Ceilometer periodically collects monitoring data on the ECSs added to the monitoring list and reports the data to Cloud Eye. The data includes the platform version, CPU, memory, NICs, disks, and hardware version. For example, the plug-in of an SAP ECS periodically obtains monitoring data from Cloud Eye and reports the data to SAP in reports. - -URI ---- - -POST /v1.0/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0081529857__table3713317418952: - -.. table:: **Table 1** Parameter description - - ========= ========= ===================== - Parameter Mandatory Description - ========= ========= ===================== - server_id Yes Specifies the ECS ID. - ========= ========= ===================== - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0081529857__table20892986181041: - -.. table:: **Table 2** Request parameters - - ============== ========= ==== ============================== - Parameter Mandatory Type Description - ============== ========= ==== ============================== - monitorMetrics Yes Null Enables monitoring on the ECS. - ============== ========= ==== ============================== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1.0/servers/{server_id}/action - -.. code-block:: - - { - "monitorMetrics" : null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst b/ecs/api-ref/result/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst deleted file mode 100644 index 3ed99cce..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/changing_an_ecs_os_using_an_image_with_cloud-init_installed.rst +++ /dev/null @@ -1,209 +0,0 @@ -:original_name: en-us_topic_0067876971.html - -.. _en-us_topic_0067876971: - -Changing an ECS OS (Using an Image with Cloud-Init Installed) -============================================================= - -Function --------- - -This API is used to change an ECS OS. During the system disk reinstallation using a new image, the data disks of the ECS remain unchanged. - -After this API is called, the system uninstalls the system disk, uses the new image to create a system disk, and attaches it to the ECS. In this way, the OS is changed. - -Constraints ------------ - -- You can only use an image with Cloud-Init or Cloudbase-Init installed. -- Only a stopped ECS or an ECS on which reinstalling or changing the OS failed supports changing OS. -- Only an ECS with a system disk supports changing OS. -- You are not allowed to perform other operations when changing the OS. Otherwise, changing the OS will fail. - -URI ---- - -POST /v2/{project_id}/cloudservers/{server_id}/changeos - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067876971__table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0067876971__table2840889: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=============================================================================================+ - | os-change | Yes | Object | Changes an ECS OS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067876971__table32200631: - -.. table:: **Table 3** **os-change** field description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================+ - | keyname | Yes | String | Specifies the key pair name. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | userid | No | String | Specifies the user ID. When the **keyname** parameter is being specified, the value of this parameter is used preferentially. If this parameter is left blank, the user ID in the token is used by default. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | imageid | Yes | String | Specifies the ID of the new image in UUID format. | - | | | | | - | | | | You can obtain the image ID from the console or by following the instructions provided in "Querying Images" in *Image Management Service API Reference*. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the metadata of the ECS for which the OS is to be changed. | - | | | | | - | | | | For more information, see :ref:`Table 4 `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067876971__table9120223: - -.. table:: **Table 4** **metadata** field description - - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +======================+=================+=================+========================================================================================================================================================+ - | BYOL | No | String | Specifies whether a user has the license of an image. | - | | | | | - | | | | - If this parameter is set to **true**, the license file delivered with the image is used, indicating that BYOL is used. | - | | | | - If this parameter is set to a value other than **true**, BYOL is not used, and the license file provided by the public cloud platform must be used. | - | | | | | - | | | | The default value is not **true**, indicating that BYOL is not used. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_data | No | String | Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The content of **user_data** must be encoded with base64. | - | | | | - The maximum size of the content to be injected (before encoding) is 32 KB. | - | | | | | - | | | | For more details, see "Injecting User Data into ECSs" in *Elastic Cloud Server User Guide*. | - | | | | | - | | | | Examples | - | | | | | - | | | | Before base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | #! /bin/bash | - | | | | echo user_test >> /home/user.txt | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | rem cmd | - | | | | echo 111 > c:\aaa.txt | - | | | | | - | | | | After base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA== | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0 | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \__system__encrypted | No | String | Specifies encryption in **metadata**. The value can be **0** (encryption disabled) or **1** (encryption enabled). | - | | | | | - | | | | If this parameter does not exist, the system disk will not be encrypted by default. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \__system__cmkid | No | String | Specifies the CMK ID, which indicates encryption in **metadata**. This parameter is used with **\__system__encrypted**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For details about how to obtain the CMK ID, see "Querying the List of CMKs" in *Key Management Service API Reference*. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -- Example URL request - - .. code-block:: - - POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/changeos - -- Example request 1 (using a password to remotely log in to an ECS with OS changed) - - .. code-block:: - - { - "os-change": { - "adminpass": "1qazXSW@", - "userid": "7e25b1da389f4697a79df3a0e5bd494e", - "imageid": "e215580f-73ad-429d-b6f2-5433947433b0" - } - } - -- Example request 2 (using a key to remotely log in to an ECS with OS changed) - - .. code-block:: - - { - "os-change": { - "keyname": "KeyPair-350b", - "userid": "7e25b1da389f4697a79df3a0e5bd494e", - "imageid": "e215580f-73ad-429d-b6f2-5433947433b0" - } - } - -- Example request 3 (using a password to remotely log in a full-ECS-image-created ECS with OS changed and system disk encrypted) - - .. code-block:: - - { - "os-change": { - "adminpass": "1qazXSW@", - "userid": "7e25b1da389f4697a79df3a0e5bd494e", - "imageid": "e215580f-73ad-429d-b6f2-5433947433b0", - "metadata": { - "__system__encrypted": "1", - "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" - } - } - } - -Example Response ----------------- - -See :ref:`Responses (Task) `. - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/status_management/cold_migrating_an_ecs.rst b/ecs/api-ref/result/apis_recommended/status_management/cold_migrating_an_ecs.rst deleted file mode 100644 index 89b17fae..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/cold_migrating_an_ecs.rst +++ /dev/null @@ -1,106 +0,0 @@ -:original_name: en-us_topic_0132905656.html - -.. _en-us_topic_0132905656: - -Cold Migrating an ECS -===================== - -Function --------- - -- An ECS deployed on a DeH can be migrated to another DeH. -- An ECS deployed on a DeH can be migrated to a public resource pool. -- An ECS deployed in a public resource pool can be migrated to a DeH. - -Constraints ------------ - -- This API is supported by DeHs only. -- Only a stopped ECS can be cold migrated. -- Existing constraints of the native cold migration API are inherited. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/migrate - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0132905656__table29396722: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0132905656__table6742880: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================+ - | migrate | Yes | Object | Specifies the ECS to be migrated. For details, see :ref:`Table 3 `. | - | | | | | - | | | | When migrating an ECS from a DeH to a public resource pool, the **migrate** value is null. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0132905656__table7657338: - -.. table:: **Table 3** **migrate** field description - - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+===================================================================================================================================+ - | dedicated_host_id | No | String | Specifies the DeH ID. | - | | | | | - | | | | This parameter takes effect when an ECS is migrated from a public resource pool to a DeH or when an ECS is migrated between DeHs. | - +-------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/migrate - -.. code-block:: - - { - "migrate": { - "dedicated_host_id": "459a2b9d-804a-4745-ab19-a113bb1b4ddc" - } - } - Or - { - "migrate": null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/status_management/index.rst b/ecs/api-ref/result/apis_recommended/status_management/index.rst deleted file mode 100644 index 742f93fc..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0020212691: - -================= -Status Management -================= - -.. toctree:: - :maxdepth: 1 - - reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed - changing_an_ecs_os_using_an_image_with_cloud-init_installed - querying_automatic_recovery_of_an_ecs - cold_migrating_an_ecs - modifying_the_specifications_of_an_ecs - adding_an_ecs_to_the_monitoring_list diff --git a/ecs/api-ref/result/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst b/ecs/api-ref/result/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst deleted file mode 100644 index b9fb75ef..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/modifying_the_specifications_of_an_ecs.rst +++ /dev/null @@ -1,96 +0,0 @@ -:original_name: en-us_topic_0020212653.html - -.. _en-us_topic_0020212653: - -Modifying the Specifications of an ECS -====================================== - -Function --------- - -ECS specifications can be modified, for example, upgrading the vCPUs and memory, to meet service requirements. This API is used to modify ECS specifications. - -An ECS flavor cannot be changed to certain flavors. For details, see :ref:`Querying the Target Flavors to Which an ECS Flavor Can Be Changed `. - -Constraints ------------ - -- You can modify the ECS specifications only when the ECS is stopped. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/resize - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212653__table29396722: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212653__table6742880: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===============================================================================================================================+ - | resize | Yes | Object | Specifies the operation to modify ECS specifications. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212653__table7657338: - -.. table:: **Table 3** **resize** field description - - +-----------+-----------+--------+------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================+ - | flavorRef | Yes | String | Specifies the flavor ID of the ECS after the modification. | - +-----------+-----------+--------+------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/resize - -.. code-block:: - - { - "resize": { - "flavorRef": "c3.15xlarge.2" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/status_management/querying_automatic_recovery_of_an_ecs.rst b/ecs/api-ref/result/apis_recommended/status_management/querying_automatic_recovery_of_an_ecs.rst deleted file mode 100644 index c86ffeb2..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/querying_automatic_recovery_of_an_ecs.rst +++ /dev/null @@ -1,80 +0,0 @@ -:original_name: en-us_topic_0067600148.html - -.. _en-us_topic_0067600148: - -Querying Automatic Recovery of an ECS -===================================== - -Function --------- - -This API is used to query automatic recovery configured for an ECS. - -URI ---- - -GET /v1/{project_id}/cloudservers/{server_id}/autorecovery - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067600148__table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0067600148__en-us_topic_0057973216_table30138413: - -.. table:: **Table 2** Response parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================+ - | support_auto_recovery | String | Queries automatic recovery configured for an ECS. | - | | | | - | | | - **true**: indicates that automatic recovery is configured for an ECS. | - | | | - **false**: indicates that automatic recovery is not configured for an ECS. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - -Example Request ---------------- - -None - -Example Response ----------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/autorecovery - -.. code-block:: - - { - "support_auto_recovery": "true" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst b/ecs/api-ref/result/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst deleted file mode 100644 index 4be896b8..00000000 --- a/ecs/api-ref/result/apis_recommended/status_management/reinstalling_an_ecs_os_using_an_image_with_cloud-init_installed.rst +++ /dev/null @@ -1,203 +0,0 @@ -:original_name: en-us_topic_0067876349.html - -.. _en-us_topic_0067876349: - -Reinstalling an ECS OS (Using an Image with Cloud-Init Installed) -================================================================= - -Function --------- - -This API is used to reinstall an ECS OS. During the system disk reinstallation using the original image, the data disks of the ECS remain unchanged. - -After this API is called, the system uninstalls the system disk, uses the original image to create a system disk, and attaches it to the ECS. In this way, the OS is reinstalled. - -Constraints ------------ - -- You can only use an image with Cloud-Init or Cloudbase-Init installed. -- You can reinstall OS only on an ECS that is stopped or for which OS reinstallation has failed. -- You are not allowed to reinstall the OS of an ECS that does not have the system disk. -- You are not allowed to perform other operations when reinstalling the OS. Otherwise, reinstalling the OS will fail. - -URI ---- - -POST /v2/{project_id}/cloudservers/{server_id}/reinstallos - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067876349__table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0067876349__table2840889: - -.. table:: **Table 2** Request parameters - - +--------------+-----------+--------+------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+================================================================================================+ - | os-reinstall | Yes | Object | Reinstalls an ECS OS. For details, see :ref:`Table 3 `. | - +--------------+-----------+--------+------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067876349__table32200631: - -.. table:: **Table 3** **os-reinstall** field description - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================+ - | keyname | Yes | String | Specifies the key pair name. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | userid | Yes | String | Specifies the user ID. This parameter is mandatory when **keyname** is used. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies metadata of the reinstalled ECS. | - | | | | | - | | | | For more information, see :ref:`Table 4 `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - -.. _en-us_topic_0067876349__table9120223: - -.. table:: **Table 4** **metadata** field description - - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +======================+=================+=================+========================================================================================================================================================+ - | BYOL | No | String | Specifies whether a user has the license of an image. | - | | | | | - | | | | - If this parameter is set to **true**, the license file delivered with the image is used, indicating that BYOL is used. | - | | | | - If this parameter is set to a value other than **true**, BYOL is not used, and the license file provided by the public cloud platform must be used. | - | | | | | - | | | | The default value is not **true**, indicating that BYOL is not used. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_data | No | String | Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The content of **user_data** must be encoded with base64. | - | | | | - The maximum size of the content to be injected (before encoding) is 32 KB. | - | | | | | - | | | | For more details, see "Injecting User Data into ECSs" in *Elastic Cloud Server User Guide*. | - | | | | | - | | | | Examples | - | | | | | - | | | | Before base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | #! /bin/bash | - | | | | echo user_test >> /home/user.txt | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | rem cmd | - | | | | echo 111 > c:\aaa.txt | - | | | | | - | | | | After base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA== | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0 | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \__system__encrypted | No | String | Specifies encryption in **metadata**. The value can be **0** (encryption disabled) or **1** (encryption enabled). | - | | | | | - | | | | If this parameter does not exist, the system disk will not be encrypted by default. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \__system__cmkid | No | String | Specifies the CMK ID, which indicates encryption in **metadata**. This parameter is used with **\__system__encrypted**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For details about how to obtain the CMK ID, see "Querying the List of CMKs" in *Key Management Service API Reference*. | - +----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -See :ref:`Responses (Task) `. - -Example Request ---------------- - -- Example URL request - - .. code-block:: - - POST https://{endpoint}/v2/{project_id}/cloudservers/{server_id}/reinstallos - -- Example request 1 (using a password to remotely log in to an ECS with OS reinstalled) - - .. code-block:: - - { - "os-reinstall": { - "adminpass": "!QAZxsw2", - "userid": "7e25b1da389f4697a79df3a0e5bd494e", - "mode": "withStopServer" - } - } - -- Example request 2 (using a key to remotely log in to an ECS with OS reinstalled) - - .. code-block:: - - { - "os-reinstall": { - "keyname": "KeyPair-350b", - "userid": "7e25b1da389f4697a79df3a0e5bd494e" - } - } - -- Example request 3 (using a password to remotely log in a full-ECS-image-created ECS with OS reinstalled and system disk encrypted) - - .. code-block:: - - { - "os-reinstall": { - "adminpass": "!QAZxsw2", - "userid": "7e25b1da389f4697a79df3a0e5bd494e", - "metadata": { - "__system__encrypted": "1", - "__system__cmkid": "83cdb52d-9ebf-4469-9cfa-e7b5b80da846" - } - } - } - -Example Response ----------------- - -See :ref:`Responses (Task) `. - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst deleted file mode 100644 index b1cd1627..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/adding_tags_to_an_ecs_in_a_batch.rst +++ /dev/null @@ -1,122 +0,0 @@ -:original_name: en-us_topic_0167811963.html - -.. _en-us_topic_0167811963: - -Adding Tags to an ECS in a Batch -================================ - -Function --------- - -- This API is used to add tags to a specified ECS in a batch. -- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS. - -Constraints ------------ - -- An ECS allows a maximum of 10 tags. - -- This API is idempotent. - - During tag creation, if a tag exists (both the key and value are the same as those of an existing tag), the tag is successfully processed by default. - -- A new tag will overwrite the original one if their keys are the same and values are different. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/tags/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0167811963__table73051127201915: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0167811963__table69204518218: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation. (Only lowercase letters are supported.) For example, **create** indicates the creation operation. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167811963__table1534514266207: - -.. table:: **Table 3** **tags** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | - Cannot be left blank. | - | | | | - Must be unique for each resource. | - | | | | - Contains a maximum of 36 characters. | - | | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - | | | | - Must be unique and cannot be left blank. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | value | Yes | String | Specifies the tag value. | - | | | | | - | | | | - Contains a maximum of 43 characters. | - | | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action - -.. code-block:: - - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst b/ecs/api-ref/result/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst deleted file mode 100644 index 266861f8..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/deleting_tags_from_an_ecs_in_a_batch.rst +++ /dev/null @@ -1,117 +0,0 @@ -:original_name: en-us_topic_0167811964.html - -.. _en-us_topic_0167811964: - -Deleting Tags from an ECS in a Batch -==================================== - -Function --------- - -- This API is used to delete tags from a specified ECS in a batch. -- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS. - -.. note:: - - - This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned. - -Constraints ------------ - -An ECS allows a maximum of 10 tags. - -URI ---- - -POST /v1/{project_id}/cloudservers/{server_id}/tags/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0167811964__table1320245602220: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0167811964__table105531424192318: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+============================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation. (Only lowercase letters are supported.) For example, **delete** indicates the deletion operation. | - +-----------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167811964__table6449181462417: - -.. table:: **Table 3** **tags** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | It contains a maximum of 127 Unicode characters and cannot be left blank. | - | | | | | - | | | | The tag key of an ECS must be unique. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - | value | No | String | Specifies the tag value. | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and can be left blank. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags/action - -.. code-block:: - - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/index.rst b/ecs/api-ref/result/apis_recommended/tag_management/index.rst deleted file mode 100644 index 49f6bf1c..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0108433461: - -============== -Tag Management -============== - -.. toctree:: - :maxdepth: 1 - - tag_types - adding_tags_to_an_ecs_in_a_batch - deleting_tags_from_an_ecs_in_a_batch - querying_ecss_by_tag - querying_project_tags - querying_tags_of_an_ecs diff --git a/ecs/api-ref/result/apis_recommended/tag_management/querying_ecss_by_tag.rst b/ecs/api-ref/result/apis_recommended/tag_management/querying_ecss_by_tag.rst deleted file mode 100644 index b7b95fca..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/querying_ecss_by_tag.rst +++ /dev/null @@ -1,243 +0,0 @@ -:original_name: en-us_topic_0102606095.html - -.. _en-us_topic_0102606095: - -Querying ECSs by Tag -==================== - -Function --------- - -This API is used to filter ECSs by tag and obtain all tags of an ECS. - -URI ---- - -POST /v1/{project_id}/servers/resource_instances/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0102606095__table10820175118131: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0102606095__table195321356132718: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+===============================================================================================================================================================================================================================+ - | tags | No | Array of objects | Displays the ECSs with all the specified tags. For details, see :ref:`Table 3 `. | - | | | | | - | | | | - A maximum of 10 keys are included. Each key can have a maximum of 10 values. | - | | | | - The structure body must be included. | - | | | | - This field cannot be left blank. | - | | | | - A key must be unique. | - | | | | - Values of the same key must be unique. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | not_tags | No | Array of strings | Displays the ECSs with none of specified tags. | - | | | | | - | | | | - A maximum of 10 keys are included. Each key can have a maximum of 10 values. | - | | | | - The structure body must be included. | - | | | | - This field cannot be left blank. | - | | | | - Keys must be unique. | - | | | | - Values of the same key must be unique. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | String | Limits the maximum number of queried ECSs. The value cannot be a negative number. The maximum value is 1000. | - | | | | | - | | | | - If the **action** value is **count**, this parameter is invalid. | - | | | | - If the **action** value is **filter**, the default value is **1000**. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | String | Specifies index position. The query starts from the next piece of data indexed by this parameter. The value must be a number and cannot be a negative number. | - | | | | | - | | | | This parameter is not required when data on the first page is queried. When you query the subsequent page data, the value in the response body for the query of the data on the previous page is contained in this parameter. | - | | | | | - | | | | - If the **action** value is **count**, this parameter is invalid. | - | | | | - If the **action** value is **filter**, the default value is **0**. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation, which can be **filter** or **count**. | - | | | | | - | | | | - **filter**: filters ECSs by tag. The ECSs that meet the filter criteria are displayed on pages. | - | | | | - **count**: searches ECSs by tag. The number of ECSs that meet the search criteria is displayed. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | matches | No | Array of objects | Specifies the search field, which is used to search for ECSs. | - | | | | | - | | | | Currently, only **resource_name** can be used for search. For more information, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0102606095__table8638721112919: - -.. table:: **Table 3** **tag** field description - - +-----------------+-----------------+------------------+---------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+===============================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | - A key contains a maximum of 127 Unicode characters. | - | | | | - This field cannot be left blank. | - +-----------------+-----------------+------------------+---------------------------------------------------------------+ - | values | No | Array of strings | Specifies the tag value. | - | | | | | - | | | | - Each tag contains a maximum of 10 values. | - | | | | - Values of the same tag must be unique. | - | | | | - Each value contains a maximum of 255 Unicode characters. | - | | | | - If this parameter is not specified, any value can be used. | - | | | | - The values are in the OR relationship. | - +-----------------+-----------------+------------------+---------------------------------------------------------------+ - -.. _en-us_topic_0102606095__table2075564419352: - -.. table:: **Table 4** **match** field description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================+ - | key | Yes | String | Specifies the key field to be matched. | - | | | | | - | | | | The tag key can only be **resource_name**. In such a case, the tag value is the ECS name. | - | | | | | - | | | | - The key must be unique, and the value is used for matching. | - | | | | - This field is a fixed dictionary value. | - | | | | - This field cannot be left blank. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ - | value | Yes | String | Specifies the tag value. | - | | | | | - | | | | The tag key can only be **resource_name**. In such a case, the tag value is the ECS name. | - | | | | | - | | | | - Each value contains a maximum of 255 Unicode characters. | - | | | | - This field cannot be left blank. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 5 ` describes the response parameters. - -.. _en-us_topic_0102606095__table725495518449: - -.. table:: **Table 5** Response parameters - - +-------------+------------------+-------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+==================+=======================================================================================================+ - | resources | Array of objects | Specifies returned ECSs. For details, see :ref:`Table 6 `. | - +-------------+------------------+-------------------------------------------------------------------------------------------------------+ - | total_count | Integer | Specifies the total number of queried ECSs. | - +-------------+------------------+-------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0102606095__table790793515528: - -.. table:: **Table 6** **resource** field description - - +-----------------+------------------+-----------------------------------------------------+ - | Parameter | Type | Description | - +=================+==================+=====================================================+ - | resource_id | String | Specifies the ECS ID. | - +-----------------+------------------+-----------------------------------------------------+ - | resource_detail | String | Queries ECS details. | - +-----------------+------------------+-----------------------------------------------------+ - | tags | Array of objects | Specifies tags. | - +-----------------+------------------+-----------------------------------------------------+ - | resource_name | String | Specifies the resource name, which is the ECS name. | - +-----------------+------------------+-----------------------------------------------------+ - -.. table:: **Table 7** **resource_tag** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================+ - | key | String | Specifies the tag key. | - | | | | - | | | - It contains a maximum of 36 Unicode characters. | - | | | - This field cannot be left blank. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | value | String | Specifies the tag value. | - | | | | - | | | - Each value contains a maximum of 43 Unicode characters. | - | | | - This field can be left blank. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/servers/resource_instances/action - -.. code-block:: - - { - "offset": "100", - "limit": "100", - "action": "filter", - "matches":[ - { - "key": "resource_name", - "value": "ecs_test" - }], - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }] - } - -Example Response ----------------- - -- Response body when **action** is set to **filter** - - .. code-block:: - - { - "resources": [ - { - "resource_detail": null, - "resource_id": "cdfs_cefs_wesas_12_dsad", - "resource_name": "ecs_test", - "tags": [ - { - "key": "key1", - "value": "value1" - } - ] - } - ], - "total_count": 1000 - } - -- Response body when **action** is set to **count** - - .. code-block:: - - { - "total_count": 1000 - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/querying_project_tags.rst b/ecs/api-ref/result/apis_recommended/tag_management/querying_project_tags.rst deleted file mode 100644 index a2b42ffa..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/querying_project_tags.rst +++ /dev/null @@ -1,110 +0,0 @@ -:original_name: en-us_topic_0167811966.html - -.. _en-us_topic_0167811966: - -Querying Project Tags -===================== - -Function --------- - -Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created under one account. - -This API is used to query all tags used by a user in a specified project. - -URI ---- - -GET /v1/{project_id}/cloudservers/tags - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0167811966__table1169019216279: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0167811966__table14618153352714: - -.. table:: **Table 2** Response parameters - - +-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+================================================================================================================================+ - | tags | Array of objects | Specifies the tag list. For details, see :ref:`Table 3 `. | - +-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167811966__en-us_topic_0102606094_table207611141174713: - -.. table:: **Table 3** **tag** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================+ - | key | String | Specifies the tag key. | - | | | | - | | | - Contains a maximum of 36 Unicode characters. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - | values | Array of strings | Specifies the tag value. | - | | | | - | | | - Contains a maximum of 43 Unicode characters. | - | | | - Can be left blank. | - | | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/tags - -Example Response ----------------- - -.. code-block:: - - { - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/querying_tags_of_an_ecs.rst b/ecs/api-ref/result/apis_recommended/tag_management/querying_tags_of_an_ecs.rst deleted file mode 100644 index 3ba5e534..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/querying_tags_of_an_ecs.rst +++ /dev/null @@ -1,96 +0,0 @@ -:original_name: en-us_topic_0167811967.html - -.. _en-us_topic_0167811967: - -Querying Tags of an ECS -======================= - -Function --------- - -- This API is used to query the tags of a specified ECS. -- The Tag Management Service (TMS) uses this API to query all tags of an ECS. - -URI ---- - -GET /v1/{project_id}/cloudservers/{server_id}/tags - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0167811967__table194262014152810: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0167811967__table1972264711286: - -.. table:: **Table 2** Response parameters - - +-----------+------------------+-----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+===============================================================================================+ - | tags | Array of objects | Specifies tags. For details, see :ref:`Table 3 `. | - +-----------+------------------+-----------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167811967__table1148911211295: - -.. table:: **Table 3** **tags** field description - - ========= ====== ======================== - Parameter Type Description - ========= ====== ======================== - key String Specifies the tag key. - value String Specifies the tag value. - ========= ====== ======================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/{server_id}/tags - -Example Response ----------------- - -.. code-block:: - - { - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tag_management/tag_types.rst b/ecs/api-ref/result/apis_recommended/tag_management/tag_types.rst deleted file mode 100644 index e66df74c..00000000 --- a/ecs/api-ref/result/apis_recommended/tag_management/tag_types.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0167811962.html - -.. _en-us_topic_0167811962: - -Tag Types -========= - -Tag management APIs are classified as the APIs for one-dimensional (1D) tags and the APIs for two-dimensional (2D) tags. - -- A 1D tag contains a string. All APIs for 1D tags are native OpenStack APIs. For details, see section :ref:`Tag Management `. -- A 2D tag consists of a key and a value. All APIs for 2D tags are ECS APIs. For details, see this section. - -.. note:: - - - Use the APIs of the same type to add, delete, modify, or query tags. - - 2D tags are recommended. diff --git a/ecs/api-ref/result/apis_recommended/task_status_management/index.rst b/ecs/api-ref/result/apis_recommended/task_status_management/index.rst deleted file mode 100644 index b422f667..00000000 --- a/ecs/api-ref/result/apis_recommended/task_status_management/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0022225397: - -====================== -Task Status Management -====================== - -.. toctree:: - :maxdepth: 1 - - querying_task_execution_status diff --git a/ecs/api-ref/result/apis_recommended/task_status_management/querying_task_execution_status.rst b/ecs/api-ref/result/apis_recommended/task_status_management/querying_task_execution_status.rst deleted file mode 100644 index 0b6e926d..00000000 --- a/ecs/api-ref/result/apis_recommended/task_status_management/querying_task_execution_status.rst +++ /dev/null @@ -1,196 +0,0 @@ -:original_name: en-us_topic_0022225398.html - -.. _en-us_topic_0022225398: - -Querying Task Execution Status -============================== - -Function --------- - -This API is used to query the execution status of an asynchronous request task. - -After an asynchronous request task is issued, for example, creating or deleting an ECS, performing operations on ECSs in a batch, or performing operations on ECS NICs, a task ID will be returned, based on which you can query the execution status of the task. - -For details about how to obtain the task ID, see :ref:`Responses (Task) `. - -URI ---- - -GET /v1/{project_id}/jobs/{job_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0022225398__table6081678163249: - -.. table:: **Table 1** Parameter description - - ========== ========= ================================================= - Parameter Mandatory Description - ========== ========= ================================================= - project_id Yes Specifies the project ID. - job_id Yes Specifies the ID of an asynchronous request task. - ========== ========= ================================================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0022225398__table63003337163851: - -.. table:: **Table 2** Response parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=========================================================================================================================================================================================================================================================================+ - | status | String | Specifies the task status. | - | | | | - | | | - **SUCCESS**: indicates the task is successfully executed. | - | | | - **RUNNING**: indicates that the task is in progress. | - | | | - **FAIL**: indicates that the task failed. | - | | | - **INIT**: indicates that the task is being initialized. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | entities | Object | Specifies the object of the task. | - | | | | - | | | The value of this parameter varies depending on the type of the task. If the task is an ECS-related operation, the value is **server_id**. If the task is a NIC operation, the value is **nic_id**. If a sub-Job is available, details about the sub-job are displayed. | - | | | | - | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | String | Specifies the ID of an asynchronous request task. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Specifies the type of an asynchronous request task. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Specifies the time when the task started. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | Specifies the time when the task finished. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Specifies the returned error code when the task execution fails. | - | | | | - | | | After the task is executed successfully, the value of this parameter is null. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fail_reason | String | Specifies the cause of the task execution failure. | - | | | | - | | | After the task is executed successfully, the value of this parameter is null. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Specifies the error message returned when an error occurs in the request to query a task. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Specifies the error code returned when an error occurs in the request to query a task. | - | | | | - | | | For details about the error code, see :ref:`Returned Values for General Requests `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0022225398__table63816992163249: - -.. table:: **Table 3** **entities** field description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================+ - | sub_jobs_total | Integer | Specifies the number of subtasks. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - | sub_jobs | Array of objects | Specifies the execution information of a subtask. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------+ - -.. _en-us_topic_0022225398__table1500801817135: - -.. table:: **Table 4** **sub_jobs** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================================================================================================================================================================================================================================+ - | status | String | Specifies the task status. | - | | | | - | | | - **SUCCESS**: indicates the task is successfully executed. | - | | | - **RUNNING**: indicates that the task is in progress. | - | | | - **FAIL**: indicates that the task failed. | - | | | - **INIT**: indicates that the task is being initialized. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | entities | Object | Specifies the object of the task. The value of this parameter varies depending on the type of the task. If the task is an ECS-related operation, the value is **server_id**. If the task is a NIC operation, the value is **nic_id**. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | String | Specifies the subtask ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Specify the subtask type. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_time | String | Specifies the time when the task started. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_time | String | Specifies the time when the task finished. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Specifies the returned error code when the task execution fails. | - | | | | - | | | After the task is executed successfully, the value of this parameter is null. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fail_reason | String | Specifies the cause of the task execution failure. | - | | | | - | | | After the task is executed successfully, the value of this parameter is null. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0022225398__table2577901102930: - -.. table:: **Table 5** **entities** field description - - +-------------------+--------+----------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================+========+======================================================================+ - | server_id | String | If the task is an ECS-related operation, the value is **server_id**. | - +-------------------+--------+----------------------------------------------------------------------+ - | nic_id | String | If the task is a NIC-related operation, the value is **nic_id**. | - +-------------------+--------+----------------------------------------------------------------------+ - | errorcode_message | String | Indicates the cause of a subtask execution failure. | - +-------------------+--------+----------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/jobs/{job_id} - -Example Response ----------------- - -.. code-block:: - - { - "status": "SUCCESS", - "entities": { - "sub_jobs_total": 1, - "sub_jobs": [ - { - "status": "SUCCESS", - "entities": { - "server_id": "bae51750-0089-41a1-9b18-5c777978ff6d" - }, - "job_id": "2c9eb2c5544cbf6101544f0635672b60", - "job_type": "createSingleServer", - "begin_time": "2016-04-25T20:04:47.591Z", - "end_time": "2016-04-25T20:08:21.328Z", - "error_code": null, - "fail_reason": null - } - ] - }, - "job_id": "2c9eb2c5544cbf6101544f0602af2b4f", - "job_type": "createServer", - "begin_time": "2016-04-25T20:04:34.604Z", - "end_time": "2016-04-25T20:08:41.593Z", - "error_code": null, - "fail_reason": null - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/apis_recommended/tenant_quota_management/index.rst b/ecs/api-ref/result/apis_recommended/tenant_quota_management/index.rst deleted file mode 100644 index 044ed2dd..00000000 --- a/ecs/api-ref/result/apis_recommended/tenant_quota_management/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0020212673: - -======================= -Tenant Quota Management -======================= - -.. toctree:: - :maxdepth: 1 - - querying_tenant_quotas diff --git a/ecs/api-ref/result/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst b/ecs/api-ref/result/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst deleted file mode 100644 index 9c1e2686..00000000 --- a/ecs/api-ref/result/apis_recommended/tenant_quota_management/querying_tenant_quotas.rst +++ /dev/null @@ -1,150 +0,0 @@ -:original_name: en-us_topic_0020212674.html - -.. _en-us_topic_0020212674: - -Querying Tenant Quotas -====================== - -Function --------- - -This API is used to query the quotas of all resources for a specified tenant, including used quotas. - -URI ---- - -GET /v1/{project_id}/cloudservers/limits - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212674__table23262209: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212674__table6147620: - -.. table:: **Table 2** Response parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==================================================================================================+ - | absolute | Object | Specifies tenant quotas. For details, see :ref:`Table 3 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212674__table7714075: - -.. table:: **Table 3** **absolute** field description - - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+==================================================================================================+ - | maxTotalInstances | Integer | Specifies the maximum number of ECSs you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxTotalCores | Integer | Specifies the maximum number of CPU cores you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxTotalRAMSize | Integer | Specifies the maximum memory space (MB) you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxTotalKeypairs | Integer | Specifies the maximum number of SSH key pairs you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxServerMeta | Integer | Specifies the maximum length of the metadata you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxPersonality | Integer | Specifies the maximum number of files that can be injected. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxPersonalitySize | Integer | Specifies the maximum size (byte) of the file to be injected. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxServerGroups | Integer | Specifies the maximum number of server groups. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxServerGroupMembers | Integer | Specifies the maximum number of ECSs in an ECS group. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalServerGroupsUsed | Integer | Specifies the number of used server groups. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxSecurityGroups | Integer | Specifies the maximum number of security groups you can use. | - | | | | - | | | .. note:: | - | | | | - | | | The quota complies with the VPC quota limit. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxSecurityGroupRules | Integer | Specifies the maximum number of security group rules that you can configure in a security group. | - | | | | - | | | .. note:: | - | | | | - | | | The quota complies with the VPC quota limit. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxTotalFloatingIps | Integer | Specifies the maximum number of floating IP addresses you can use. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | maxImageMeta | Integer | Specifies the maximum length of the image metadata. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalInstancesUsed | Integer | Specifies the number of used ECSs. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalCoresUsed | Integer | Specifies the number of the used CPU cores. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalRAMUsed | Integer | Specifies the used memory size (MB). | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalSecurityGroupsUsed | Integer | Specifies the number of used security groups. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - | totalFloatingIpsUsed | Integer | Specifies the number of used floating IP addresses. | - +-------------------------+-----------------------+--------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/limits - -Example Response ----------------- - -Example response - -.. code-block:: - - { - "absolute": { - "maxServerMeta": 128, - "maxPersonality": 5, - "maxImageMeta": 128, - "maxPersonalitySize": 10240, - "maxSecurityGroupRules": 20, - "maxTotalKeypairs": -1, - "totalRAMUsed": 75776, - "totalInstancesUsed": 21, - "maxSecurityGroups": 10, - "totalFloatingIpsUsed": 0, - "maxTotalCores": 20480, - "totalSecurityGroupsUsed": 1, - "maxTotalFloatingIps": 10, - "maxTotalInstances": 2048, - "totalCoresUsed": 40, - "maxTotalRAMSize": 25165824, - "maxServerGroups": 10, - "maxServerGroupMembers": 16, - "totalServerGroupsUsed": 2 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/appendix/ecs_monitoring_metrics.rst b/ecs/api-ref/result/appendix/ecs_monitoring_metrics.rst deleted file mode 100644 index 49b0a0ed..00000000 --- a/ecs/api-ref/result/appendix/ecs_monitoring_metrics.rst +++ /dev/null @@ -1,85 +0,0 @@ -:original_name: en-us_topic_0022067719.html - -.. _en-us_topic_0022067719: - -ECS Monitoring Metrics -====================== - -Function --------- - -This section describes metrics reported by ECS to Cloud Eye as well as their namespaces and dimensions. You can use APIs provided by Cloud Eye to query the metrics of the monitored object and alarms generated for ECS. - -Namespace ---------- - -SYS.ECS - -Metrics -------- - -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| Metric | Name | Description | Value Range | Remarks | -+=========================================+=======================+============================================================================================================================================+=============+========================================================================+ -| cpu_util | CPU Usage | This metric is used to show CPU usages (%) of monitored objects. | 0% to 100% | ECS monitored | -| | | | | | -| | | | | .. note:: | -| | | | | | -| | | | | The metrics collected using OTC Tools are accurate. | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| mem_util | Memory Usage | This metric is used to show memory usages (%) of monitored objects. | 0% to 100% | ECS monitored | -| | | | | | -| | | | | .. note:: | -| | | | | | -| | | | | This metric is unavailable if the image has no OTC Tools installed. | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| disk_util_inband | Disks Usage | This metric is used to show disk usages (%) of monitored objects. | 0% to 100% | ECS monitored | -| | | | | | -| | | | | .. note:: | -| | | | | | -| | | | | This metric is unavailable if the image has no OTC Tools installed. | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| disk_read_bytes_rate | Disk Read Bandwidth | This metric is used to show the number of bytes read from the monitored object per second (byte/s). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| disk_write_bytes_rate | Disk Write Bandwidth | This metric is used to show the number of bytes written to the monitored object per second (byte/s). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| disk_read_requests_rate | Disk Read IOPS | This metric is used to show the number of read requests sent to the monitored object per second (requests/second). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| disk_write_requests_rate | Disk Write IOPS | This metric is used to show the number of write requests sent to the monitored object per second (requests/second). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| network_incoming_bytes_rate_inband | Inband Incoming Rate | This metric is used to show the number of incoming bytes received by the monitored object per second (byte/s). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| network_outgoing_bytes_rate_inband | Inband Outgoing Rate | This metric is used to show the number of outgoing bytes sent by the monitored object per second (byte/s). | ≥ 0 | ECS monitored | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| network_incoming_bytes_aggregate_rate | Outband Incoming Rate | This metric is used to show the number of incoming bytes received by the monitored object per second (byte/s) at the virtualization layer. | ≥ 0 | ECS monitored | -| | | | | | -| | | | | .. note:: | -| | | | | | -| | | | | This metric is unavailable if SR-IOV is enabled. | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| network_outgoing_bytes\_ aggregate_rate | Outband Outgoing Rate | This metric is used to show the number of outgoing bytes sent by the monitored object per second (byte/s) at the virtualization layer. | ≥ 0 | ECS monitored | -| | | | | | -| | | | | .. note:: | -| | | | | | -| | | | | This metric is unavailable if SR-IOV is enabled. | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ -| ib_card_state | InfiniBand NIC status | This metric is used to monitor the status of an InfiniBand NIC on a high-performance h2 ECS to ensure proper InfiniBand NIC running. | 0 or 1 | ECS monitored | -| | | | | | -| | | The system periodically checks the NIC status and returns check results using value **0** or **1**. | | .. note:: | -| | | | | | -| | | - **0**: The system is running properly. That is, the InfiniBand NIC is functional. | | Only Mellanox EDR 100 GB single-port InfiniBand NICs are supported. | -| | | - **1**: The system is not running properly. That is, the InfiniBand NIC malfunctions. | | | -+-----------------------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+-------------+------------------------------------------------------------------------+ - -.. note:: - - The image based on which the target ECS is created must have OTC Tools installed. Otherwise, the **Memory Usage** and **Disk Usage** metrics are unavailable. For details about how to install the OTC Tools, visit https://github.com/UVP-Tools/UVP-Tools/. - -Dimension ---------- - -=========== ===================== -Key Value -=========== ===================== -instance_id Specifies the ECS ID. -=========== ===================== diff --git a/ecs/api-ref/result/appendix/ecs_statuses.rst b/ecs/api-ref/result/appendix/ecs_statuses.rst deleted file mode 100644 index e4b938d5..00000000 --- a/ecs/api-ref/result/appendix/ecs_statuses.rst +++ /dev/null @@ -1,183 +0,0 @@ -:original_name: en-us_topic_0178420672.html - -.. _en-us_topic_0178420672: - -ECS Statuses -============ - -An ECS can be in one of the following statuses specified in ECS APIs: - -- **status**: specifies an ECS status, which is generated by **OS-EXT-STS:vm_state** and **OS-EXT-STS:task_state**. -- **OS-EXT-STS:vm_state**: indicates that the ECS is in a stable state after an operation is performed. This is an extended attribute. -- **OS-EXT-STS:task_state**: indicates an intermediate status in which the ECS is processing an operation performed on it. This is an extended attribute. - -.. table:: **Table 1** Statuses - - +---------------+-------------------------------------------------------------------------------------------------------------+ - | Status | Description | - +===============+=============================================================================================================+ - | BUILD | The ECS has been created but is not running. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | REBOOT | The ECS is being restarted. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | HARD_REBOOT | The ECS is being forcibly restarted. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | REBUILD | The ECS is being rebuilt. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | MIGRATING | The ECS is being live migrated. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | RESIZE | The ECS has received a specifications modification request and and has started to perform the modification. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | ACTIVE | The ECS is running properly. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | SHUTOFF | The ECS has been properly stopped. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | REVERT_RESIZE | The ECS is rolling back resizing. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | VERIFY_RESIZE | The ECS is verifying the modified configuration. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | ERROR | An error has occurred on the ECS. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - | DELETED | The ECS has been deleted. | - +---------------+-------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** **OS-EXT-STS:vm_state** statuses - - ======== ============================================ - Status Description - ======== ============================================ - building The ECS has been created but is not running. - active The ECS is running properly. - stopped The ECS has been properly stopped. - resized The ECS specifications have been modified. - error An error has occurred on the ECS. - deleted The ECS has been deleted. - ======== ============================================ - -.. table:: **Table 3** **OS-EXT-STS:task_state** statuses - - +------------------------------+------------------------------------------------------------------------------------------+ - | Status | Description | - +==============================+==========================================================================================+ - | scheduling | The ECS is being created. | - +------------------------------+------------------------------------------------------------------------------------------+ - | block_device_mapping | The ECS is being created, and disks are being prepared for the ECS. | - +------------------------------+------------------------------------------------------------------------------------------+ - | networking | The ECS is being created, and network resources are being prepared for the ECS. | - +------------------------------+------------------------------------------------------------------------------------------+ - | spawning | The ECS is being created. | - +------------------------------+------------------------------------------------------------------------------------------+ - | rebooting | The ECS is being restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | reboot_pending | A restarting command has been issued to an ECS, and the ECS is to be restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | reboot_started | The ECS is being restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | rebooting_hard | The ECS is being forcibly restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | reboot_pending_hard | A forcible restarting command has been issued to an ECS, and the ECS is to be restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | reboot_started_hard | The ECS is being forcibly restarted. | - +------------------------------+------------------------------------------------------------------------------------------+ - | rebuilding | The ECS is being rebuilt. | - +------------------------------+------------------------------------------------------------------------------------------+ - | rebuild_block_device_mapping | The ECS is being rebuilt, and disks are being prepared for the ECS. | - +------------------------------+------------------------------------------------------------------------------------------+ - | rebuild_spawning | The ECS is being rebuilt. | - +------------------------------+------------------------------------------------------------------------------------------+ - | migrating | The ECS is being live migrated. | - +------------------------------+------------------------------------------------------------------------------------------+ - | resize_prep | The ECS specifications are to be modified, and resources are being prepared for the ECS. | - +------------------------------+------------------------------------------------------------------------------------------+ - | resize_migrating | The specifications of the ECS are being modified, and it is being migrated. | - +------------------------------+------------------------------------------------------------------------------------------+ - | resize_migrated | The specifications of the ECS are being modified, and it has been migrated. | - +------------------------------+------------------------------------------------------------------------------------------+ - | resize_finish | The specifications of the ECS are being modified. | - +------------------------------+------------------------------------------------------------------------------------------+ - | resize_reverting | The specifications modification of the ECS is being rolled back. | - +------------------------------+------------------------------------------------------------------------------------------+ - | powering-off | The ECS is stopped. | - +------------------------------+------------------------------------------------------------------------------------------+ - | powering-on | The ECS is being started. | - +------------------------------+------------------------------------------------------------------------------------------+ - | deleting | The ECS is being deleted. | - +------------------------------+------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Mapping between statuses - - +-----------------------+------------------------------+-----------------------+ - | vm_state | task_state | status | - +=======================+==============================+=======================+ - | building | scheduling | BUILD | - | | | | - | | block_device_mapping | | - | | | | - | | networking | | - | | | | - | | spawning | | - | | | | - | | null | | - +-----------------------+------------------------------+-----------------------+ - | active | rebooting | REBOOT | - | | | | - | | reboot_pending | | - | | | | - | | reboot_started | | - +-----------------------+------------------------------+-----------------------+ - | | rebooting_hard | HARD_REBOOT | - | | | | - | | reboot_pending_hard | | - | | | | - | | reboot_started_hard | | - +-----------------------+------------------------------+-----------------------+ - | | rebuilding | REBUILD | - | | | | - | | rebuild_block_device_mapping | | - | | | | - | | rebuild_spawning | | - +-----------------------+------------------------------+-----------------------+ - | | migrating | MIGRATING | - +-----------------------+------------------------------+-----------------------+ - | | powering-off | ACTIVE | - | | | | - | | deleting | | - | | | | - | | null | | - +-----------------------+------------------------------+-----------------------+ - | stopped | resize_prep | RESIZE | - | | | | - | | resize_migrating | | - | | | | - | | resize_migrated | | - | | | | - | | resize_finish | | - +-----------------------+------------------------------+-----------------------+ - | | rebuilding | REBUILD | - | | | | - | | rebuild_block_device_mapping | | - | | | | - | | rebuild_spawning | | - +-----------------------+------------------------------+-----------------------+ - | | powering-on | SHUTOFF | - | | | | - | | deleting | | - | | | | - | | null | | - +-----------------------+------------------------------+-----------------------+ - | resized | resize_reverting | REVERT_RESIZE | - +-----------------------+------------------------------+-----------------------+ - | | null | VERIFY_RESIZE | - +-----------------------+------------------------------+-----------------------+ - | error | rebuilding | REBUILD | - | | | | - | | rebuild_block_device_mapping | | - | | | | - | | rebuild_spawning | | - +-----------------------+------------------------------+-----------------------+ - | | deleting | ERROR | - | | | | - | | null | | - +-----------------------+------------------------------+-----------------------+ - | deleted | null | DELETED | - +-----------------------+------------------------------+-----------------------+ diff --git a/ecs/api-ref/result/appendix/error_codes.rst b/ecs/api-ref/result/appendix/error_codes.rst deleted file mode 100644 index d2c0bef6..00000000 --- a/ecs/api-ref/result/appendix/error_codes.rst +++ /dev/null @@ -1,321 +0,0 @@ -:original_name: en-us_topic_0022067717.html - -.. _en-us_topic_0022067717: - -Error Codes -=========== - -Context -------- - -- An error code returned by an API does not correspond to one error message. The following table lists only common error messages. -- Most ECS APIs are asynchronous. Some error codes are displayed in the returned messages for task viewing requests. HTTP status codes may not be accurate. -- The ECS service is strongly dependent on other services, such as network and storage. When error messages are provided for the ECS-depended services, contact customer service for troubleshooting. -- If the system displays an error code when you perform operations on the management console, see "How Do I Handle Error Messages Displayed on the Management Console?" in *Elastic Cloud Server User Guide* for troubleshooting. - -.. _error-codes-1: - -Error Codes ------------ - -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| HTTP Status Code | Error Code | Error Message | Description | Solution | -+==================+=============+===========================================================================================================+==========================================================================================+===============================================================================================================================================================+ -| 400 | Ecs.0000 | An existing EIP cannot be assigned to the ECSs created in batches. | Request error. | Check the request body according to the returned error message. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0001 | the number of instance above quota limits | The number of ECSs has reached the maximum allowed. | Apply for a higher quota of the corresponding resource according to the returned error message. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0002 | submit job failed | Failed to submit the task. | Contact customer service to locate the fault. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | Ecs.0003 | The token role contains **op_suspended**. The current operation is not allowed. | You do not have permission or your balance is insufficient. | Check whether the account balance is insufficient and the account is frozen according to the returned error message. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0004 | Failed to assign permissions: %s | Authentication failed. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0005 | request body is illegal. | Invalid parameters. | Check whether the request body is of the correct JSON structure according to the API reference. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0007 | ecs service not support the ironic image [%s] | Invalid image attributes. | Adjust the specifications or image type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0008 | **performancetype** in extended flavor field [%s] is null. | Invalid flavor attributes. | Contact customer service to check whether the flavor registration is valid. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0009 | Another flavor must be used for resizing. | Flavor conflict. | Change the flavor when modifying ECS specifications. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0010 | Private IP address %s is already in use. | The private IP address is already in use. | Change the port. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0011 | The password length must range from 8 to 26. | Failed to meet password complexity requirements. | Check the password length and change the password. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0012 | Insufficient IP addresses. | The number of IP addresses in the subnet is insufficient. | Check whether the floating IP addresses of the subnet are used up. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0013 | Insufficient EIP quota. | Insufficient EIP quota. | Apply for a higher EIP quota because the EIP quota is insufficient. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0014 | vpc parm is illegal | Invalid VPC parameters. | Check whether the subnets belong to the same VPC. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0015 | Flavor resource_type %s does not match volume_type %s. | The disk of this type is not applicable to the ECS. | Check whether the disk type is supported by the flavor. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0017 | The vmid [%s] in volume metadata is not the same with vmid [%s] | The ECS is not the target one that the system disk or data disk to be attached. | Check whether the **\__system__server_id** value in disk metadata is the same as the UUID of the ECS to which the system disk or data disk is to be attached. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0021 | cinder quota check fail:volume count is over limits | Insufficient EVS disk quota. | Apply for a higher EVS disk quota. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0022 | the number of instance above server group quota limits | The number of ECSs in the ECS group exceeded the upper limit. | Apply for a higher ECS quota for an ECS group. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0023 | project_id in token mismatches with project_id in url. | Invalid token, or the project ID in the token is different from that in the URL. | Apply for a valid token or check the project ID in the URL. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0025 | Failed to check the role of kms | EVS is not authorized to obtain KMS keys for encrypting EVS disks. | Authorize EVS to obtain KMS keys for encrypting EVS disks. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0029 | the flavor[%s] does not exist. | The flavor does not exist or has been abandoned. | Change another flavor. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0030 | The server %s is freezed. | The ECS has been frozen. | Check whether the account has been frozen or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0031 | image [%s] does not exist. | The image does not exist. | Change another image. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0032 | image[%s] status must be active | The image is not in **Active** state. | Change another image. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0034 | Backup %s does not exist. | The full-ECS backup does not exist or has been deleted. | Change another image. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0036 | flavor [%s] does not support auto recovery. | The flavor does not support automatic recovery. | Change another flavor. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0037 | Instance with flavor %s does not support mounte scsi-type disks. | The flavor does not support SCSI disks. | Change another flavor or type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0038 | subnet [%s] is not exist. | The subnet does not exist. | Adjust network parameter settings. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0039 | privateIp [%s] is not in this subnet [%s] | The specified IP address does not belong to the subnet. | Change the specified private IP address. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0041 | Description field length cannot be greater than 85 characters and cannot contain '>' and '<' characters | Invalid description field. | Modify the service description field. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0042 | The number of VBD volumes is %s, but KVM server supports up to 24. | The number of attached data disks exceeds the maximum allowed limit. | Adjust the number of attached data disks. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0043 | volume type[%s] is not exist. | The disk type does not exist. | Change the disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0044 | the volumeType [%s] is sellout in az[%s] | The disk of this type has been sold out. | Change the disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0045 | bandwidth size %d is invalid | The bandwidth exceeds the maximum size allowed. | Adjust the bandwidth. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0046 | The rootVolume type in the request must be consistent with the snapshot volume. | The disk type of the ECS is different from that of the snapshot image. | Change the disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0048 | Image[%s] status is error or associated Backup[%s] status is error. | The full-ECS image is unavailable. | Check the full-ECS image. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0050 | The requested number of vif is bigger than the supplied. | The number of NICs attached to the ECS exceeds the maximum value allowed. | Adjust the number of NICs. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0051 | Instance can only mount scsi volumes. | The attached disk is not of SCSI type. | Adjust the disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0052 | Instances can only mount scsi system volumes | The attached system disk is not of SCSI type. | Change the system disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0053 | Instances can only mount scsi data volumes. | The attached data disk is not of SCSI type. | Change the data disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0057 | the volume has already been attached to this instance and you cannot repeatedly attch. | The disk has been attached to the ECS. | Attach a new disk to the ECS. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0058 | current image provider does not match userDomainId | The **provideId** of the image does not match the account ID. | Check the account permission and image. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0062 | flavor does not support driver mode | The flavor does not allow settings of the NIC driver type. | Change another flavor. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0064 | vpcId in the request and vpcId of the main subnetId are not matched | Inconsistent VPC ID in the request body from that in the primary NIC. | Adjust the NIC parameter settings. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0073 | volume status is backing-up, cannot be deleted at this time. | The system disk is being backed up. | You are not allowed to delete a system disk that is being backed up. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0074 | windows image does not support external users | External users are not allowed to create Windows ECSs. | External users, including non-internal users and non-third-party users, are not allowed to purchase Windows images. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0075 | provider user only supports windows images. | Partners can purchase only Windows images. | Purchase only Windows images. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0085 | Server[%s] does not have port[%s]. | The ECS does not have the NIC. | Replace a NIC. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0086 | Port[%s] is not the primary interface. | The NIC is not the primary NIC. | Replace a NIC. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0100 | Volumes can be attached to server[%s] only in started or stopped state. | The ECS status does not meet requirements. | The ECS in the current state does not support this operation. Try again later. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0101 | Status error of the system volume. | Abnormal system disk status. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0102 | System disk status does not support uninstallation ,serverId[%s] | The system disk status does not allow the disk to be detached. | Check the system disk status. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0103 | The volume %s has been frozen and cannot be attached. | The disk is unavailable. | Check the disk status or contact customer service to change the disk status. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0104 | The number of volumes attached to server[%s] has exceeded the upper limit. | Insufficient ECS disk quota for attaching more disks. | Adjust the number of attached disks. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0105 | Failed to view the details about the system volume: %s. | Failed to query the ECS system disk. | Check whether the ECS has a system disk attached. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0106 | Failed to create VLAN network %s because the network status is error. | Abnormal network status. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | Ecs.0110 | token role %s is forbidden to perform this action. | Operations are prohibited on the client due to permissions. | You do not have the permission to perform such an operation. Check token permissions. For details, see the error message returned by the API. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0111 | volume %s is not in server %s attach volume list | The disk is not in the attachment list. | Check whether the selected disk has been attached to the ECS, or replace the disk. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Ecs.0114 | Instance[%s] could not be found. | The ECS cannot be detected. | Check whether the ECS has been created. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0118 | the number of vm %s is overlimit the maximum number %s | The number of tasks in a batch is greater than the upper limit. | Check the number of ECSs in the batch. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0121 | volume must has same faultDomain with server | Failed to attach the disk because the ECS and the disk are in different failure domains. | Select a disk that is in the same failure domain as that of the target ECS. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0201 | Failed to create port in network %s because %s. | Failed to create the NIC. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0202 | Failed to create volume %s because %s. | Failed to create the system disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0203 | Failed to create volume %s because %s. | Failed to create the data disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0204 | Failed to add a tag to server %s: %s. | Failed to create the ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0205 | Failed to call the Nova API to attach volume %s to ECS %s because %s. | Failed to attach the data disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0207 | Failed to resize server %s: %s. | Failed to modify ECS specifications. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0208 | Failed to update the metadata of image %s. | Failed to update the image metadata. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0209 | Failed to confirm the flavor change of server %s: %s. | Failed to confirm the ECS specifications modification. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0210 | Failed to call the VPC API to assign an FIP to port %s: %s. | Failed to assign the floating IP address. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0211 | Failed to create QoS because %s. | Failed to create the NIC. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0212 | Failed to call the Neutron API to view private IP addresses because the response is null or invalid. | Failed to allocate the private IP address. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0213 | Failed to update allowed_address_pairs of port %s because %s. | Failed to update the port attributes. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0214 | Failed to create VLAN network because %s. | Failed to create the network. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0216 | Failed to create the subnet for vlan %s. | Failed to create the subnet. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0217 | attach server [%s] port [%s] fail ,reason is : %s | Failed to attach the NIC. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0219 | Failed to quickly create server %s because the ECS status is error or %s. | Failed to create the ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0221 | can not cold migrate dedicated host server[%s] to the same dedicated host | Failed to migrate the ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0226 | server[%s] action[%s] fail: [%s, %s] | Failed to start the ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0301 | The information, status, or metadata of server %s is null. | Failed to query the ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0302 | Failed to view the quota usage of tenant %s because %s. | Failed to query the ECS quota of the tenant. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0303 | Failed to view flavor %s because %s. | Failed to query the flavor. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0304 | Failed to view image %s because the image or image name is null. | Failed to query the image. | Contact customer service to check whether the image has been correctly registered or to check other causes. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0306 | Failed to view the backup because %s. | Failed to query the backup. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0307 | Failed to view the port because %s. | Failed to query the port. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0308 | Failed to view limits because %s. | Failed to query the ECS quota of the tenant. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0309 | Failed to view QoS because %s. | Failed to query the NIC QoS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0310 | Failed to view the network because %s. | Failed to view the network information. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0311 | Failed to view the volume type of tenant %s because %s. | Failed to query the disk type. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0313 | query servergroup fail:%s | Failed to query the ECS group. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0314 | call fsp to query keypair fail,reason is : %s | Failed to obtain the key pair. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0315 | call nova api to query tenantId[%s] server[%s] whether is auto recovery fail: resposne is null or invalid | Failed to obtain the automatic recovery status. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0319 | check capacity: capacity is not enough. | Insufficient flavor capacity. | Apply for expanding the flavor capacity. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0320 | query availability zones detail failed: the response is null. | Failed to obtain AZs. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0321 | query server[%s] console output failed: %s | Failed to query ECS console logs. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0322 | query subnet[%s] failed: %s | Failed to query details of the subnet. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0323 | query server[%s] interface attachment failed: %s | Failed to query the NIC attachment to an ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0401 | Failed to roll back the port because %s. | Failed to undo the operation performed on the port. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0402 | rollback delete volume[%s] fail: %s | Failed to undo the operation performed on the system disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0403 | rollback vm[%s] fail: %s | Failed to undo the operation performed on the ECS. | Contact customer service to locate the fault. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0405 | Failed to delete volume %s because %s. | Failed to undo the operation performed on the data disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0501 | ECS %s cannot be deleted because downloading the system volume data is in progress. | Failed to delete the ECS. | Try again later. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0502 | Failed to roll back the EIP [%s] unbinding: %s. | Failed to delete the private IP address. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0503 | Failed to view details about the volume because %s. | Failed to query the system disk. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0507 | Resource VLAN NICs cannot be deleted. | Failed to delete the NIC. | Check the NIC type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | Ecs.0603 | The running state %s of ECS %s for tenant %s is unstable. | Other commands are being executed. Try again 1 minute later. | Try again 1 minute later. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0605 | The server [%s] is locked. | The ECS is locked. | Check whether the ECS is locked. If so, unlock it. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0611 | batch operate fail. | Requesting for a batch operation failed. | Rectify the fault based on the returned error information and submit the request again. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Ecs.0614 | itemNotFound: Instance xxx could not be found. | The ECS cannot be detected. | Check whether the ECS exists. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Ecs.0615 | thread List is empty. | An error has occurred in the request from an ECS. | An internal system error occurred. | -| | | | | | -| | | | | Contact customer service to locate the fault. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0616 | update server[%s] name failed. | Failed to modify the ECS. | Try again later or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0617 | update server %s block_device %s fail: %s | Failed to modify the attributes of the disk attached to an ECS. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0618 | update port[%s] ip address failed: %s | Failed to change the IP address of the ECS NIC. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0707 | the product [%s] does not exist | The product does not exist. | Contact customer service to locate the fault. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0905 | tags number can not be more than 10. | The number of tags exceeds the maximum number allowed. | Decrease the number of tags. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0906 | tag key is invalid. | Invalid tag attribute. | Create a tag again. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0907 | The key [%s] of tag include invalid char. | Invalid tag character set. | Create a tag again. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0908 | tags key can not be duplicate. | Duplicate tag key. | Create a tag again. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0909 | Flavor %s does not support this volume type %s | The flavor does not support the disk type. | Change the flavor or disk type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0910 | the nic param for creating hana instance is illegal. | Invalid NIC parameters for creating a HANA ECS. | Adjust the NIC parameter settings. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0911 | Disks cluster type is different. | Invalid dedicated storage type of the disk. | Modify parameter settings for the dedicated storage type. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0912 | encrypted key id [%s] contains illegal character. | Invalid disk encryption attribute. | Modify parameter settings for the disk encryption attribute. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0913 | the number of vm is illegal. | The number of ECSs to be created exceeds the maximum allowed limit. | Decrease the number of ECSs to be created. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0914 | the length of serverName is [%d], is illegal | The length of the ECS name exceeds the maximum allowed limit. | Change the ECS name. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0915 | The name [%s] of server include invalid char | The ECS name contains invalid characters. | Change the ECS name. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.0919 | query the port: [%s] and status is [%s] | The port does not allow attaching. | Change the port. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1000 | Failed to call the Nova API because %s. | Failed to call the Nova API. | Internal calling error. Try again later or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | Ecs.1000 | itemNotFound: xxx could not be found. | The resource does not exist. | Check whether the resource exists. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1001 | Failed to delete the ECS because the ECS is being deleted. | OpenStack access error. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1002 | System timed out. | OpenStack access timed out. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1100 | Failed to call the IAM API because %s. | Failed to access IAM. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1200 | Failed to view the EIP because %s. | Failed to access the VPC. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1201 | Operation timed out. | VPC access timed out. | For details, contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Ecs.1300 | Failed to call the Cinder API to create a volume because %s. | EVS access timed out. | For details, see the returned error message or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | Pdp.0001 | Policy doesn't allow %s to be performed. | API authentication failed. | Add permissions on IAM. For details, see API permissions. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 202 | Common.0024 | exceeds flow over limit | Limited by traffic control. | The number of concurrent requests has exceeded the upper limit. Try again later. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0002 | Request body is null! | Empty request body. | Check the request body. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0011 | query job fail. | Invalid job ID. | Check whether the source of the job ID is correct. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0018 | tenantId in token is not the same with in URL. | Invalid token, or the project ID in the token is different from that in the URL. | Check whether the tenant token is correct. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0020 | Call redo api failed | Failed to retry the task. | Contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0021 | Sub job fail! | An error has occurred in job query. | Try again later or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0022 | Mission fail! | An error has occurred in job submission. | Contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0999 | The system was broken, exit. | Task terminated. | Contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0025 | Query job Error because %s. | An error has occurred in task query. | Try again later or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | Common.0026 | Fail to get Region Info | An error occurred in AZ query. | Try again later or contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | Common.0013 | The permission is forbidden to perform this action | Invalid token. | Check whether the tenant token is correct. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | Common.0001 | System Context Error! | A system exception occurred. | Contact customer service. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 503 | Common.1503 | Api flow control Error because %s. | Limited by API traffic control. | Too many APIs are being executed. Try again later. | -+------------------+-------------+-----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/api-ref/result/appendix/http_status_codes.rst b/ecs/api-ref/result/appendix/http_status_codes.rst deleted file mode 100644 index caa5b173..00000000 --- a/ecs/api-ref/result/appendix/http_status_codes.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: en-us_topic_0065827313.html - -.. _en-us_topic_0065827313: - -HTTP Status Codes -================= - -================== =========== -Normal Status Code Description -================== =========== -200 OK -201 Created -202 Accepted -204 No Content -================== =========== - -================= ======================== -Error Status Code Description -================= ======================== -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -405 Method Not Allowed -409 Conflict -413 Request Entity Too Large -415 Unsupported Media Type -500 Internal Server Error -501 Not Implemented -503 Service Unavailable -================= ======================== diff --git a/ecs/api-ref/result/appendix/index.rst b/ecs/api-ref/result/appendix/index.rst deleted file mode 100644 index ac36812a..00000000 --- a/ecs/api-ref/result/appendix/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0022067588: - -======== -Appendix -======== - -.. toctree:: - :maxdepth: 1 - - http_status_codes - error_codes - ecs_statuses - network_apis - ecs_monitoring_metrics diff --git a/ecs/api-ref/result/appendix/network_apis.rst b/ecs/api-ref/result/appendix/network_apis.rst deleted file mode 100644 index 117eccc5..00000000 --- a/ecs/api-ref/result/appendix/network_apis.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0022067718.html - -.. _en-us_topic_0022067718: - -Network APIs -============ - -For details about network APIs, see the *Virtual Private Cloud API Reference*. diff --git a/ecs/api-ref/result/change_history.rst b/ecs/api-ref/result/change_history.rst deleted file mode 100644 index 0361a42c..00000000 --- a/ecs/api-ref/result/change_history.rst +++ /dev/null @@ -1,377 +0,0 @@ -:original_name: en-us_topic_0024734483.html - -.. _en-us_topic_0024734483: - -Change History -============== - -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+============================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| 2022-01-10 | Deleted the following content: | -| | | -| | - 6.2.5 Querying Automatic Recovery of an ECS | -| | - 6.2.6 Managing Automatic Recovery of an ECS | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-12-30 | Modified the following content: | -| | | -| | Added constraints in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-11-20 | Added description of system disk encryption in the following sections: | -| | | -| | - :ref:`Creating an ECS ` | -| | - :ref:`Reinstalling an ECS OS (Using an Image with Cloud-Init Installed) ` | -| | - :ref:`Changing an ECS OS (Using an Image with Cloud-Init Installed) ` | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-09-11 | Modified the following content: | -| | | -| | Modified the description about Xen instances in the following sections: | -| | | -| | - :ref:`Modifying the Specifications of an ECS ` | -| | - :ref:`Querying Details About Flavors and Extended Flavor Information ` | -| | - :ref:`Data Structure for Creating ECSs ` | -| | - :ref:`Error Codes ` | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-06-18 | Modified the following content: | -| | | -| | - Added the **metadata** field for creating disks in :ref:`Data Structure for Creating ECSs `. | -| | - Added **\__system__encrypted** and **\__system__cmkid** to the **metadata** field as well as one request example with system disk encrypted in :ref:`Reinstalling an ECS OS (Using an Image with Cloud-Init Installed) `. | -| | - Added **\__system__encrypted** and **\__system__cmkid** to the **metadata** field as well as one request example with system disk encrypted in :ref:`Changing an ECS OS (Using an Image with Cloud-Init Installed) `. | -| | - Modified the description of the **metadata** field in **root_volume**, added a request example for **\__system__encrypted**, and added a request example with system disk encrypted in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-04-22 | Modified the following content: | -| | | -| | Added parameter **extendparam** to the **data_volumes** field in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-12-18 | Added the following content: | -| | | -| | - :ref:`Tag Management ` | -| | - :ref:`ECS Group Management ` | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-13 | Modified the following content: | -| | | -| | - Deleted "Creating an FPGA Image". | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-25 | Modified the following content: | -| | | -| | - Added description in "Creating an FPGA Image", indicating that only Xilinx VU9P images can be created. | -| | - Added the full spelling of DCP in "Creating an FPGA Image". | -| | - Changed **AEI** to its full spelling in "Creating an FPGA Image". | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-09 | Modified the following content: | -| | | -| | - Deleted the **final_tenant** field in :ref:`Creating an ECS `. | -| | - Added a request example in :ref:`Creating an ECS `. | -| | - Added an API constraint in :ref:`Creating an Image Using an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-01-30 | Added the following content: | -| | | -| | - Added "Creating an FPGA Image". | -| | | -| | Modified the following content: | -| | | -| | - Added description in :ref:`Querying All API Versions ` and :ref:`Querying a Specified API Version ` because microversion header "OpenStack-API-Version" is supported in microversion 2.27 and later. | -| | - Modified description in several sections, such as :ref:`Querying Details About ECSs `, :ref:`Querying Details About ECSs `, :ref:`Rebuilding an ECS `, :ref:`Querying Tenant Quota Limits `, :ref:`Querying Tenant Quotas `, and :ref:`Querying Default Quotas ` because OpenStack Queens is supported. | -| | - Changed ECS metric names. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-01-25 | Modified the following content: | -| | | -| | - Modified the example response in :ref:`Querying Disk Attachment of an ECS `. | -| | - Modified the URL description of the response parameter in :ref:`Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later) `. | -| | - Added the **reserve_port** parameter description in :ref:`Deleting a NIC from an ECS `. | -| | - Added tag constraints in :ref:`Tag Types `. | -| | | -| | Deleted the following content: | -| | | -| | Deleted parameter **check_resources** in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-30 | Modified the following content: | -| | | -| | - Modified function description in :ref:`Deleting ECSs `. | -| | - Modified function description in :ref:`Starting ECSs in a Batch `. | -| | - Modified function description in :ref:`Restarting ECSs in a Batch `. | -| | - Modified function description in :ref:`Stopping ECSs in a Batch `. | -| | - Added error codes in :ref:`Error Codes `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-22 | Added the following content: | -| | | -| | - :ref:`AZ ` | -| | - :ref:`Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later) ` | -| | - :ref:`Cold Migrating an ECS ` | -| | | -| | Modified the following content: | -| | | -| | - Added the **reserve_port** field in :ref:`Deleting a NIC from an ECS `. | -| | - Added the **attachableQuantity** field in :ref:`Querying Disk Attachment of an ECS `. | -| | - Added the **final_tenant** field in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-10 | Added the following content: | -| | | -| | - :ref:`Querying the Target Flavors to Which an ECS Flavor Can Be Changed ` | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-11-22 | Added the following content: | -| | | -| | - :ref:`Querying Automatic Recovery of an ECS ` | -| | - 6.2.6 Managing Automatic Recovery of an ECS | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-12 | Added the following content: | -| | | -| | - :ref:`API Version Query ` | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-30 | Modified the following content: | -| | | -| | - Deleted the API for querying the target ECS flavors to which a flavor can be changed. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-10 | Accepted in OTC 3.2. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-31 | Added the following content: | -| | | -| | - :ref:`Querying ECSs by Tag ` | -| | - :ref:`Querying Project Tags (Discarded) ` | -| | | -| | Modified the following content: | -| | | -| | - Added the description of forcible disk uninstallation in :ref:`Detaching an EVS Disk from an ECS `. | -| | - Added constraints in :ref:`Creating an ECS `. | -| | - Added check rules for the **description** parameter in :ref:`Creating an ECS ` and :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-17 | Modified the following content: | -| | | -| | - Modified the example request in :ref:`Modifying the Specifications of an ECS `. | -| | - Adjusted the document structure to separate ECS APIs from native OpenStack APIs. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-31 | Modified the following content: | -| | | -| | - Modified description in :ref:`Creating an ECS `, allowing you to use full-ECS images to create ECSs. | -| | - Modified constraints in :ref:`Changing an ECS OS (Using an Image with Cloud-Init Installed) `, allowing an ECS to change its OS after reinstalling the OS on the ECS failed. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-10 | Added the following content: | -| | | -| | - Added API permissions policies in :ref:`Permissions Policies and Supported Actions `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-05 | Accepted in OTC 3.1. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-29 | Modified the following content: | -| | | -| | - Modified :ref:`Creating an ECS ` because the **snapshotId** field description has been deleted and full-ECS images have been canceled. | -| | - Added the **server** field in :ref:`Creating an ECS `. | -| | - Modified the example request in :ref:`Creating an ECS `. | -| | - Modified constraints in :ref:`Creating an Image Using an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-24 | Modified the following content: | -| | | -| | - Modified the **snapshotId** field description and added request examples in :ref:`Creating an ECS `. | -| | - Modified and added request examples in :ref:`Creating an ECS `. | -| | | -| | Deleted the following content: | -| | | -| | - Deleted the API for querying ECSs by tag. | -| | - Deleted the API for querying project tags. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-14 | Modified the following content: | -| | | -| | - Fixed UAT issues in *Elastic Cloud Server API Reference 28*. | -| | - Modified description in :ref:`Creating an ECS ` for adding the **snapshotId** field, allowing you to use CSBS backups to create full-ECS images and use the images to create ECSs. | -| | | -| | Deleted the following content: | -| | | -| | - Deleted the API for querying tenant quotas. | -| | - Deleted the API for querying tenant quotas. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-05-31 | Modified the following content: | -| | | -| | - Fixed 59 UAT issues in *Elastic Cloud Server API Reference 27*. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-05-21 | Modified the following content: | -| | | -| | - Added :ref:`FPGA Logical File Management `. | -| | - Fixed 110 UAT issues in *Elastic Cloud Server API Reference 26*. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-03-30 | Added the following content: | -| | | -| | - Added description in :ref:`Querying Disk Attachment of an ECS ` for querying disk device names of ECSs. | -| | - Added description in :ref:`Querying a Single Disk Attached to an ECS ` for querying disk device names of ECSs. | -| | | -| | Modified the following content: | -| | | -| | - Added the **dedicated_host_id** field in :ref:`Modifying the Specifications of an ECS `, allowing ECS specifications modification on DeHs. | -| | - Added the **dedicated_host_id** field in :ref:`Modifying the Specifications of an ECS `, allowing ECS specifications modification on DeHs. | -| | - Added the description of forcible data disk uninstallation in :ref:`Detaching a Disk from an ECS `. | -| | - Allowed native OpenStack APIs in V2.1. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-13 | Modified the following content: | -| | | -| | - Modified function description in :ref:`Querying Details About a Security Group (Discarded) `. | -| | - Modified Ecs.0003 description of Ecs.0003 in :ref:`Error Codes `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-12 | Modified the following content: | -| | | -| | - Modified the **from_port**, **to_port**, **ip_range**, and **group** field descriptions in :ref:`Querying Security Groups (Discarded) ` and :ref:`Querying Details About a Security Group (Discarded) `. | -| | - Modified the **description** field description in :ref:`Creating a Security Group (Discarded) `. | -| | - Modified :ref:`Querying Details About Flavors and Extended Flavor Information ` and added the **pci_passthrough:alias** field. | -| | - Modified error messages in :ref:`Error Codes `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-12-30 | Modified the following content: | -| | | -| | - Modified the **tags** field description in :ref:`Creating an ECS `. | -| | - Modified the **os:scheduler_hints** field description in :ref:`Creating an ECS `. | -| | - Added the **pci_passthrough:enable_gpu** and **pci_passthrough:gpu_specs** fields in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -| | - Added handling method for each error code in :ref:`Error Codes `. | -| | - Modified :ref:`Querying Security Groups (Discarded) `. | -| | - Modified :ref:`Creating a Security Group (Discarded) `. | -| | - Modified :ref:`Querying Details About a Security Group (Discarded) `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-10-30 | Modified the following content: | -| | | -| | - Modified the **adminpass** field description. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-30 | Modified the following content: | -| | | -| | - Modified the **volumetype** parameter description in :ref:`Creating an ECS `. | -| | - Modified constraints in :ref:`Creating an ECS `. | -| | - Modified the **user_data** parameter description in :ref:`Reinstalling an ECS OS (Using an Image with Cloud-Init Installed) `. The user data function is supported when the OS is reinstalled. | -| | - Modified the **user_data** parameter description in :ref:`Changing an ECS OS (Using an Image with Cloud-Init Installed) `. The user data function is supported when the OS is changed. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-08-30 | Modified the following content: | -| | | -| | - Modified constraints in :ref:`Creating an ECS `. | -| | - Modified function description in :ref:`Creating an ECS `. | -| | - Modified the **network** field description in :ref:`Creating an ECS `. | -| | - Modified function description in :ref:`Adding a Security Group `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-07-31 | Modified the following content: | -| | | -| | - Added :ref:`Adding a Security Group `. | -| | - Added :ref:`Deleting a Security Group `. | -| | - Modified :ref:`Creating an ECS ` to support ECS creation using a snapshot. | -| | | -| | Deleted the following content: | -| | | -| | - Deleted the **adminPass** field. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-30 | Modified the following content: | -| | | -| | - Modified the **private_key** field description and updated request and response examples in :ref:`Creating and Importing an SSH Key Pair `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-16 | Modified the following content: | -| | | -| | - Modified the **security_groups** field description in :ref:`Querying Details About ECSs `. | -| | - Modified the **security_groups** field description in :ref:`Querying Details About an ECS Flavor `. | -| | - Modified ECS metric description and added the metric **ib_card_state**. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-04-28 | Modified the following content: | -| | | -| | - Modified **metadata** field description in :ref:`Creating an ECS `. | -| | - Changed the field name **attachment_id** to **volume_id** in :ref:`Detaching an EVS Disk from an ECS `. | -| | - Modified the **ecs:virtualization_env_types** field description in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -| | - Modified description of **inst_sys_status_error** in ECS metrics. | -| | | -| | Deleted the following content: | -| | | -| | - Deleted the **tags** field in **Response** in :ref:`Querying Details About ECSs `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-03-30 | Modified the following content: | -| | | -| | - Added the **ecs:generation** and **ecs:virtualization_env_types** fields in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -| | - Changed **key** and **value** lengths and tag naming rules for the **tags** field in :ref:`Creating an ECS `. | -| | - Added the **shareable**, **multiattach**, and **hw:passthrough** fields to the **data_volumes** field in :ref:`Creating an ECS `. | -| | - Modified ECS metric description and added the metric **inst_sys_status_error**. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-02-28 | Modified the following content: | -| | | -| | Modified the **tags** field description in :ref:`Creating an ECS ` (a maximum of 10 tags can be added to an ECS). | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-02-08 | Modified the following content: | -| | | -| | - Added the **tags** field description in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-01-20 | Added the following content: | -| | | -| | - Added error code "Ecs.0219 Failed to create the ECS." | -| | | -| | Modified the following content: | -| | | -| | - Added the **tenancy** and **dedicated_host_id** fields to the **os:scheduler_hints** field description in :ref:`Creating an ECS `. | -| | - Added the **tenancy** and **dedicated_host_id** fields to the **os:scheduler_hints** field description in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-11-30 | Modified the following content: | -| | | -| | - Added password complexity requirements on **adminpass** in :ref:`Creating an ECS ` and :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-30 | This issue is the tenth official release. | -| | | -| | Modified the following content: | -| | | -| | - Added the optional parameters that can be used to query ECS specifications in :ref:`Querying Details About ECS Flavors `. | -| | - Added the **fixed_ips** field in :ref:`Adding a NIC to an ECS `. | -| | - Modified description of **maxSecurityGroups** and **maxSecurityGroupRules** in :ref:`Querying Tenant Quotas `. | -| | - Added the large-memory ECS specification in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-08-25 | Modified the following content: | -| | | -| | - Modified ECS metric description. | -| | - Added **binding:profile** and **extra_dhcp_opts** to table [2] **nics** field description in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-08-09 | Modified the following content: | -| | | -| | - Modified ECS metric description and added metrics **Outband Incoming Rate** and **Outband Outgoing Rate**. | -| | - Modified description of ECS metric **CPU Usage**. | -| | - Changed the maximum user data length to 32 KB in :ref:`Creating an ECS ` and :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-07-15 | Modified the following content: | -| | | -| | - Added the **os:scheduler_hints** field in :ref:`Creating an ECS `. | -| | - Modified description of parameter **group** in table [7] **os:scheduler_hints** field description in :ref:`Creating an ECS `. | -| | - Added disk-intensive ECS specifications and fields in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -| | - Added the **maxServerGroups**, **maxServerGroupMembers**, and **totalServerGroupsUsed** fields in table [1] **absolute** field description in :ref:`Querying Tenant Quotas `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-06-30 | Modified the following content: | -| | | -| | - Changed the status of the **device_name** field in :ref:`Creating an ECS ` to be optional. | -| | - Added parameter description in :ref:`Creating an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-06-16 | Added the following content: | -| | | -| | - Added :ref:`Obtaining the Password for Logging In to an ECS `. | -| | - Added :ref:`Deleting the Password for Logging In to an ECS `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-06-02 | Added the following content: | -| | | -| | - Added :ref:`Network Management `. | -| | - Added :ref:`Security Group Management `. | -| | - Added :ref:`Attaching a Disk to an ECS `. | -| | - Added :ref:`Obtaining the Password for Logging In to an ECS `. | -| | - Added :ref:`Deleting the Password for Logging In to an ECS `. | -| | | -| | Modified the following content: | -| | | -| | - Added the **user_data** field in :ref:`Creating an ECS `. | -| | - Added the **user_data** field in :ref:`Creating an ECS `. | -| | | -| | Deleted the following content: | -| | | -| | - Deleted **Configuring ECS Metadata (Native OpenStack API)**. | -| | - Deleted **Querying the VNC Link of an ECS (Native OpenStack API)**. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-05-05 | Modified the following content: | -| | | -| | - Modified parameter description in :ref:`Creating an ECS `. | -| | - Modified parameter description in :ref:`Creating an ECS `. | -| | - Modified parameter description in :ref:`Deleting ECSs `. | -| | - Modified parameter description in :ref:`Querying ECSs `. | -| | - Modified the **metadata** field in :ref:`Querying Details About ECSs `. | -| | - Modified the **metadata** field in :ref:`Querying Details About ECSs `. | -| | - Modified the **os-stop** field in :ref:`Stopping ECSs in a Batch `. | -| | - Modified the **os-stop** field in :ref:`Stopping an ECS `. | -| | - Modified parameter description in :ref:`Querying Details About Flavors and Extended Flavor Information `. | -| | - Modified response examples in :ref:`Querying Task Execution Status `. | -| | - Modified :ref:`Error Codes `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-04-14 | Added the following content: | -| | | -| | - Added :ref:`Modifying the Specifications of an ECS `. | -| | - Added :ref:`Confirming ECS Specifications Modification `. | -| | - Added :ref:`Rolling Back ECS Specifications Modification `. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-03-09 | This issue is the first official release. | -+-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/api-ref/result/common_parameters/batch_task_request/index.rst b/ecs/api-ref/result/common_parameters/batch_task_request/index.rst deleted file mode 100644 index bc8d8f08..00000000 --- a/ecs/api-ref/result/common_parameters/batch_task_request/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0142195138: - -================== -Batch Task Request -================== - -.. toctree:: - :maxdepth: 1 - - responses_batch_operation diff --git a/ecs/api-ref/result/common_parameters/batch_task_request/responses_batch_operation.rst b/ecs/api-ref/result/common_parameters/batch_task_request/responses_batch_operation.rst deleted file mode 100644 index a00e2f69..00000000 --- a/ecs/api-ref/result/common_parameters/batch_task_request/responses_batch_operation.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0142195139.html - -.. _en-us_topic_0142195139: - -Responses (Batch Operation) -=========================== - -The following responses are only for resetting the passwords for logging in to ECSs in a batch and for modifying ECS specifications in a batch. For details about the responses of other batch operations, see :ref:`Responses (Task) `. - -- Normal responses - - +-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+=========================================================================================================================================================+ - | response | Array of objects | Specifies the response returned after a request is successfully submitted. For details, see :ref:`Table 1 `. | - +-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _en-us_topic_0142195139__table849372311389: - - .. table:: **Table 1** **response** field description - - +-----------+--------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================+ - | id | String | Specifies the ID of the ECS on which the operation has been successfully performed. | - +-----------+--------+-------------------------------------------------------------------------------------+ - -- Abnormal responses - - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+============================================================================================================================================================+ - | error | Object | Specifies the error in a batch request. For details, see :ref:`Table 2 `. | - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | internalError | Array of objects | Specifies the error in each request among the requests submitted in a batch. For details, see :ref:`Table 3 `. | - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _en-us_topic_0142195139__table6409189311151: - - .. table:: **Table 2** **error** field structure - - ========= ====== =============================================== - Parameter Type Description - ========= ====== =============================================== - message String Describes a batch operation error. - code String Specifies the code for a batch operation error. - ========= ====== =============================================== - - .. _en-us_topic_0142195139__table1540134517514: - - .. table:: **Table 3** **internalEroCMM.0101r** field description - - +---------------+--------+--------------------------------------------------------+ - | Parameter | Type | Description | - +===============+========+========================================================+ - | id | String | Specifies the ID of the ECS on which a request failed. | - +---------------+--------+--------------------------------------------------------+ - | error_message | String | Describes a single request failure. | - +---------------+--------+--------------------------------------------------------+ - | error_code | String | Specifies the code for a single request error. | - +---------------+--------+--------------------------------------------------------+ - -- Example response - - Normal response - - .. code-block:: - - { - "response": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19" - }, - { - "id": "516fb98f-46ca-475e-917e-2563e5a8cd12" - } - ] - } - - Abnormal response - - .. code-block:: - - { - "error": { - "code": "Ecs.xxxx", - "message": "xxxxxxxxxxxxxxx" - }, - "internalError": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", - "error_code": "ECS.XXXX", - "error_message": "xxxxxxxxxxxxxxx" - }, - { - "id": "516fb98f-46ca-475e-917e-2563e5a8cd12", - "error_code": "ECS.XXXX", - "error_message": "xxxxxxxxxxxxxxx" - } - ] - } diff --git a/ecs/api-ref/result/common_parameters/index.rst b/ecs/api-ref/result/common_parameters/index.rst deleted file mode 100644 index 6ff5230e..00000000 --- a/ecs/api-ref/result/common_parameters/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0065820821: - -================= -Common Parameters -================= - -.. toctree:: - :maxdepth: 1 - - returned_values_for_general_requests - task_request_result/index - batch_task_request/index diff --git a/ecs/api-ref/result/common_parameters/returned_values_for_general_requests.rst b/ecs/api-ref/result/common_parameters/returned_values_for_general_requests.rst deleted file mode 100644 index 7e323e86..00000000 --- a/ecs/api-ref/result/common_parameters/returned_values_for_general_requests.rst +++ /dev/null @@ -1,54 +0,0 @@ -:original_name: en-us_topic_0022067716.html - -.. _en-us_topic_0022067716: - -Returned Values for General Requests -==================================== - -- Normal - - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | Returned Value | Description | - +================+===================================================================================================================+ - | 200 | Request succeeded. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | 202 | After the task is successfully delivered, the task to be delivered shall be postponed because the system is busy. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | 204 | The task is successfully delivered. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - -- Abnormal - - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Returned Value | Description | - +===================================+=========================================================================================================================================================+ - | 300 multiple choices | The requested resource has multiple available responses. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 400 Bad Request | The server failed to process the request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 401 Unauthorized | You need to enter the username and password to access the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 403 Forbidden | You are forbidden to access the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 404 Not Found | The server cannot find the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 405 Method Not Allowed | You are not allowed to use the method specified in the request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 406 Not Acceptable | The response generated by the server cannot be accepted by the client. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 407 Proxy Authentication Required | You must use the proxy server for authentication. Then, the request can be processed. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 408 Request Timeout | The request timed out. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 409 Conflict | The request cannot be processed due to a conflict. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 500 Internal Server Error | Failed to complete the request because an internal service error occurs. A service exception occurred. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 501 Not Implemented | Failed to complete the request because an internal service error occurs. The server does not support the requested function. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 502 Bad Gateway | Failed to complete the request because an internal service error occurs. Failed to complete the request because the server receives an invalid request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 503 Service Unavailable | Failed to complete the request because an internal service error occurs. The system is currently unavailable. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 504 Gateway Timeout | A gateway timeout error occurs. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/api-ref/result/common_parameters/task_request_result/index.rst b/ecs/api-ref/result/common_parameters/task_request_result/index.rst deleted file mode 100644 index 24d24c12..00000000 --- a/ecs/api-ref/result/common_parameters/task_request_result/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0022067713: - -=================== -Task Request Result -=================== - -.. toctree:: - :maxdepth: 1 - - responses_task - returned_values diff --git a/ecs/api-ref/result/common_parameters/task_request_result/responses_task.rst b/ecs/api-ref/result/common_parameters/task_request_result/responses_task.rst deleted file mode 100644 index 5de11854..00000000 --- a/ecs/api-ref/result/common_parameters/task_request_result/responses_task.rst +++ /dev/null @@ -1,72 +0,0 @@ -:original_name: en-us_topic_0022067714.html - -.. _en-us_topic_0022067714: - -Responses (Task) -================ - -- Normal response description - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+================================================================================================================================================================================================================================================+ - | job_id | String | Specifies the returned task ID after delivering the task. Users can query the task progress using this ID. For how to query the execution status of the task based on the task ID, see :ref:`Task Status Management `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- Abnormal response description - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==========================================================================================================================================+ - | error | Object | Specifies the returned error message when an error occurs. For details, see :ref:`Table 1 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _en-us_topic_0022067714__table6409189311151: - - .. table:: **Table 1** **error** field structure - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================+ - | message | String | Describes the error message when an error occurs. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | code | String | Specifies the error code when an error occurs. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - | details | Array of objects | Specifies error details. | - | | | | - | | | Error details provide the error code and fault description, facilitating error handling. | - | | | | - | | | This field is optional. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------+ - - .. table:: **Table 2** **details** field description - - +-----------------------+-----------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===================================================+ - | message | String | Describes the error message when an error occurs. | - | | | | - | | | This field is optional. | - +-----------------------+-----------------------+---------------------------------------------------+ - | code | String | Specifies the error code when an error occurs. | - | | | | - | | | This field is optional. | - +-----------------------+-----------------------+---------------------------------------------------+ - -- Example response - - Normal response - - .. code-block:: - - { - "job_id": "70a599e0-31e7-49b7-b260-868f441e862b" - } - - Abnormal response - - .. code-block:: - - { - "error": {"message": "", "code": XXX,""} - } diff --git a/ecs/api-ref/result/common_parameters/task_request_result/returned_values.rst b/ecs/api-ref/result/common_parameters/task_request_result/returned_values.rst deleted file mode 100644 index 781a8683..00000000 --- a/ecs/api-ref/result/common_parameters/task_request_result/returned_values.rst +++ /dev/null @@ -1,52 +0,0 @@ -:original_name: en-us_topic_0022067715.html - -.. _en-us_topic_0022067715: - -Returned Values -=============== - -- Normal - - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | Returned Value | Description | - +================+===================================================================================================================+ - | 200 | The task is successfully delivered. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | 202 | After the task is successfully delivered, the task to be delivered shall be postponed because the system is busy. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - | 204 | The task is successfully delivered. | - +----------------+-------------------------------------------------------------------------------------------------------------------+ - -- Abnormal - - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Returned Value | Description | - +===================================+=========================================================================================================================================================+ - | 400 Bad Request | The server failed to process the request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 401 Unauthorized | You need to enter the username and password to access the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 403 Forbidden | You are forbidden to access the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 404 Not Found | The server cannot find the page requested. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 405 Method Not Allowed | You are not allowed to use the method specified in the request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 406 Not Acceptable | The response generated by the server cannot be accepted by the client. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 407 Proxy Authentication Required | You must use the proxy server for authentication. Then, the request can be processed. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 408 Request Timeout | The request timed out. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 409 Conflict | The request cannot be processed due to a conflict. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 500 Internal Server Error | Failed to complete the request because an internal service error occurs. A service exception occurred. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 501 Not Implemented | Failed to complete the request because an internal service error occurs. The server does not support the requested function. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 502 Bad Gateway | Failed to complete the request because an internal service error occurs. Failed to complete the request because the server receives an invalid request. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 503 Service Unavailable | Failed to complete the request because an internal service error occurs. The system is currently unavailable. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 504 Gateway Timeout | A gateway timeout error occurs. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/api-ref/result/data_structure/data_structure_for_creating_ecss.rst b/ecs/api-ref/result/data_structure/data_structure_for_creating_ecss.rst deleted file mode 100644 index 5334fdf2..00000000 --- a/ecs/api-ref/result/data_structure/data_structure_for_creating_ecss.rst +++ /dev/null @@ -1,378 +0,0 @@ -:original_name: en-us_topic_0167957246.html - -.. _en-us_topic_0167957246: - -Data Structure for Creating ECSs -================================ - -Contents --------- - -- :ref:`publicip Field Description ` -- :ref:`security_groups Field Description ` -- :ref:`eip Field Description ` -- :ref:`bandwidth Field Description ` -- :ref:`extendparam Field Description for Creating Disks ` -- :ref:`extendparam Field Description for Creating ECSs ` -- :ref:`metadata Field Description for Creating Disks ` -- :ref:`metadata Field Description for Creating ECSs ` -- :ref:`os:scheduler_hints Field Description ` -- :ref:`binding:profile Field Description ` -- :ref:`extra_dhcp_opts Field Description ` - -.. _en-us_topic_0167957246__section1846944811410: - -**publicip** Field Description ------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table2785183710710: - -.. table:: **Table 1** **publicip** field description - - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+======================================================================================================+ - | id | No | String | Specifies the ID of the existing EIP assigned to the ECS to be created. The value is in UUID format. | - | | | | | - | | | | Only EIPs in **DOWN** state can be assigned. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - | eip | No | Object | Specifies an EIP that will be automatically assigned to an ECS. | - | | | | | - | | | | For details, see :ref:`Table 3 `. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - | delete_on_termination | No | Boolean | Specifies whether the EIP is released when the ECS where the EIP is bound is deleted. | - | | | | | - | | | | - **true**: The EIP is released when the ECS is deleted. | - | | | | - **false**: The EIP is not released when the ECS is deleted. | - | | | | | - | | | | The default value is **false**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is available only for pay-per-use EIPs. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - -.. note:: - - Either **id** or **eip** in the **publicip** field can be configured. - -.. _en-us_topic_0167957246__section332191084315: - -**security_groups** Field Description -------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table1698566599: - -.. table:: **Table 2** **security_groups** field description - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+========================================================================================================================================================================================================================================================================================+ - | id | No | String | Specifies the ID of the security group to which an ECS is to be added. The configuration will take effect on the NICs of the ECS. You need to specify the ID of an existing security group in UUID format. Otherwise, the default security group will be used at the underlying layer. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section1840318312449: - -**eip** Field Description -------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table020717438159: - -.. table:: **Table 3** **eip** field description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================+ - | iptype | Yes | String | Specifies the EIP type. | - | | | | | - | | | | For details about the enumerated values, see the **publicip** field in "Assigning an EIP" in *Virtual Private Cloud API Reference*. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | bandwidth | Yes | Object | Specifies the EIP bandwidth. | - | | | | | - | | | | For details, see :ref:`bandwidth Field Description `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section172789339448: - -**bandwidth** Field Description -------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. table:: **Table 4** **bandwidth** field description - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================+ - | size | Yes | Integer | Specifies the bandwidth size. | - | | | | | - | | | | Specifies the bandwidth (Mbit/s). The value ranges from 1 to 1000. | - | | | | | - | | | | The specific range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sharetype | Yes | String | Specifies the bandwidth sharing type. | - | | | | | - | | | | Enumerated values: **PER** (indicates exclusive bandwidth) and **WHOLE** (indicates sharing) | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | chargemode | Yes | String | Specifies the bandwidth billing mode. | - | | | | | - | | | | - If the field value is **traffic**, the ECS is billed by traffic. | - | | | | - If the field value is others, creating the ECS will fail. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section1361484104817: - -**extendparam** Field Description for Creating Disks ----------------------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table7562101331712: - -.. table:: **Table 5** **extendparam** field description for creating disks - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===================================================================================================================================================================================================================================================================================================================+ - | snapshotId | No | String | Specifies the snapshot ID or ID of the original data disk contained in the full-ECS image. | - | | | | | - | | | | **Application scenarios:** | - | | | | | - | | | | This parameter is used if an ECS is created using a full-ECS image, and the image contains one or more data disks. | - | | | | | - | | | | If you use a full-ECS image to create an ECS, the system automatically restores the data type and data from the data disks in the image. The **snapshotId** parameter allows you to specify the disk type for the original data disk after restoration. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - You are advised to set **snapshotId** for each original data disk. Otherwise, the original data disks without **snapshotId** specified will use the default settings. | - | | | | - If you are required to change a disk size, ensure that the changed disk size is greater than or equal to the size of the original data disk. Otherwise, restoring data of the original data disk will fail. | - | | | | | - | | | | **Working rules:** | - | | | | | - | | | | **snapshotId** uniquely identifies an original data disk contained in a full-ECS image. You can use **snapshotId** to obtain the information of the original data disk for data restoration. | - | | | | | - | | | | **Obtaining snapshotId through the management console:** | - | | | | | - | | | | Log in to the management console, choose **Elastic Volume Service** > **Snapshot**. Then, use the name of the original data disk to find the snapshot ID or the original disk ID. | - | | | | | - | | | | **Obtaining snapshotId through the API:** | - | | | | | - | | | | If you have obtained the full-ECS image ID, obtain the Cloud Backup and Recovery (CBR) or Cloud Server Backup Service (CSBS) backup ID associated with the full-ECS image ID by following the instructions provided in the API for querying image details. | - | | | | | - | | | | - If CBR backup is used, use the CBR backup ID to obtain the backup. The **resource_id** or **snapshot_id** contained in the children field in the response is the desired **snapshotId**. For details, see the API for "Querying a Specified Backup" in *Cloud Backup and Recovery User Guide*. | - | | | | - If CSBS backup is used, use the CSBS backup ID to obtain the backup. The **source_volume_id** or **snapshot_id** contained in the **volume_backups** field in the response is the desired **snapshotId**. For details, see the API for "Querying a Single Backup" in *Cloud Server Backup Service User Guide*. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section1373711413505: - -**extendparam** Field Description for Creating ECSs ---------------------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table1137234112314: - -.. table:: **Table 6** extendparam field description for creating ECSs (for V1 APIs) - - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+======================================================================================================================================================================================================+ - | regionID | No | String | Specifies the ID of the region where the ECS resides. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | support_auto_recovery | No | Boolean | Specifies whether automatic recovery is enabled on the ECS. | - | | | | | - | | | | - **true**: enables this function. | - | | | | - **false**: disables this function. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is of boolean type. If a non-boolean character is imported, the parameter value is set to **false**. | - | | | | | - | | | | When **support_auto_recovery** is set to **false** and **"cond:compute": autorecovery** is unavailable in the flavor, automatic recovery is not supported. | - | | | | | - | | | | When **support_auto_recovery** is set to **false** and **"cond:compute": autorecovery** is available in the flavor, automatic recovery is supported. | - | | | | | - | | | | You can query whether **"cond:compute": autorecovery** is available in the flavor by referring to :ref:`Querying Details About Flavors and Extended Flavor Information `. | - +-----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section1228814491353: - -**metadata** Field Description for Creating Disks -------------------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. note:: - - - When you create an ECS, both **root_volume** and **data_volume** contain the **metadata** field. - -.. table:: **Table 7** **metadata** field description for creating disks - - +----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +======================+=================+=================+===========================================================================================================================+ - | \__system__encrypted | No | String | Specifies encryption in **metadata**. The value can be **0** (encryption disabled) or **1** (encryption enabled). | - | | | | | - | | | | If this parameter does not exist, the disk will not be encrypted by default. | - +----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - | \__system__cmkid | No | String | Specifies the CMK ID, which indicates encryption in **metadata**. This parameter is used with **\__system__encrypted**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For details about how to obtain the CMK ID, see "Querying the List of CMKs" in *Key Management Service API Reference*. | - +----------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section1574435185018: - -metadata Field Description for Creating ECSs --------------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table2373623012315: - -.. table:: **Table 8** **metadata** reserved field description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================================+ - | admin_pass | No | String | Specifies the password of user **Administrator** for logging in to a Windows ECS. For details, see :ref:`Function `. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is mandatory when a Windows ECS using password authentication is created. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op_svc_userid | No | String | Specifies the user ID. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | agency_name | No | String | Specifies the IAM agency name. | - | | | | | - | | | | An agency is created by a tenant administrator on Identity and Access Management (IAM) to provide temporary credentials for ECSs to access cloud services. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | BYOL | No | String | If you have an OS or a software license (a license certified based on the number of physical servers and cores), you can migrate your services to the cloud platform in BYOL mode to continue using your existing licenses. | - | | | | | - | | | | - **True**: Use your existing licenses. | - | | | | - **False**: System licenses are used. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section16585034175117: - -**os:scheduler_hints** Field Description ----------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs /v1/{project_id}/cloudservers -- Creating ECSs (native API): /v2.1/{project_id}/servers - -.. _en-us_topic_0167957246__table24430409172542: - -.. table:: **Table 9** **os:scheduler_hints** field description (request parameters) - - +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+==========================================================================================================================================+ - | group | No | String | Specifies an ECS group ID, which is in UUID format. | - | | | | | - | | | | Obtain the parameter value from the console or by performing operations provided in :ref:`Querying ECS Groups `. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Ensure that the ECS group uses the anti-affinity policy. You are not advised to use other policies. | - +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | tenancy | No | String | Creates ECSs on a dedicated or shared host. | - | | | | | - | | | | The value of this parameter can be **dedicated** or **shared**. | - +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | dedicated_host_id | No | String | Specifies the dedicated host ID. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | A DeH ID takes effect only when **tenancy** is set to **dedicated**. | - +-------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 10** **os:scheduler_hints** field description (response parameters) - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | group | Array of strings | Specifies an ECS group ID, which is in UUID format. | - | | | | - | | | Obtain the parameter value from the console or by performing operations provided in :ref:`Querying ECS Groups `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | tenancy | Array of strings | Creates ECSs on a dedicated or shared host. | - | | | | - | | | The value of this parameter can be **dedicated** or **shared**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | dedicated_host_id | Array of strings | Specifies the dedicated host ID. | - | | | | - | | | .. note:: | - | | | | - | | | A DeH ID takes effect only when **tenancy** is set to **dedicated**. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section681114217434: - -**binding:profile** Field Description -------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs: /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table42451440577: - -.. table:: **Table 11** **binding:profile** field description - - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=========================+=================+=================+=============================================================================+ - | disable_security_groups | No | Boolean | Indicates that a HANA ECS NIC is not added to a security group. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - A primary HANA ECS NIC must be added to a security group. | - | | | | - At most one HANA ECS NIC is allowed not to add to any security group. | - +-------------------------+-----------------+-----------------+-----------------------------------------------------------------------------+ - -.. _en-us_topic_0167957246__section12781010134512: - -**extra_dhcp_opts** Field Description -------------------------------------- - -This field is used by the following APIs: - -- Creating ECSs: /v1/{project_id}/cloudservers - -.. _en-us_topic_0167957246__table93959401279: - -.. table:: **Table 12** **extra_dhcp_opts** field description - - +-----------+-----------+---------+--------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+========================================================+ - | opt_value | Yes | Integer | Specifies the NIC MTU, which ranges from 1280 to 8888. | - +-----------+-----------+---------+--------------------------------------------------------+ - | opt_name | Yes | String | Set the parameter value to **26**. | - +-----------+-----------+---------+--------------------------------------------------------+ diff --git a/ecs/api-ref/result/data_structure/data_structure_for_query_details_about_specifications.rst b/ecs/api-ref/result/data_structure/data_structure_for_query_details_about_specifications.rst deleted file mode 100644 index fb3fc193..00000000 --- a/ecs/api-ref/result/data_structure/data_structure_for_query_details_about_specifications.rst +++ /dev/null @@ -1,140 +0,0 @@ -:original_name: en-us_topic_0170710254.html - -.. _en-us_topic_0170710254: - -Data Structure for Query Details About Specifications -===================================================== - -**os_extra_specs (flavor)** Field Description ---------------------------------------------- - -This field is used by the following APIs: - -- Querying details about flavors and extended flavor information: /v1/{project_id}/cloudservers/flavors -- Querying details about the extended ECS flavor field: /v1/{project_id}/flavors/{flavor_id}/os-extra_specs - -.. table:: **Table 1** **os_extra_specs** field description - - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================================+=======================+============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | ecs:performancetype | String | Specifies the ECS flavor type: | - | | | | - | | | - **normal**: general computing | - | | | - **cpuv1**: computing I | - | | | - **cpuv2**: computing II | - | | | - **computingv3**: general computing-plus | - | | | - **highmem**: memory-optimized | - | | | - **saphana**: large-memory | - | | | - **saphana**: large-memory HANA ECS | - | | | - **diskintensive**: disk-intensive | - | | | - **highcpu**: high-performance computing | - | | | - **gpu**: GPU-accelerated | - | | | - **fpga**: FPGA-accelerated | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_type | String | Specifies the resource type. **resource_type** is used to differentiate between the types of the physical servers accommodating ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:type | String | Specifies the NIC type. The value of this parameter is consistently **enhanced**, indicating that network enhancement ECSs are to be created. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:instance_bandwidth | String | Specifies the maximum bandwidth in the unit of Mbit/s. The maximum value of this parameter is **10000**. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_vnic:max_count | String | Specifies the maximum number of NICs. The maximum value of this parameter is 4. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:local_disk | String | The value of this parameter is in format of "{type}:{count}:{size}:{safeFormat}", where, | - | | | | - | | | - **type**: indicates the disk type, which can only be HDD. | - | | | - **count**: indicates the number of local disks. | - | | | | - | | | - For D2 ECSs, the value can be 2, 4, 8, 12, 16, or 24. | - | | | - For D3 ECSs, the value can be 2, 4, 8, 12, 16, 24, or 28. | - | | | | - | | | - **size**: indicates the capacity of a single disk, in GB. Currently, only **1675** is supported. The actual disk size is **1800**, and the available size after formatting is **1675**. | - | | | - **safeFormat**: indicates whether the local disks of the ECS are securely formatted. | - | | | | - | | | - For D2 or D3 ECSs, the value is **True**. | - | | | | - | | | .. note:: | - | | | | - | | | This field is dedicated for disk-intensive ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:nvme_ssd | String | The value of this parameter is in the format of {type}:{spec}:{num}:{size}:{safeFormat}:. | - | | | | - | | | - **type**: indicates the capacity of a single NVME SSD disk attached to the ECS, which can only be 1.6 TB or 3.2 TB. | - | | | | - | | | - **spec**: indicates the specification of the NVME SSD disk, which can be **large** or **small**. | - | | | | - | | | If the value is **large**, only I3 ECSs are supported. | - | | | | - | | | - **num**: indicates the number of partitions on the disk. | - | | | | - | | | - **size**: indicates the capacity, in the unit of GB, of the disk used by the guest user. If the **spec** value is **large**, the value of this parameter is the size of a single disk attached to the ECS. If the **spec** value is **small**, the value of this parameter is 1/4 or 1/2 of the specification. | - | | | | - | | | - **safeFormat**: indicates whether the local disks of the ECS are securely formatted. | - | | | | - | | | If the value is **True**, only I3 ECSs are supported. | - | | | | - | | | .. note:: | - | | | | - | | | This field is dedicated for ultra-high I/O ECSs. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:generation | String | Specifies the generation of an ECS type. | - | | | | - | | | For example, **3** in **s3** indicates the general-purpose third-generation ECSs. For details about flavors and generations, see `ECS Specifications `__ in *Elastic Cloud Server User Guide*. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ecs:virtualization_env_types | String | Specifies a virtualization type. | - | | | | - | | | - If the parameter value is **FusionCompute**, the ECS uses Xen virtualization. Currently, the Xen virtualization technology is not supported. | - | | | - If the parameter value is **CloudCompute**, the ECS uses KVM virtualization. | - | | | | - | | | .. note:: | - | | | | - | | | This field is optional. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:enable_gpu | String | Indicates whether the GPU is passthrough. | - | | | | - | | | If the value is **true**, the GPU is passthrough. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pci_passthrough:alias | String | Indicates the model and quantity of passthrough-enabled GPUs on P1 ECSs. The parameter value can be set to **nvidia-p100:1**, indicating that the ECS using this specification will occupy one NVIDIA P100 GPU. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:status | String | This parameter takes effect region-wide. If an AZ is not configured in the **cond:operation:az** parameter, the value of this parameter is used by default. If this parameter is not set or used, the meaning of **normal** applies. Options: | - | | | | - | | | - **normal**: indicates normal commercial use of the flavor. | - | | | - **abandon**: indicates that the flavor has been canceled (not displayed). | - | | | - **sellout**: indicates that the flavor has been sold out. | - | | | - **obt**: indicates that the flavor is under open beta testing (OBT). | - | | | - **obt_sellout**: indicates that the OBT resources are sold out. | - | | | - **promotion**: indicates the recommended flavor (commercial use, which is similar to **normal**). | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:az | String | This parameter takes effect AZ-wide. If an AZ is not configured in this parameter, the value of the **cond:operation:status** parameter is used by default. This parameter is in the format of "az(xx)". The value in parentheses is the flavor status in an AZ. If the parentheses are left blank, the configuration is invalid. The **cond:operation:az** options are the same as the **cond:operation:status** options. | - | | | | - | | | For example, a flavor is for commercial use in AZs 0 and 3, sold out in AZ 1, for OBT in AZ 2, and is canceled in other AZs. Then, set parameters as follows: | - | | | | - | | | - **cond:operation:status**: **abandon** | - | | | - **cond:operation:az**: **az0(normal), az1(sellout), az2(obt), az3(normal)** | - | | | | - | | | .. note:: | - | | | | - | | | Configure this parameter if the flavor status in an AZ is different from the **cond:operation:status** value. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_rate | String | Specifies the maximum bandwidth. | - | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:min_rate | String | Specified the assured bandwidth. | - | | | | - | | | - Unit: Mbit/s. If a bandwidth is in the unit of Gbit/s, it must be divided by 1000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota:max_pps | String | Specifies the maximum intranet PPS. | - | | | | - | | | - Unit: number. If a value is in the unit of 10000, it must be divided by 10000. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:operation:charge | String | Specifies a billing type. | - | | | | - | | | - Both billing types are supported if this parameter is not set. | - | | | - Pay-per-use | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cond:compute | String | Specifies computing constraints. | - | | | | - | | | - **autorecovery**: indicates that automatic recovery is supported. | - | | | - If this parameter does not exist, automatic recovery is not supported. | - +----------------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/api-ref/result/data_structure/data_structure_for_querying_details_about_ecss.rst b/ecs/api-ref/result/data_structure/data_structure_for_querying_details_about_ecss.rst deleted file mode 100644 index 4538b2ad..00000000 --- a/ecs/api-ref/result/data_structure/data_structure_for_querying_details_about_ecss.rst +++ /dev/null @@ -1,179 +0,0 @@ -:original_name: en-us_topic_0169494074.html - -.. _en-us_topic_0169494074: - -Data Structure for Querying Details About ECSs -============================================== - -.. table:: **Table 1** **address** parameters - - +-------------------------+-----------------------+--------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+========================================================+ - | version | String | Specifies the IP address version. | - | | | | - | | | - **4**: indicates IPv4. | - | | | - **6**: indicates IPv6. | - +-------------------------+-----------------------+--------------------------------------------------------+ - | addr | String | Specifies the IP address. | - +-------------------------+-----------------------+--------------------------------------------------------+ - | OS-EXT-IPS:type | String | Specifies the IP address type. | - | | | | - | | | - **fixed**: indicates the private IP address. | - | | | - **floating**: indicates the floating IP address. | - +-------------------------+-----------------------+--------------------------------------------------------+ - | OS-EXT-IPS-MAC:mac_addr | String | Specifies the MAC address. | - +-------------------------+-----------------------+--------------------------------------------------------+ - | OS-EXT-IPS:port_id | String | Specifies the port ID corresponding to the IP address. | - +-------------------------+-----------------------+--------------------------------------------------------+ - -.. table:: **Table 2** **flavor** parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================+ - | id | String | Specifies the ECS flavor ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS flavor name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | disk | String | Specifies the system disk size in the ECS flavor. Value **0** indicates that the disk size is not limited. | - | | | | - | | | The field is invalid in this system. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | vcpus | String | Specifies the number of vCPUs in the ECS flavor. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | ram | String | Specifies the memory size (MB) in the ECS flavor. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **security_groups** parameters - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - name String Specifies the security group name or UUID. - id String Specifies the security group ID. - ========= ====== ========================================== - -The following table lists parameters involved in the fault information attribute. - -.. table:: **Table 4** **fault** parameters - - +-----------+---------+----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+==================================================================================+ - | message | String | Specifies the fault information. | - +-----------+---------+----------------------------------------------------------------------------------+ - | code | Integer | Specifies the error code. | - +-----------+---------+----------------------------------------------------------------------------------+ - | details | String | Specifies the fault details. | - +-----------+---------+----------------------------------------------------------------------------------+ - | created | String | Specifies the time when the fault occurred. The time is in ISO 8601 time format. | - +-----------+---------+----------------------------------------------------------------------------------+ - -.. table:: **Table 5** **os-extended-volumes:volumes_attached** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================================================+ - | id | String | Specifies the disk ID in UUID format. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | delete_on_termination | String | Specifies whether the disk is deleted with the ECS. | - | | | | - | | | - **true**: indicates that the disk is deleted with the ECS. | - | | | - **false**: indicates that the disk is not deleted with the ECS. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | bootIndex | String | Specifies the EVS disk boot sequence. | - | | | | - | | | - **0** indicates the system disk. | - | | | - Non-**0** indicates a data disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - | device | String | Specifies the drive letter of the EVS disk, which is the device name of the EVS disk. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------+ - -.. table:: **Table 6** **metadata** parameters - - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+========================================================================================================================================================================================================+ - | charging_mode | String | Specifies the ECS billing mode. | - | | | | - | | | - **0**: pay-per-use payment (postpaid) | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | Specifies the ID of the VPC where the ECS is located. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EcmResStatus | String | Specifies the ECS frozen status. | - | | | | - | | | - **normal**: The ECS is not frozen. | - | | | - **freeze**: The ECS has been frozen. | - | | | | - | | | .. note:: | - | | | | - | | | The system automatically adds this field, which is mandatory, after an ECS is frozen or unfrozen. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metering.image_id | String | Specifies the image ID of the ECS. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metering.imagetype | String | Specifies the image type. The following types are supported: | - | | | | - | | | - Public image: The value is **gold**. | - | | | - Private image: The value is **private**. | - | | | - Shared image: The value is **shared**. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metering.resourcespeccode | String | Specifies the resource specifications of the ECS. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metering.resourcetype | String | Specifies the resource type of the ECS. | - | | | | - | | | Value **1** indicates ECSs. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cascaded.instance_extrainfo | String | Specifies the extended information about the internal ECSs. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_name | String | Specifies the image name of the ECS. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | agency_name | String | Specifies the IAM agency name. | - | | | | - | | | An agency is created by a tenant administrator on IAM to provide temporary credentials for ECSs to access cloud services. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os_bit | String | Specifies the number of bits in the operating system: **32** or **64**. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os_type | String | Specifies the OS type. The value can be **Linux** or **Windows**. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lockCheckEndpoint | String | Specifies the callback URL for checking whether ECS locking is enabled. | - | | | | - | | | - If ECS locking is enabled, the ECS is locked. | - | | | - If ECS locking is disabled, the ECS is unlocked, and invalid locks are deleted. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lockSource | String | Specifies the lock source. | - | | | | - | | | - Order lock (**ORDER**) | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lockSourceId | String | Specifies the ECS lock source ID. | - | | | | - | | | If **lockSource** is set to **ORDER**, **lockSourceId** is the order ID. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lockScene | String | Specifies the ECS lock type. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | virtual_env_type | String | - If an ECS is created using an iOS image, the value of this parameter is **IsoImage**. | - | | | - If an ECS is created using a non-iOS image, the value of this parameter is **FusionCompute** in versions earlier than 19.5.0, and this parameter will be unavailable in versions later than 19.5.0. | - | | | | - | | | .. note:: | - | | | | - | | | - The **virtual_env_type** cannot be added, deleted, or modified. | - +-----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 7** **sys_tags** parameters - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - key String Specifies the system tag key. - value String Specifies the system tag value. - ========= ====== =============================== - -.. table:: **Table 8** **image** parameters - - ========= ====== ======================= - Parameter Type Description - ========= ====== ======================= - id String Specifies the image ID. - ========= ====== ======================= diff --git a/ecs/api-ref/result/data_structure/index.rst b/ecs/api-ref/result/data_structure/index.rst deleted file mode 100644 index a6261a5a..00000000 --- a/ecs/api-ref/result/data_structure/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0175308115: - -============== -Data Structure -============== - -.. toctree:: - :maxdepth: 1 - - data_structure_for_creating_ecss - data_structure_for_querying_details_about_ecss - data_structure_for_query_details_about_specifications diff --git a/ecs/api-ref/result/index.rst b/ecs/api-ref/result/index.rst deleted file mode 100644 index c0fd6b70..00000000 --- a/ecs/api-ref/result/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -========== -Main Index -========== - -.. toctree:: - :maxdepth: 1 - - api_usage_guidelines - apis_recommended/index - openstack_nova_apis/index - data_structure/index - permissions_policies_and_supported_actions/index - common_parameters/index - out-of-date_apis/index - appendix/index - change_history diff --git a/ecs/api-ref/result/openstack_nova_apis/api_version_query/index.rst b/ecs/api-ref/result/openstack_nova_apis/api_version_query/index.rst deleted file mode 100644 index f66209b9..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/api_version_query/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0065792792: - -================= -API Version Query -================= - -.. toctree:: - :maxdepth: 1 - - querying_all_api_versions - querying_a_specified_api_version diff --git a/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_a_specified_api_version.rst b/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_a_specified_api_version.rst deleted file mode 100644 index bd92e91f..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_a_specified_api_version.rst +++ /dev/null @@ -1,152 +0,0 @@ -:original_name: en-us_topic_0065792794.html - -.. _en-us_topic_0065792794: - -Querying a Specified API Version -================================ - -Function Description --------------------- - -This API is used to query the information of a specified version. - -To support function extension, Nova APIs can be distinguished by version. There are two types of versions: - -- Major version: Independent URL -- Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since version 2.27, the new microversion header OpenStack-API-Version has been supported. - - .. note:: - - If the OpenStack-API-Version request header is used, the version is in the format of "compute microversion". - - For example, if **key** is set to **OpenStack-API-Version**, set **value** to **compute 2.27**. - -URI ---- - -GET /{api_version} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065792794__table46110007: - -.. table:: **Table 1** Parameter description - - =========== ========= ===================================== - Parameter Mandatory Description - =========== ========= ===================================== - api_version Yes Specifies an API version, such as V2. - =========== ========= ===================================== - -Request -------- - -None - -Response --------- - -The following table describes the response parameters. - -.. table:: **Table 2** Response parameters - - +-----------+--------+-------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=======================================================================================================+ - | versions | Object | Specifies the versions. For details, see :ref:`Table 3 `. | - +-----------+--------+-------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065792794__table1970522313484: - -.. table:: **Table 3** **versions** field description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================================================================================================================================+ - | id | string | Specifies the version ID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Object | Specifies the links to resources. For more information, see the `OpenStack Documentation `__. | - | | | | - | | | For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | media-types | Object | Specifies the media types. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | min_version | string | - Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported minimum microversion. | - | | | - If the microversion is not supported, leave this parameter blank. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | string | Specifies the API version status. Possible values are as follows: | - | | | | - | | | - **CURRENT**: This is the preferred API version. | - | | | - **SUPPORTED**: This is the old API version that is still supported. | - | | | - **DEPRECATED**: This is the deprecated API version that will be removed. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | string | The value of this parameter varies by API version. If the API version is 2.0, the value is **2011-01-21T11:33:21Z**. If the API version is 2.1, the value is **2013-07-23T11:33:21Z**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version | string | - Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported maximum microversion. | - | | | - If the microversion is not supported, leave this parameter blank. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065792794__table1586318199718: - -.. table:: **Table 4** **links** field description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================================+ - | href | string | Specifies the links of the corresponding resources. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rel | string | - **self**: A self link contains a versioned link to the resource. Use these links when the link is followed immediately. | - | | | - **bookmark**: A bookmark link provides a permanent link to a resource that is appropriate for long term storage. | - | | | - **alternate**: An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image might have an alternate representation in the OpenStack Image service. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065792794__table1242753025619: - -.. table:: **Table 5** **media-types** field description - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - base string Specifies the basic type. - type string Specifies the media type. - ========= ====== ========================= - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2 - -Example Response ----------------- - -.. code-block:: - - { - "version": { - "min_version": "", - "media-types": [{ - "type": "application/vnd.openstack.compute+json;version=2", - "base": "application/json" - }], - "links": [{ - "rel": "self", - "href": "https://ecs.service.domain.com:443/v2/" - }, - { - "rel": "describedby", - "href": "http://docs.openstack.org/", - "type": "text/html" - }], - "id": "v2.0", - "updated": "1999-02-20T11:33:21Z", - "version": "", - "status": "SUPPORTED" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_all_api_versions.rst b/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_all_api_versions.rst deleted file mode 100644 index 8a7f0d37..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/api_version_query/querying_all_api_versions.rst +++ /dev/null @@ -1,114 +0,0 @@ -:original_name: en-us_topic_0065792793.html - -.. _en-us_topic_0065792793: - -Querying All API Versions -========================= - -Function --------- - -This API is used to query all available Nova versions. - -To support function extension, Nova APIs can be distinguished by version. There are two types of versions: - -- Major version: Independent URL -- Microversion: Used by the HTTP request header X-OpenStack-Nova-API-Version. Since microversion 2.27, the new microversion header OpenStack-API-Version has been supported. - -URI ---- - -GET / - -Request -------- - -None - -Response --------- - -The following table describes the response parameters. - -.. table:: **Table 1** Response parameters - - +-----------+--------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=========================================================================================================+ - | versions | Object | Specifies the API versions. For details, see :ref:`Table 2 `. | - +-----------+--------+---------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065792793__table16114143917: - -.. table:: **Table 2** **versions** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================================+ - | id | string | Specifies the version ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Object | Specifies shortcut links for versions. For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | min_version | string | - Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported minimum microversion. | - | | | - If the microversion is not supported, leave this parameter blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | status | string | Specifies the API version status. Possible values are as follows: | - | | | | - | | | - **CURRENT**: This is the preferred API version. | - | | | - **SUPPORTED**: This is the old API version that is still supported. | - | | | - **DEPRECATED**: This is the deprecated API version that will be removed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | version | string | - Specifies the microversion. If the APIs of this version support microversions, set this parameter to the supported maximum microversion. | - | | | - If the microversion is not supported, leave this parameter blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | string | The value of this parameter varies by API version. | - | | | | - | | | If the API version is 2.0, the value is **2011-01-21T11:33:21Z**. If the API version is 2.1, the value is **2013-07-23T11:33:21Z**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065792793__table1586318199718: - -.. table:: **Table 3** **links** field description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | href | string | Specifies the links of the corresponding resources. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | rel | string | - **self**: A self link contains a versioned link to the resource. Use these links when the link is followed immediately. | - | | | | - | | | - **bookmark**: A bookmark link provides a permanent link to a resource that is appropriate for long term storage. | - | | | | - | | | - **alternate**: An alternate link can contain an alternate representation of the resource. | - | | | | - | | | For example, an OpenStack Compute image might have an alternate representation in the OpenStack Image service. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/ - -Example Response ----------------- - -.. code-block:: - - { - "versions": [{ - "links": [{ - "rel": "self", - "href": "https://ecs.service.domain.com:443/v2/" - }], - "id": "v2.0", - "updated": "2001-09-21T12:33:21Z", - "status": "SUPPORTED" - }] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/az/index.rst b/ecs/api-ref/result/openstack_nova_apis/az/index.rst deleted file mode 100644 index f77da0e5..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/az/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0065817684: - -== -AZ -== - -.. toctree:: - :maxdepth: 1 - - querying_azs diff --git a/ecs/api-ref/result/openstack_nova_apis/az/querying_azs.rst b/ecs/api-ref/result/openstack_nova_apis/az/querying_azs.rst deleted file mode 100644 index 006f51fd..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/az/querying_azs.rst +++ /dev/null @@ -1,104 +0,0 @@ -:original_name: en-us_topic_0065817728.html - -.. _en-us_topic_0065817728: - -Querying AZs -============ - -Function --------- - -This API is used to query AZs. - -URI ---- - -GET /v2.1/{project_id}/os-availability-zone - -GET /v2/{project_id}/os-availability-zone - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817728__en-us_topic_0057973206_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817728__en-us_topic_0057973206_table34970028: - -.. table:: **Table 2** Response parameters - - +----------------------+------------------+------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================+==================+==============================================================================================================================+ - | availabilityZoneInfo | Array of objects | Specifies the AZ information. For details, see :ref:`Table 3 `. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817728__en-us_topic_0057973206_table4376441: - -.. table:: **Table 3** AvailabilityZoneInfo parameter information - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==========================================================================================================================+ - | zoneState | Object | Specifies the AZ status. For details, see :ref:`Table 4 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | hosts | List | The parameter is set to **null**. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | zoneName | String | Specifies the AZ name. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817728__en-us_topic_0057973206_table37797818: - -.. table:: **Table 4** zoneState parameter information - - ========= ======= ======================== - Parameter Type Description - ========= ======= ======================== - available Boolean Specifies the AZ status. - ========= ======= ======================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-availability-zone - -Example Response ----------------- - -.. code-block:: - - { - "availabilityZoneInfo": [{ - "zoneState": { - "available": true - }, - "hosts": null, - "zoneName": "az1" //Replace the value with the actual AZ name. - }, - { - "zoneState": { - "available": true - }, - "hosts": null, - "zoneName": "az2" //Replace the value with the actual AZ name. - }] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/disk_management/attaching_a_disk_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/disk_management/attaching_a_disk_to_an_ecs.rst deleted file mode 100644 index a90e6035..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/disk_management/attaching_a_disk_to_an_ecs.rst +++ /dev/null @@ -1,143 +0,0 @@ -:original_name: en-us_topic_0031167350.html - -.. _en-us_topic_0031167350: - -Attaching a Disk to an ECS -========================== - -Function --------- - -This API is used to attach a disk to an ECS. - -Constraints ------------ - -#. If you attach a bootable disk to an ECS, you must specify the disk drive letter. -#. A disk created using a backup cannot be attached to an ECS as the system disk. -#. An ECS in the **SUSPENDED** or **PAUSED** state, which is specified using the **OS-EXT-STS:vm_state** parameter of the ECS, cannot have a disk attached. -#. The EVS must be in the **available** status. -#. The EVS disk and the target ECS must be located in the same AZ. -#. VBD EVS disks cannot be attached to BMSs. - -URI ---- - -POST /v2/{project_id}/servers/{server_id}/os-volume_attachments - -POST /v2.1/{project_id}/servers/{server_id}/os-volume_attachments - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031167350__table60562285165259: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0031167350__table38613152151549: - -.. table:: **Table 2** Request parameters - - +------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+========+======================================================================================================================+ - | volumeAttachment | Yes | Object | Specifies the volumes to be attached. For details, see :ref:`Table 3 `. | - +------------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0031167350__table40707503151632: - -.. table:: **Table 3** **volumeAttachment** field description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================================================+ - | volumeId | Yes | String | Specifies the ID of the disk to be attached. The value is in UUID format. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device | No | String | Specifies the device name, such as **/dev/sda** or **/dev/sdb**. | - | | | | | - | | | | The new disk device name cannot be the same as an existing one. | - | | | | | - | | | | The device name must be specified based on the sequence of existing device names. Otherwise, the system automatically generates one. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | VBD disk device names can only be **/dev/vdb** through **/dev/vdx**. You are advised to attach the VBD disks in alphabetical order. Otherwise, the disk drive letters may be incorrect on the ECS. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0031167350__table57959838: - -.. table:: **Table 4** Response parameters - - +------------------+--------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+========+======================================================================================================================+ - | volumeAttachment | Object | Specifies the disks attached to an ECS. For details, see :ref:`Table 5 `. | - +------------------+--------+----------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0031167350__table548498215180: - -.. table:: **Table 5** **volumeAttachment** field description - - +-----------+--------+------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+============================================================+ - | device | String | Specifies the device name. | - +-----------+--------+------------------------------------------------------------+ - | serverId | String | Specifies the ID of the target ECS in UUID format. | - +-----------+--------+------------------------------------------------------------+ - | id | String | Specifies the disk ID in UUID format. | - +-----------+--------+------------------------------------------------------------+ - | volumeId | String | Specifies the attaching ID, which is the same as the UUID. | - +-----------+--------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments - -.. code-block:: - - { - "volumeAttachment": { - "volumeId": "54667652-3029-4af8-9222-2d53066fd61c", - "device": "/dev/sdb" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "volumeAttachment": { - "device": "/dev/vdb", - "serverId": "ab258e25-e351-47c7-b6e3-0749c5d9ed6a", - "id": "54667652-3029-4af8-9222-2d53066fd61c", - "volumeId": "54667652-3029-4af8-9222-2d53066fd61c" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/disk_management/detaching_a_disk_from_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/disk_management/detaching_a_disk_from_an_ecs.rst deleted file mode 100644 index c2ee745b..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/disk_management/detaching_a_disk_from_an_ecs.rst +++ /dev/null @@ -1,139 +0,0 @@ -:original_name: en-us_topic_0065817707.html - -.. _en-us_topic_0065817707: - -Detaching a Disk from an ECS -============================ - -Function --------- - -This API is used to detach a disk from an ECS. - -Constraints ------------ - -The system disk, the device name of which is **/dev/sda**, and user disks can be detached from an ECS only when the ECS is stopped. There are no requirements on OTC Tools. - -When an ECS is in the **active** state, pay attention to the following constraints: - -#. Only data disks, the device name of which is not **/dev/sda**, can be detached from an ECS. -#. Make sure that OTC Tools have been installed and enabled on the ECS. Otherwise, the uninstallation will fail. -#. For a Linux ECS, you need to log in to the ECS and run the **umount** command to disassociate the target disk from the file system. In addition, you need to ensure that no data is being written into or being read from the disk. Otherwise, the detachment will fail. -#. For a Windows ECS, you need to ensure that no data is being written into or being read from the disk when a disk is to be detached from the running ECS. Otherwise, data will be lost. -#. OSs supporting EVS disk detachment from a running ECS include two parts: - - - For the first part, see `Formats and OSs Supported for External Image Files `__. - - - :ref:`Table 1 ` lists the second part of supported OSs. - - .. _en-us_topic_0065817707__en-us_topic_0036046828_table9271324195455: - - .. table:: **Table 1** OSs supporting EVS disk detachment from a running ECS - - +-----------------------------------------------------------------+-------------------------------------------+ - | OS | Version | - +=================================================================+===========================================+ - | CentOS | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 7.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.7 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Debian | 8.6.0 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 8.5.0 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Fedora | 25 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 24 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | SUSE | SUSE Linux Enterprise Server 12 SP2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 12 SP1 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 11 SP4 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 12 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | OpenSUSE | 42.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 42.1 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Oracle Linux Server release | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 7.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.7 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Ubuntu Server | 16.04 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 14.04 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 14.04.4 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Windows (SCSI EVS disks cannot be detached from a running ECS.) | Windows Server 2008 R2 Enterprise 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | Windows Server 2012 R2 Standard 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | Windows Server 2016 R2 Standard 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Red Hat Linux Enterprise | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -DELETE /v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -:ref:`Table 2 ` describes the parameters in the URI. - -.. _en-us_topic_0065817707__en-us_topic_0057973182_table2814978410562: - -.. table:: **Table 2** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - volume_id Yes Specifies the volume ID. - ========== ========= ========================= - -Usage: DELETE /v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/6fbe9263116a4b68818cf1edce16bc4f/servers/ab258e25-e351-47c7-b6e3-0749c5d9ed6a/os-volume_attachments/54667652-3029-4af8-9222-2d53066fd61c - DELETE https://{endpoint}/v2.1/6fbe9263116a4b68818cf1edce16bc4f/servers/ab258e25-e351-47c7-b6e3-0749c5d9ed6a/os-volume_attachments/54667652-3029-4af8-9222-2d53066fd61c - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/disk_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/disk_management/index.rst deleted file mode 100644 index e6f84849..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/disk_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0020212667: - -=============== -Disk Management -=============== - -.. toctree:: - :maxdepth: 1 - - querying_disks_attached_to_an_ecs - querying_a_disk_attached_to_an_ecs - attaching_a_disk_to_an_ecs - detaching_a_disk_from_an_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_a_disk_attached_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_a_disk_attached_to_an_ecs.rst deleted file mode 100644 index 0eb0d22e..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_a_disk_attached_to_an_ecs.rst +++ /dev/null @@ -1,93 +0,0 @@ -:original_name: en-us_topic_0020212672.html - -.. _en-us_topic_0020212672: - -Querying a Disk Attached to an ECS -================================== - -Function --------- - -This API is used to query a disk attached to an ECS based on the disk ID. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -GET /v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212672__table61787501: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - volume_id Yes Specifies the disk ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212672__table769899: - -.. table:: **Table 2** Response parameters - - +------------------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==================+========+==================================================================================================================+ - | volumeAttachment | Object | Specifies the disks attached to an ECS. For details, see :ref:`Table 3 `. | - +------------------+--------+------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212672__table42716605: - -.. table:: **Table 3** **volumeAttachment** field description - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - device String Specifies the attached directory. - id String Specifies the ID of the attached resource. - serverId String Specifies the ECS ID. - volumeId String Specifies the ID of the attached disk. - ========= ====== ========================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} - -Example Response ----------------- - -.. code-block:: - - { - "volumeAttachment": - { - "device": "/dev/sdd", - "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_disks_attached_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_disks_attached_to_an_ecs.rst deleted file mode 100644 index 9b1cfb01..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/disk_management/querying_disks_attached_to_an_ecs.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0020212671.html - -.. _en-us_topic_0020212671: - -Querying Disks Attached to an ECS -================================= - -Function --------- - -This API is used to query the disks attached to an ECS. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments - -GET /v2/{project_id}/servers/{server_id}/os-volume_attachments - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212671__table35893824: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -**Response parameters** - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212671__table57959838: - -.. table:: **Table 2** Response parameters - - +-------------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================+==================+=================================================================================================================+ - | volumeAttachments | Array of objects | Specifies the disks attached to an ECS. For details, see :ref:`Table 3 `. | - +-------------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212671__table7886611: - -.. table:: **Table 3** **volumeAttachments** field description - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - device String Specifies the attached directory. - id String Specifies the ID of the attached resource. - serverId String Specifies the ECS ID. - volumeId String Specifies the ID of the attached disk. - ========= ====== ========================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-volume_attachments - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-volume_attachments - -Example Response ----------------- - -.. code-block:: - - { - "volumeAttachments": [ - { - "device": "/dev/sdd", - "id": "a26887c6-c47b-4654-abb5-dfadf7d3f803", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" - }, - { - "device": "/dev/sdc", - "id": "a26887c6-c47b-4654-abb5-dfadf7d3f804", - "serverId": "4d8c3732-a248-40ed-bebc-539a6ffd25c0", - "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f804" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/index.rst deleted file mode 100644 index 05931196..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0167809634: - -====================== -ECS Console Management -====================== - -.. toctree:: - :maxdepth: 1 - - obtaining_ecs_management_console_logs - obtaining_a_vnc-based_remote_login_address_microversion_2.6_or_later diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_a_vnc-based_remote_login_address_microversion_2.6_or_later.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_a_vnc-based_remote_login_address_microversion_2.6_or_later.rst deleted file mode 100644 index 68f94773..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_a_vnc-based_remote_login_address_microversion_2.6_or_later.rst +++ /dev/null @@ -1,133 +0,0 @@ -:original_name: en-us_topic_0142763126.html - -.. _en-us_topic_0142763126: - -Obtaining a VNC-based Remote Login Address (Microversion 2.6 or Later) -====================================================================== - -Function --------- - -This API is used to obtain the address for remotely logging in to an ECS using VNC. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/remote-consoles - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0142763126__en-us_topic_0092803065_table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Constraints ------------ - -- When using this API, ensure that the microversion is 2.6 or later. - - Add a microversion using the HTTP request header X-OpenStack-Nova-API-Version or OpenStack-API-Version. - - For example, X-OpenStack-Nova-API-Version: 2.6 or OpenStack-API-Version: compute 2.6 - -- An obtained login address is valid for 10 minutes. Obtain a new one after expiration. - -Request -------- - -.. table:: **Table 2** Request parameters - - +----------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+=================================================================================================================================================+ - | remote_console | Yes | Object | Obtains the address for remotely logging in to an ECS using VNC. For details, see :ref:`Table 3 `. | - +----------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0142763126__table19959184318164: - -.. table:: **Table 3** **remote_console** parameters - - +-----------+-----------+--------+-------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=======================================================+ - | type | Yes | String | Specifies a remote login mode. Set it to **novnc**. | - +-----------+-----------+--------+-------------------------------------------------------+ - | protocol | Yes | String | Specifies a remote login protocol. Set it to **vnc**. | - +-----------+-----------+--------+-------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0142763126__table8420447171011: - -.. table:: **Table 4** Response parameters - - +----------------+--------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+========+=======================================================================================================================================+ - | remote_console | Object | Obtains the address for remotely logging in to an ECS. For details, see :ref:`Table 5 `. | - +----------------+--------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0142763126__table12434194718104: - -.. table:: **Table 5** **remote_console** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | type | String | Specifies a remote login mode. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | protocol | String | Specifies a remote login protocol. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | url | String | Specifies a remote login URL. | - | | | | - | | | The URL is valid for 10 minutes. Obtain a new one after expiration. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/13c67a214ced4afb88d911ae4bd5721a/servers/47bc79ae-df61-4ade-9197-283a74e5d70e/remote-consoles - -.. code-block:: - - { - "remote_console" : { - "type" : "novnc", - "protocol": "vnc" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "remote_console": { - "url": "https://nova-novncproxy.az21.dc1.domainname.com:8002/vnc.auto.html?token=80fa7c8d-37fe-451e-8b08-bfbd9fb6a4df&lang=EN", - "type": "novnc", - "protocol": "vnc" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_ecs_management_console_logs.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_ecs_management_console_logs.rst deleted file mode 100644 index 820a9cda..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_console_management/obtaining_ecs_management_console_logs.rst +++ /dev/null @@ -1,106 +0,0 @@ -:original_name: en-us_topic_0065817689.html - -.. _en-us_topic_0065817689: - -Obtaining ECS Management Console Logs -===================================== - -Function --------- - -This API is used to obtain ECS management console logs. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817689__table10917102617186: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Constraints ------------ - -This API will be discarded since a version later than microversion 2.5. When using this API, set the microversion to 2.5 or earlier. - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817689__table168291156125012: - -.. table:: **Table 2** Request parameters - - +---------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+========+===========================================================================================================================================+ - | os-getConsoleOutput | Yes | Object | Obtains ECS management console logs. For details, see :ref:`Table 3 `. | - +---------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817689__en-us_topic_0062473752_table1919246111545: - -.. table:: **Table 3** os-getConsoleOutput parameter description - - +-----------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+=====================================================================================================================================+ - | length | Yes | Integer | Specifies the number of request log rows. The value is greater than or equal to -1, which indicates that the output is not limited. | - +-----------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameter. - -.. _en-us_topic_0065817689__table18130192135217: - -.. table:: **Table 4** Response parameter - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - output String Specifies the ECS console logs. - ========= ====== =============================== - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - -.. code-block:: - - { - "os-getConsoleOutput" : { - "length" : "50" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "output": "FAKE CONSOLEOUTPUT\nANOTHER\nLAST LINE" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/creating_an_ecs_group.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/creating_an_ecs_group.rst deleted file mode 100644 index 6356cf13..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/creating_an_ecs_group.rst +++ /dev/null @@ -1,161 +0,0 @@ -:original_name: en-us_topic_0065817720.html - -.. _en-us_topic_0065817720: - -Creating an ECS Group -===================== - -Function --------- - -This API is used to create an ECS group. - -Constraints ------------ - -Only anti-affinity groups are supported. - -URI ---- - -POST /v2.1/{project_id}/os-server-groups - -POST /v2/{project_id}/os-server-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817720__table1334523718138: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817720__table173242991418: - -.. table:: **Table 2** Request parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+======================================================================================================================================+ - | server_group | Yes | Object | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817720__en-us_topic_0057973153_table19917766: - -.. table:: **Table 3** **server_group** field description - - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+======================================================================================================================================================================================================================+ - | name | Yes | String | Specifies the ECS group name. The value contains 1 to 255 characters. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Yes | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | | - | | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Only the anti-affinity policy is supported. The other three policies are retained to be compatible with native APIs. However, you are not advised to use the other three policies. | - | | | | | - | | | | You are suggested to use the policy described in :ref:`Creating an ECS Group `. | - +-----------------+-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817720__table14250354151412: - -.. table:: **Table 4** Response parameters - - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=====================================================================================================================================+ - | server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 5 `. | - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817720__en-us_topic_0057973153_table7944126: - -.. table:: **Table 5** **server_group** field description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===================================================================================================================================================================================================================+ - | id | String | Specifies the ECS group UUID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | - | | | **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | | - | | | **affinity**: ECSs in this group must be deployed on the same host. | - | | | | - | | | **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | | - | | | **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the ECSs contained in an ECS group. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the tenant ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the user ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups - POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups - -.. code-block:: - - { - "server_group": { - "name": "test", - "policies": ["anti-affinity"] - } - } - -Example Response ----------------- - -.. code-block:: - - { - "server_group": { - "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", - "name": "test", - "policies": [ - "anti-affinity" - ], - "members": [], - "metadata": {} - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/deleting_an_ecs_group.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/deleting_an_ecs_group.rst deleted file mode 100644 index 3090b1e3..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/deleting_an_ecs_group.rst +++ /dev/null @@ -1,54 +0,0 @@ -:original_name: en-us_topic_0065817723.html - -.. _en-us_topic_0065817723: - -Deleting an ECS Group -===================== - -Function --------- - -This API is used to delete an ECS group. - -URI ---- - -DELETE /v2.1/{project_id}/os-server-groups/{server_group_id} - -DELETE /v2/{project_id}/os-server-groups/{server_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817723__table105214393178: - -.. table:: **Table 1** Parameter description - - =============== ========= ============================= - Parameter Mandatory Description - =============== ========= ============================= - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group UUID. - =============== ========= ============================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9 - DELETE https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9 - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/index.rst deleted file mode 100644 index d13b8b08..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0065817683: - -==================== -ECS Group Management -==================== - -.. toctree:: - :maxdepth: 1 - - creating_an_ecs_group - querying_ecs_groups - querying_details_about_an_ecs_group - deleting_an_ecs_group diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_details_about_an_ecs_group.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_details_about_an_ecs_group.rst deleted file mode 100644 index aa0a6ac8..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_details_about_an_ecs_group.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: en-us_topic_0065817722.html - -.. _en-us_topic_0065817722: - -Querying Details About an ECS Group -=================================== - -Function --------- - -This API is used to query details bout an ECS group. - -URI ---- - -GET /v2.1/{project_id}/os-server-groups/{server_group_id} - -GET /v2/{project_id}/os-server-groups/{server_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817722__table1773113411618: - -.. table:: **Table 1** Parameter description - - =============== ========= ============================= - Parameter Mandatory Description - =============== ========= ============================= - project_id Yes Specifies the project ID. - server_group_id Yes Specifies the ECS group UUID. - =============== ========= ============================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817722__table176896216171: - -.. table:: **Table 2** Response parameters - - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=====================================================================================================================================+ - | server_group | Object | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +--------------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817722__en-us_topic_0057973159_table5520021: - -.. table:: **Table 3** **server_group** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================================================================================+ - | id | String | Specifies the ECS group UUID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. | - | | | | - | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - | | | | - | | | .. note:: | - | | | | - | | | Only anti-affinity policies are supported. You are not advised to use other policies. If other policies are used, creating the ECS group will fail. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the ECSs contained in the ECS group. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the tenant ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the user ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9 - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups/5bbcc3c4-1da2-4437-a48a-66f15b1b13f9 - -Example Response ----------------- - -.. code-block:: - - { - "server_group": { - "id": "5bbcc3c4-1da2-4437-a48a-66f15b1b13f9", - "name": "test", - "policies": ["anti-affinity"], - "members": [], - "metadata": {}, - "project_id": "9c53a566cb3443ab910cf0daebca90c4" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_ecs_groups.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_ecs_groups.rst deleted file mode 100644 index 830046ec..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_group_management/querying_ecs_groups.rst +++ /dev/null @@ -1,120 +0,0 @@ -:original_name: en-us_topic_0065817721.html - -.. _en-us_topic_0065817721: - -Querying ECS Groups -=================== - -Function --------- - -This API is used to query ECS groups. - -URI ---- - -GET /v2.1/{project_id}/os-server-groups - -GET /v2/{project_id}/os-server-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817721__table12344152719154: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Parameters in the following table can be used as URI parameters to filter query results. - -Usage: /v2/{project_id}/os-server-groups? - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817721__table151218547156: - -.. table:: **Table 2** Response parameters - - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+======================================================================================================================================+ - | server_groups | Array of objects | Specifies the ECS group information. For details, see :ref:`Table 3 `. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817721__en-us_topic_0057973158_table47937085: - -.. table:: **Table 3** **server_groups** parameter information - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================================================================================+ - | id | String | Specifies the ECS group UUID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS group name. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | members | Array of strings | Specifies the ECSs in an ECS group. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS group metadata. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | String | Specifies the tenant ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | policies | Array of strings | Specifies the policies associated with the ECS group. Options: | - | | | | - | | | - **anti-affinity**: ECSs in this group must be deployed on different hosts. | - | | | - **affinity**: ECSs in this group must be deployed on the same host. | - | | | - **soft-anti-affinity**: ECSs in this group are deployed on different hosts if possible. If the ECSs cannot be deployed on different hosts, deploy them based on the actual condition for successful ECS creation. | - | | | - **soft-affinity**: ECSs in this group are deployed on the same host if possible. If the ECSs cannot be deployed on the same host, deploy them based on the actual condition for successful ECS creation. | - | | | | - | | | .. note:: | - | | | | - | | | Only anti-affinity policies are supported. You are not advised to use other policies. If other policies are used, creating the ECS group will fail. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the user ID in UUID format for the ECS group. | - | | | | - | | | This parameter is supported in microversion 2.13 and later. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/os-server-groups - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/os-server-groups - -Example Response ----------------- - -.. code-block:: - - { - "server_groups": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", - "name": "test", - "policies": ["anti-affinity"], - "members": [], - "metadata": {}, - "project_id": "9c53a566cb3443ab910cf0daebca90c4" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/index.rst deleted file mode 100644 index ec5c0f43..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0167809633: - -======================== -ECS Operation Management -======================== - -.. toctree:: - :maxdepth: 1 - - querying_operations_on_an_ecs - querying_ecs_operations_by_request_id diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_ecs_operations_by_request_id.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_ecs_operations_by_request_id.rst deleted file mode 100644 index 59f2340a..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_ecs_operations_by_request_id.rst +++ /dev/null @@ -1,133 +0,0 @@ -:original_name: en-us_topic_0065817693.html - -.. _en-us_topic_0065817693: - -Querying ECS Operations by Request ID -===================================== - -Function --------- - -This API is used to query a request of an ECS. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-instance-actions/{request_id} - -GET /v2/{project_id}/servers/{server_id}/os-instance-actions/{request_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817693__en-us_topic_0057973179_table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - request_id Yes Specifies the request ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817693__en-us_topic_0057973153_table55529076: - -.. table:: **Table 2** Response parameters - - +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+========+==============================================================================================================================================+ - | instanceAction | Object | Specifies an operation performed on the ECS. For details, see :ref:`Table 3 `. | - +----------------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817693__en-us_topic_0057973179_table42003011: - -.. table:: **Table 3** **instanceAction** field description - - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+==================+===================================================================================================================+ - | action | Yes | String | Specifies the action name. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | instance_uuid | Yes | String | Specifies the ECS ID in UUID format. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | message | Yes | String | Specifies the result status of the action. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Specifies the project ID. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | request_id | Yes | String | Specifies the request ID. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | String | Specifies the time when the action was started. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | user_id | Yes | String | Specifies the user ID. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | events | Yes | Array of objects | Describes events. For details, see :ref:`Table 4 `. | - +---------------+-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817693__en-us_topic_0057973179_table12745176: - -.. table:: **Table 4** **events** field description - - +-------------+-----------+--------+--------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+==================================================+ - | event | Yes | String | Specifies the action name. | - +-------------+-----------+--------+--------------------------------------------------+ - | result | Yes | String | Specifies the execution result. | - +-------------+-----------+--------+--------------------------------------------------+ - | traceback | Yes | String | Specifies the error message. | - +-------------+-----------+--------+--------------------------------------------------+ - | start_time | Yes | String | Specifies the time when the event was started. | - +-------------+-----------+--------+--------------------------------------------------+ - | finish_time | Yes | String | Specifies the time when the event was completed. | - +-------------+-----------+--------+--------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c - GET https://{endpoint}/v2.1/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions/req-5a429946-c9cc-45cc-b5bd-68864209e5c - -Example Response ----------------- - -.. code-block:: - - { - "instanceAction": { - "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba", - "user_id": "752be40780484291a9cc7ae50fff3e6d", - "start_time": "2014-12-11T02:17:49.000000", - "request_id": "req-5a429946-c9cc-45cc-b5bd-68864209e5cc", - "action": "create", - "message": null, - "project_id": "89655fe61c4c4a08b9f3e7f9095441b8", - "events": [ - { - "finish_time": "2014-12-11T02:17:58.000000", - "start_time": "2014-12-11T02:17:50.000000", - "traceback": null, - "event": "compute_build_and_run_instance", - "result": "Success" - } - ] - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_operations_on_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_operations_on_an_ecs.rst deleted file mode 100644 index 67ff50d9..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/ecs_operation_management/querying_operations_on_an_ecs.rst +++ /dev/null @@ -1,136 +0,0 @@ -:original_name: en-us_topic_0065817692.html - -.. _en-us_topic_0065817692: - -Querying Operations on an ECS -============================= - -Function --------- - -This API is used to query all historical operations on an ECS. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-instance-actions?limit={limit}&marker={marker} - -GET /v2/{project_id}/servers/{server_id}/os-instance-actions?limit={limit}&marker={marker} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817692__en-us_topic_0057973177_table32475667: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -.. note:: - - Pagination query is supported in microversion 2.58 and later. The query results are displayed by the creation time (**created_at**) of the records in descending order. If the creation time is not provided, the results are displayed by object ID in descending order. The number of records displayed on each page is **limit**. If the value of **limit** exceeds the maximum number configured in Nova, the maximum number configured in Nova is returned. - -.. table:: **Table 2** Query parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+=========================================================================================================================================================+ - | limit | No | Specifies the upper limit on the number of returned results. | - | | | | - | | | This parameter is supported in microversion 2.58 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | Specifies the marker that points to the operation. The query starts from the next piece of data indexed by this parameter. The value is **request_id**. | - | | | | - | | | This parameter is supported in microversion 2.58 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0065817692__en-us_topic_0057973153_table55529076: - -.. table:: **Table 3** Response parameters - - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+=================+===========================================================================================================================================+ - | instanceActions | Array of Object | Specifies operations performed on the ECS. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817692__en-us_topic_0057973177_table2407422: - -.. table:: **Table 4** **instanceActions** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | action | Yes | String | Specifies the action. | - | | | | | - | | | | Options: | - | | | | | - | | | | **create**, **delete**, **evacuate**, **restore**, **stop**, **start**, **reboot**, **rebuild**, **revertResize**, **confirmResize**, **detach_volume**, **attach_volume**, **attach_interface**, **detach_interface**, **lock**, **unlock**, **resize**, **migrate**, **pause**, **unpause**, **suspend**, **resume**, **rescue**, **unrescue**, **changePassword**, **shelve**, **unshelve**, **live-migration**, **live_migration_cancel**, **live_migration_force_complete**, **trigger_crash_dump**, and **extend_volume** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_uuid | Yes | String | Specifies the ECS ID in UUID format. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | Yes | String | Specifies the result status of the operation. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Specifies the project ID. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | request_id | Yes | String | Specifies the request ID. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Yes | String | Specifies the time when the action was started. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | Yes | String | Specifies the user ID. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions - GET https://{endpoint}/v2.1/89655fe61c4c4a08b9f3e7f9095441b8/servers/e723eb40-f56e-40f9-8c8c-caa517fe06ba/os-instance-actions - -Example Response ----------------- - -.. code-block:: - - { - "instanceActions": [ - { - "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba", - "user_id": "752be40780484291a9cc7ae50fff3e6d", - "start_time": "2014-12-16T10:58:14.000000", - "request_id": "req-ee56c2b5-d33b-4749-ae83-09281dbbb716", - "action": "resize", - "message": "Error", - "project_id": "89655fe61c4c4a08b9f3e7f9095441b8" - }, - { - "instance_uuid": "e723eb40-f56e-40f9-8c8c-caa517fe06ba", - "user_id": "752be40780484291a9cc7ae50fff3e6d", - "start_time": "2014-12-16T10:57:56.000000", - "request_id": "req-23cfd57f-c58a-45cd-86a6-eab3e38f3753", - "action": "resize", - "message": "Error", - "project_id": "89655fe61c4c4a08b9f3e7f9095441b8" - }, - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/flavor_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/flavor_management/index.rst deleted file mode 100644 index 448db2b2..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/flavor_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0020212655: - -================= -Flavor Management -================= - -.. toctree:: - :maxdepth: 1 - - querying_ecs_flavors - querying_details_about_ecs_flavors - querying_details_about_an_ecs_flavor - querying_the_extra_specs_value_for_an_ecs_flavor diff --git a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_an_ecs_flavor.rst b/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_an_ecs_flavor.rst deleted file mode 100644 index a6529d6b..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_an_ecs_flavor.rst +++ /dev/null @@ -1,154 +0,0 @@ -:original_name: en-us_topic_0020212659.html - -.. _en-us_topic_0020212659: - -Querying Details About an ECS Flavor -==================================== - -Function --------- - -This API is used to query the details about an ECS flavor based on the flavor ID. - -URI ---- - -GET /v2.1/{project_id}/flavors/{flavor_id} - -GET /v2/{project_id}/flavors/{flavor_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212659__table47154420: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - flavors_id Yes Specifies the flavor ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212659__table61695723: - -.. table:: **Table 2** Response parameters - - +-----------+--------+----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================+ - | flavor | Object | Specifies the ECS flavor. For details, see :ref:`Table 3 `. | - +-----------+--------+----------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212659__table20109663: - -.. table:: **Table 3** **flavor** field description - - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+=======================+==========================================================================================================================+ - | id | String | Specifies the ID of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the name of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.55 and later. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | vcpus | Integer | Specifies the number of vCPUs in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | disk | Integer | Specifies the system disk size in the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | swap | String | Specifies the swap partition size required by the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **""**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-EXT-DATA:ephemeral | Integer | Specifies the temporary disk size. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-DISABLED:disabled | Boolean | Specifies whether the ECS flavor has been disabled. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **false**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | rxtx_factor | Float | Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS. | - | | | | - | | | This parameter has not been used. Its default value is **1.0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | os-flavor-access:is_public | Boolean | Specifies whether a flavor is available to all tenants. This is an extended attribute. | - | | | | - | | | - **true**: indicates that a flavor is available to all tenants. | - | | | - **false**: indicates that a flavor is available only to certain tenants. | - | | | | - | | | Default value: **true** | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS flavors. For details, see :ref:`Table 4 `. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212659__table35514108193545: - -.. table:: **Table 4** **links** field description - - ========= ====== ========================================= - Parameter Type Description - ========= ====== ========================================= - rel String Specifies the shortcut link marker name. - href String Provides the corresponding shortcut link. - ========= ====== ========================================= - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2 - GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2 - -Example Response ----------------- - -.. code-block:: - - { - "flavor": { - "name": "c3.2xlarge.2", - "links": [ - { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "rel": "self" - }, - { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "rel": "bookmark" - } - ], - "ram": 16384, - "OS-FLV-DISABLED:disabled": false, - "vcpus": 8, - "swap": "", - "os-flavor-access:is_public": true, - "rxtx_factor": 1, - "OS-FLV-EXT-DATA:ephemeral": 0, - "disk": 0, - "id": "c3.2xlarge.2" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_ecs_flavors.rst b/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_ecs_flavors.rst deleted file mode 100644 index 91a8c671..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_details_about_ecs_flavors.rst +++ /dev/null @@ -1,193 +0,0 @@ -:original_name: en-us_topic_0020212658.html - -.. _en-us_topic_0020212658: - -Querying Details About ECS Flavors -================================== - -Function --------- - -This API is used to query details about ECS flavors. - -URI ---- - -GET /v2.1/{project_id}/flavors/detail?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir} - -GET /v2/{project_id}/flavors/detail?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212658__table46110007: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Query parameters - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==================================================================================================================================================================================+ - | minDisk | No | String | Specifies the minimum disk specification in the unit of GB. Only the ECSs with the disk specification greater than or equal to the minimum specification can be queried. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minRam | No | String | Specifies the minimum RAM in the unit of MB. Only the ECSs with the RAM specification greater than or equal to the minimum specification can be queried. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | String | Indicates a sorting field, the default value of which is **flavorid**. The value of this parameter can also be **name**, **memory_mb**, **vcpus**, **root_gb**, or **flavorid**. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | String | Specifies the ascending (**asc**) or descending (**desc**) sorting. Options: **asc** and **desc** | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0020212658__table23477058: - -.. table:: **Table 3** Response parameters - - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+======================================================================================================================================================+ - | flavors | Array of objects | Specifies ECS flavors. For details, see :ref:`Table 4 `. | - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavors_links | Array of objects | Specifies data links for querying the next pages in pagination query. For details, see :ref:`Table 5 `. | - +---------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212658__table13194498: - -.. table:: **Table 4** **flavors** field description - - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+=======================+==========================================================================================================================+ - | id | String | Specifies the ID of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the name of the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.55 and later. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | vcpus | Integer | Specifies the number of vCPUs in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | disk | Integer | Specifies the system disk size in the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | swap | String | Specifies the swap partition size required by the ECS flavor. | - | | | | - | | | This parameter has not been used. Its default value is **""**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-EXT-DATA:ephemeral | Integer | Specifies the temporary disk size. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | OS-FLV-DISABLED:disabled | Boolean | Specifies whether the ECS flavor has been disabled. This is an extended attribute. | - | | | | - | | | This parameter has not been used. Its default value is **false**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | rxtx_factor | Float | Specifies the ratio of the available network bandwidth to the network hardware bandwidth of the ECS. | - | | | | - | | | This parameter has not been used. Its default value is **1.0**. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | os-flavor-access:is_public | Boolean | Specifies whether a flavor is available to all tenants. This is an extended attribute. | - | | | | - | | | - **true**: indicates that a flavor is available to all tenants. | - | | | - **false**: indicates that a flavor is available only to certain tenants. | - | | | | - | | | Default value: **true** | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS flavors. For details, see :ref:`Table 5 `. | - +----------------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212658__table15913898194628: - -.. table:: **Table 5** **links** field description - - ========= ====== ========================================= - Parameter Type Description - ========= ====== ========================================= - rel String Specifies the shortcut link marker name. - href String Provides the corresponding shortcut link. - ========= ====== ========================================= - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/detail - GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/detail - -Example Response ----------------- - -.. code-block:: - - { - "flavors": [ - { - "name": "c3.2xlarge.2", - "links": [ - { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "rel": "self" - }, - { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2", - "rel": "bookmark" - } - ], - "ram": 16384, - "OS-FLV-DISABLED:disabled": false, - "vcpus": 8, - "swap": "", - "os-flavor-access:is_public": true, - "rxtx_factor": 1, - "OS-FLV-EXT-DATA:ephemeral": 0, - "disk": 0, - "id": "c3.2xlarge.2" - }, - { - "name": "c3.2xlarge.4", - "links": [ - { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", - "rel": "self" - }, - { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.4", - "rel": "bookmark" - } - ], - "ram": 32768, - "OS-FLV-DISABLED:disabled": false, - "vcpus": 8, - "swap": "", - "os-flavor-access:is_public": true, - "rxtx_factor": 1, - "OS-FLV-EXT-DATA:ephemeral": 0, - "disk": 0, - "id": "c3.2xlarge.4" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_ecs_flavors.rst b/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_ecs_flavors.rst deleted file mode 100644 index 84419cd6..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_ecs_flavors.rst +++ /dev/null @@ -1,150 +0,0 @@ -:original_name: en-us_topic_0065817705.html - -.. _en-us_topic_0065817705: - -Querying ECS Flavors -==================== - -Function --------- - -This API is used to query available ECS flavors. After receiving the request, Nova uses nova-api to view the flavors from the database. - -URI ---- - -GET /v2.1/{project_id}/flavors?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir} - -GET /v2/{project_id}/flavors?minDisk={minDisk}&minRam={minRam}&sort_key={sort_key}&sort_dir={sort_dir} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817705__en-us_topic_0057973030_table32475667: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Parameters in the following table can be used as URI parameters to filter query results. Usage: /v2/{project_id}/flavors?minDisk={minDisk}&minRam={minRam} - -:ref:`Table 2 ` describes the query parameters. - -.. _en-us_topic_0065817705__en-us_topic_0057973030_table714692: - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================================================+ - | minDisk | No | Integer | Specifies the minimum disk specification in the unit of GB. Only the ECSs with the disk specification greater than or equal to the minimum specification can be queried. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minRam | No | Integer | Specifies the minimum RAM in the unit of MB. Only the ECSs with the RAM specification greater than or equal to the minimum specification can be queried. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | String | Indicates a sorting field, the default value of which is **flavorid**. | - | | | | | - | | | | The value of this parameter can also be **name**, **memory_mb**, **vcpus**, **root_gb**, or **flavorid**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_dir | No | String | Specifies the ascending (**asc**) or descending (**desc**) sorting. The default value is **asc**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. table:: **Table 3** Response parameters - - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+=============================================================================================================================================================================+ - | flavors | Array of objects | Specifies ECS flavors. For details, see :ref:`Table 4 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavors_links | Array of objects | Specifies data links for querying the next pages in pagination query. For details, see :ref:`Table 5 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817705__en-us_topic_0057973030_table56222540: - -.. table:: **Table 4** **flavors** field description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=======================================================================================================+ - | id | String | Specifies the flavor ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies the shortcut link of the ECS flavor. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the flavor name. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817705__en-us_topic_0057973030_table15913898194628: - -.. table:: **Table 5** **links** field description - - ========= ====== ======================================== - Parameter Type Description - ========= ====== ======================================== - rel String Specifies the shortcut link marker name. - href String Specifies the shortcut link. - ========= ====== ======================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors - GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors - -Example Response ----------------- - -.. code-block:: - - { - "flavors": [ - { - "id": "c3.medium", - "links": [ - { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.medium", - "rel": "self" - }, - { - "href": "https://compute.region.xxx.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.medium", - "rel": "bookmark" - } - ], - "name": "c3.medium" - }, - { - "id": "c3.xlarge", - "links": [ - { - "href": "https://compute.region.xxx.com/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.xlarge", - "rel": "self" - }, - { - "href": "https://compute.region.x.com/743b4c0428d94531b9f2add666642e6b/flavors/c3.xlarge", - "rel": "bookmark" - } - ], - "name": "c3.xlarge" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_the_extra_specs_value_for_an_ecs_flavor.rst b/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_the_extra_specs_value_for_an_ecs_flavor.rst deleted file mode 100644 index 934cc619..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/flavor_management/querying_the_extra_specs_value_for_an_ecs_flavor.rst +++ /dev/null @@ -1,78 +0,0 @@ -:original_name: en-us_topic_0065817706.html - -.. _en-us_topic_0065817706: - -Querying the extra_specs Value for an ECS Flavor -================================================ - -Function --------- - -This API is used to query the **extra_specs** value for a specified ECS flavor. - -URI ---- - -GET /v2.1/{project_id}/flavors/{flavor_id}/os-extra_specs - -GET /v2/{project_id}/flavors/{flavor_id}/os-extra_specs - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817706__en-us_topic_0057973064_table47154420: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - flavors_id Yes Specifies the flavor ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817706__en-us_topic_0057973064_table28168569: - -.. table:: **Table 2** Response parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================================+ - | extra_specs | Map | Specifies the key-value pair of an ECS flavor. | - | | | | - | | | For details about the returned fields, see the **os_extra_specs** field description in "Querying Details About Flavors and Extended Flavor Information". | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2/os-extra_specs - GET https://{endpoint}/v2.1/743b4c0428d94531b9f2add666642e6b/flavors/c3.2xlarge.2/os-extra_specs - -Example Response ----------------- - -.. code-block:: - - { - "extra_specs": { - "ecs:performancetype": "computingv3", - "resource_type": "IOoptimizedC3_2" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/index.rst b/ecs/api-ref/result/openstack_nova_apis/index.rst deleted file mode 100644 index e04ee474..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/index.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _en-us_topic_0124385014: - -=================== -OpenStack Nova APIs -=================== - -.. toctree:: - :maxdepth: 1 - - api_version_query/index - lifecycle_management/index - status_management/index - network_management/index - security_group_management/index - flavor_management/index - nic_management/index - disk_management/index - metadata_management/index - tenant_quota_management/index - key_and_password_management/index - ecs_group_management/index - ecs_operation_management/index - ecs_console_management/index - az/index - tag_management/index diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/creating_and_importing_an_ssh_key_pair.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/creating_and_importing_an_ssh_key_pair.rst deleted file mode 100644 index 1b6de0a8..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/creating_and_importing_an_ssh_key_pair.rst +++ /dev/null @@ -1,191 +0,0 @@ -:original_name: en-us_topic_0020212678.html - -.. _en-us_topic_0020212678: - -Creating and Importing an SSH Key Pair -====================================== - -Function --------- - -This API is used to create an SSH key pair or import a public key to generate a key pair. - -After a private SSH key is created, download the private key to a local directory. Then, you can use this private key to log in to the ECS. To ensure ECS security, the private key can be downloaded only once. Keep it secure. - -Only the user that created the key pair can view it. If the key pair is created by an IAM user, the IAM account of the user and the other users of the same account cannot view the key pair. - -URI ---- - -POST /v2.1/{project_id}/os-keypairs - -POST /v2/{project_id}/os-keypairs - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212678__table909717: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. note:: - - When creating an SSH key, you only need to configure **name**. When importing an SSH key, you must configure **public_key**. - -.. _en-us_topic_0020212678__table8287277: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==========================================================================================================================+ - | keypair | Yes | Object | Specifies the created or imported SSH key pair. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212678__table54046809: - -.. table:: **Table 3** **keypair** field description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================+ - | public_key | No | String | Specifies the imported public key. | - | | | | | - | | | | It is recommended that the length of the imported public key be less than or equal to 1024 bytes. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If the length of the public key to be imported exceeds 1024 bytes, importing the public key will fail. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | type | No | String | Specifies the key type. The value is **ssh** or **x509**. | - | | | | | - | | | | This parameter is supported in microversion 2.2 and later. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the key pair name. | - | | | | | - | | | | The new key pair name cannot be the same as an existing one. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - | user_id | No | String | Specifies the user ID of the key. | - | | | | | - | | | | This parameter is supported in microversion 2.10 and later. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0020212678__table51598880: - -.. table:: **Table 4** Response parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+======================================================================================================+ - | keypair | Object | Specifies the SSH key pair. For details, see :ref:`Table 5 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212678__table51079899: - -.. table:: **Table 5** **keypair** field description - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================+ - | fingerprint | String | Specifies fingerprint information about the key pair. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | name | String | Specifies the key pair name. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | public_key | String | Specifies information about the public key. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | private_key | String | Specifies information about the private key. | - | | | | - | | | - The information about the private key is contained in the response for creating an SSH key. | - | | | - The information about the private key is not contained in the response for importing an SSH key. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the ID of the user to which the key pair belongs. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - | type | String | Specifies the key type. The value is **ssh** or **x509**. | - | | | | - | | | This parameter is supported in microversion 2.2 and later. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------+ - -Example Request (Importing an SSH Key) --------------------------------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/os-keypairs - POST https://{endpoint}/v2.1/{project_id}/os-keypairs - -.. code-block:: - - { - "keypair": { - "public_key": "ssh-rsaAAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRibGenerated-by-Nova\\n\n", - "type": "ssh", - "name": "demo1", - "user_id": "fake" - } - } - -Example Request (Creating an SSH Key) -------------------------------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/os-keypairs - POST https://{endpoint}/v2.1/{project_id}/os-keypairs - -.. code-block:: - - { - "keypair": { - "name": "demo" - } - } - -Example Response (Importing an SSH Key) ---------------------------------------- - -.. code-block:: - - { - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRib Generated-by-Nova\\n\n", - "user_id": "6fc0d2cbbfab40b199874b97097e913d", - "name": "demo1", - "fingerprint": "fc:47:b5:c3:7d:25:32:d5:d2:0c:19:f9:62:ac:8c:5a" - } - } - -Example Response (Creating an SSH Key) --------------------------------------- - -.. code-block:: - - { - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDWNgTxQYeBzK9LYy4IakX7IsIl5j5zqR6BU2GJaEg3RK6dlS7rKFQhvy/V/1emK+GT/7P8up9VsMZ9Dx6PBOLow5p+2/wGsMlwDJpWiQ8zNnEMg+u/Ar/ZhYHAMyKEAOOJxIcnPoUgxfNdj/eiXV98AabsBdUA7QD30Og8F4Bmn2lii/WD9KbQQVjb7kbB3gNIJpGTUcoX73arorqkq/ppaLRmmwMJ7bTIGl8/0MWU2Dy+eTByOaDMb2htbB+j8ZXyEu7Oooy0NaSd+PNHv3PZ9OIVO7gd1lyoTRvCMK/F346+zmZtk5EASSOx5RifnSwk3NtugVjXs9GMJfFLBRib Generated-by-Nova\n", - "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpQIBAAKCAQEA1jYE8UGHgcyvS2MuCGpF+yLCJeY+c6kegVNhiWhIN0SunZUu\n6yhUIb8v1f9Xpivhk/+z/LqfVbDGfQ8ejwTi6MOaftv8BrDJcAyaVokPMzZxDIPr\nvwK/2YWBwDMihADjicSHJz6FIMXzXY/3ol1ffAGm7AXVAO0A99DoPBeAZp9pYov1\ng/Sm0EFY2+5Gwd4DSCaRk1HKF+92q6K6pKv6aWi0ZpsDCe20yBpfP9DFlNg8vnkw\ncjmgzG9obWwfo/GV8hLuzqKMtDWknfjzR79z2fTiFTu4HdZcqE0bwjCvxd+Ovs5m\nbZORAEkjseUYn50sJNzbboFY17PRjCXxSwUYmwIDAQABAoIBADNKQ+ywUA3YQLDA\nUqlZKOB09h+0/YccG13D5TrNaV0yaMz6h31u7pYV/RI0TXxQTXbuZt5AoR4Xca9I\nC30bImmxTDDL45CGi/T0T5AgyS7t/iuM+smFkwI2YVbv53fL7q9yCxpucdnjC95/\nNj/+M3qxupIQ42uRVAYCU1jwF6J6YLy/9UamrmVd4bWFRtT19O7uszUhHLqJOZXq\n3ItqnMyD5bSMkzMN+RxmZVXAPkBOonGVeBBInCjvHv23REkngX38zcUSc543H3Di\n4673helqSdMnI0/TgyfLQcNuOsfQcD02ABWlGBe0nCTqP8pTRo86nzK1+AoCUp72\nIsTeviECgYEA8yHKeo/eZw25eDb3YTJovbgzA61n6AYQlDQv7rBGQDwKKQHdEqhR\nP0PbScaoT7wSeLtYV0vxxA6qjEEuHhZIk/t2wEILu+AH4AK88SUbUn6ZoYu+XmTA\nx26e2QRo8Ngi/KtIfeOGXx1PM/H2/OjEN3XjkfwJsj5bB+HjpF/wsnUCgYEA4Yxg\nWJYNrvSkmvXmDgxHwdxfUpVAcp40bvomNgYpKn9R2TyjMCSDIw8vVC6cGCFB9/Pc\nG0pr8RN2SvbTaPo/96DkKdHz7NAWkzUSChD4Oy7ZNXw6GK3x1tGwMWeTs1hQDHhO\nrjS+E3bV2jC4EIvLLBxCNCbhtmQwlGUj7ZhgHM8CgYEA14UGpWpOrW8/D086LpCu\nxC46GnJmfwiRPa6dJqpfO6V9JCigvV8y1i/ifR16KWP/w8HeZ1PMtgyCJd3JcaYz\nI+pus7JYEGxgzrPepKxN8eyDZu4nDCmnsaFfceQ02fnd2bhDhERh4oJqqRM966ax\n+K+p0MhoF/aqXuxgDF93T9kCgYEAw7TsfLFnGiJJGfS4NARP11UCmUPMcif4UztX\nIJVj7u4e9SJ6bvGfoDIy3Ra8duuUtDOzDzMaSkqa4B0f//z0uEew8uCsiRVeIUlx\nZ66l1aSm8JPkTTnRmJbGDXhUXtAIVWmmy94T+AurL/IKJMFH//RdNadvPrXcuUax\nUB5hd10CgYEA3JBuX4BriSk6Bii0kYniqFM/1tEgVelAP6DT6uePvzTFdSJ0dMQo\nzwgWNmm43CyoKW/rw8yIbtIQZKBfHudSNx72nSmnBKaf3QPB40xsCip90ZUTfZdn\nLJzX1t4clg1wNsN4mJDwiYM9k3rB/8EY1fh9gUYI84X6xFAHllkv0To=\n-----END RSA PRIVATE KEY-----\n", - "user_id": "6fc0d2cbbfab40b199874b97097e913d", - "type": "ssh", - "name": "demo", - "fingerprint": "fc:47:b5:c3:7d:25:32:d5:d2:0c:19:f9:62:ac:8c:5a" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_an_ssh_key_pair.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_an_ssh_key_pair.rst deleted file mode 100644 index b4b0e717..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_an_ssh_key_pair.rst +++ /dev/null @@ -1,59 +0,0 @@ -:original_name: en-us_topic_0020212680.html - -.. _en-us_topic_0020212680: - -Deleting an SSH Key Pair -======================== - -Function --------- - -This API is used to delete a specified SSH key pair based on the SSH key pair name. - -URI ---- - -DELETE /v2.1/{project_id}/os-keypairs/{keypair_name} - -DELETE /v2/{project_id}/os-keypairs/{keypair_name} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212680__table48776445: - -.. table:: **Table 1** Parameter description - - ============ ========= ============================ - Parameter Mandatory Description - ============ ========= ============================ - project_id Yes Specifies the project ID. - keypair_name Yes Specifies the key pair name. - ============ ========= ============================ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/os-keypairs/{keypair_name} - DELETE https://{endpoint}/v2.1/{project_id}/os-keypairs/{keypair_name} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_the_password_for_logging_in_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_the_password_for_logging_in_to_an_ecs.rst deleted file mode 100644 index 8b316ccc..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/deleting_the_password_for_logging_in_to_an_ecs.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0031176554.html - -.. _en-us_topic_0031176554: - -Deleting the Password for Logging In to an ECS -============================================== - -Function --------- - -This API is used to delete the recorded random password generated during initial Windows ECS installation. After the password is deleted, you can still use your password to log in to your ECS. However, you cannot use the **Get Password** function to recover the ECS initial password. - -Linux ECSs do not use this API to delete a password. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/os-server-password - -DELETE /v2/{project_id}/servers/{server_id}/os-server-password - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031176554__table46110007: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-server-password - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/index.rst deleted file mode 100644 index b0f2710a..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0020212675: - -=========================== -Key and Password Management -=========================== - -.. toctree:: - :maxdepth: 1 - - querying_ssh_key_pairs - querying_a_specified_ssh_key_pair - creating_and_importing_an_ssh_key_pair - deleting_an_ssh_key_pair - obtaining_the_password_for_logging_in_to_an_ecs - deleting_the_password_for_logging_in_to_an_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/obtaining_the_password_for_logging_in_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/obtaining_the_password_for_logging_in_to_an_ecs.rst deleted file mode 100644 index 95a1f334..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/obtaining_the_password_for_logging_in_to_an_ecs.rst +++ /dev/null @@ -1,77 +0,0 @@ -:original_name: en-us_topic_0031176553.html - -.. _en-us_topic_0031176553: - -Obtaining the Password for Logging In to an ECS -=============================================== - -Function --------- - -This API is used to obtain the random password generated during initial Windows ECS installation for user **Administrator** or the configured **Cloudbase-init** user when you use an image that supports Cloudbase-Init to create a Windows ECS. - -After starting an ECS, wait for 5 to 10 minutes and ensure that the password is injected. Then, you can use this API to query the password. - -Linux ECSs do not use this API to obtain a password. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-server-password - -GET /v2/{project_id}/servers/{server_id}/os-server-password - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031176553__table46110007: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0031176553__table23477058: - -.. table:: **Table 2** Response parameters - - ========= ====== ===================================== - Parameter Type Description - ========= ====== ===================================== - password String Specifies the password in ciphertext. - ========= ====== ===================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-server-password - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-server-password - -Example Response ----------------- - -.. code-block:: - - { - "password": "UHC9+YW1xDC1Yu8Mg9n+tnOp7euEO/cW//9KgdJKWhr5w==" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_a_specified_ssh_key_pair.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_a_specified_ssh_key_pair.rst deleted file mode 100644 index 1772e7bf..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_a_specified_ssh_key_pair.rst +++ /dev/null @@ -1,116 +0,0 @@ -:original_name: en-us_topic_0020212677.html - -.. _en-us_topic_0020212677: - -Querying a Specified SSH Key Pair -================================= - -Function --------- - -This API is used to query a specified SSH key pair based on the SSH key pair name. - -URI ---- - -GET /v2.1/{project_id}/os-keypairs/{keypair_name} - -GET /v2/{project_id}/os-keypairs/{keypair_name} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212677__table51931981: - -.. table:: **Table 1** Parameter description - - ============ ========= ============================ - Parameter Mandatory Description - ============ ========= ============================ - project_id Yes Specifies the project ID. - keypair_name Yes Specifies the key pair name. - ============ ========= ============================ - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212677__table49096623: - -.. table:: **Table 2** Response parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+======================================================================================================+ - | keypair | Object | Specifies the SSH key pair. For details, see :ref:`Table 3 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212677__table32323009: - -.. table:: **Table 3** **keypair** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | public_key | String | Specifies information about the public key. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | name | String | Specifies the key pair name. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | fingerprint | String | Specifies fingerprint information about the key pair. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | created_at | String | Specifies the time when the key pair was created. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | deleted | Boolean | Specifies whether a key pair has been deleted. | - | | | | - | | | - **true**: indicates that the key has been deleted. | - | | | - **false**: indicates that the key is not deleted. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | deleted_at | String | Specifies the time when the key pair was deleted. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | id | Integer | Specifies the key pair ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | updated_at | String | Specifies the time when the key pair was updated. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | user_id | String | Specifies information about the user to which the key pair belongs. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | type | String | Specifies the key type, which is **ssh** by default. | - | | | | - | | | This parameter is supported in microversion 2.2 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/os-keypairs/{keypair_name} - GET https://{endpoint}/v2.1/{project_id}/os-keypairs/{keypair_name} - -Example Response ----------------- - -.. code-block:: - - { - "keypair": { - "created_at": "2014-05-07T12:06:13.681238", - "deleted": false, - "deleted_at": null, - "fingerprint": "9d:00:f4:d7:26:6e:52:06:4c:c1:d3:1d:fd:06:66:01", - "id": 1, - "name": "keypair-3582d8b7-e588-4aad-b7f7-f4e76f0e4314", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDYJrTVpcMwFqQy/oMvtUSRofZdSRHEwrsX8AYkRvn2ZnCXM+b6+GZ2NQuuWj+ocznlnwiGFQDsL/yeE+/kurqcPJFKKp60mToXIMyzioFxW88fJtwEWawHKAclbHWpR1t4fQ4DS+/sIbX/Yd9btlVQ2tpQjodGDbM9Tr9/+/3i6rcR+EoLqmbgCgAiGiVV6VbM2Zx79yUwd+GnQejHX8BlYZoOjCnt3NREsITcmWE9FVFy6TnLmahs3FkEO/QGgWGkaohAJlsgaVvSWGgDn2AujKYwyDokK3dXyeX3m2Vmc3ejiqPa/C4nRrCOlko5nSgV/9IXRx1ERImsqZnE9usB Generated-by-Nova\n", - "updated_at": null, - "user_id": "fake" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_ssh_key_pairs.rst b/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_ssh_key_pairs.rst deleted file mode 100644 index 1e5522e2..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/key_and_password_management/querying_ssh_key_pairs.rst +++ /dev/null @@ -1,109 +0,0 @@ -:original_name: en-us_topic_0020212676.html - -.. _en-us_topic_0020212676: - -Querying SSH Key Pairs -====================== - -Function --------- - -This API is used to query SSH key pairs. - -URI ---- - -GET /v2.1/{project_id}/os-keypairs - -GET /v2/{project_id}/os-keypairs - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212676__table38623499: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212676__table46959463: - -.. table:: **Table 2** Response parameters - - +-----------+------------------+-----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+===============================================================================================+ - | keypairs | Array of objects | Specifies key pairs. For details, see :ref:`Table 3 `. | - +-----------+------------------+-----------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212676__table41882197: - -.. table:: **Table 3** **keypairs** field description - - +-----------+--------+--------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==============================================================================================================+ - | keypair | Object | Specifies details about a key pair. For details, see :ref:`Table 4 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212676__table48408329: - -.. table:: **Table 4** **keypair** field description - - +-----------------------+-----------------------+------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================+ - | fingerprint | String | Specifies fingerprint information about the key pair. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | name | String | Specifies the key pair name. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | type | String | Specifies the key type, which is **ssh** by default. | - | | | | - | | | This parameter is supported in microversion 2.2 and later. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | public_key | String | Specifies information about the public key. | - +-----------------------+-----------------------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/os-keypairs - GET https://{endpoint}/v2.1/{project_id}/os-keypairs - -Example Response ----------------- - -.. code-block:: - - { - "keypairs": [ - { - "keypair": { - "fingerprint": "15:b0:f8:b3:f9:48:63:71:cf:7b:5b:38:6d:44:2d:4a", - "name": "keypair-601a2305-4f25-41ed-89c6-2a966fc8027a", - "type": "ssh", - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQC+Eo/RZRngaGTkFs7I62ZjsIlO79KklKbMXi8F+KITD4bVQHHn+kV+4gRgkgCRbdoDqoGfpaDFs877DYX9n4z6FrAIZ4PES8TNKhatifpn9NdQYWA+IkU8CuvlEKGuFpKRi/k7JLos/gHi2hy7QUwgtRvcefvD/vgQZOVw/mGR9Q== Generated-by-Nova\n" - } - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/creating_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/creating_an_ecs.rst deleted file mode 100644 index 80e9dd70..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/creating_an_ecs.rst +++ /dev/null @@ -1,652 +0,0 @@ -:original_name: en-us_topic_0068473331.html - -.. _en-us_topic_0068473331: - -Creating an ECS -=============== - -Function --------- - -This API is used to create ECS. - -This API does not support automatic rollback after creating an ECS failed. If automatic rollback is required, call the API POST /v1/{project_id}/cloudservers. For details, see :ref:`Creating an ECS `. - -URI ---- - -POST /v2.1/{project_id}/servers - -POST /v2/{project_id}/servers - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table47145209: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. note:: - - Alias of the API for creating ECSs: /v2/{project_id}/os-volumes_boot - - This calling mode can only be used in OpenStack client. - -Constraints ------------ - -#. This API is native, which does not support the creation of ECSs using full-ECS images. To use full-ECS images to create ECSs, refer to :ref:`Creating an ECS `. - -#. During the creation of an ECS using this API, you cannot bind an EIP to the ECS. If you want to create an ECS and bind an EIP to it, refer to :ref:`Creating an ECS `. - -#. Parameter **port** in the three network parameters (**port**, **uuid**, and **fixed_ip**) has the highest priority. If parameter **fixed_ip** is set, you must specify the UUID. - -#. A file injection failure will result in the ECS creation failure. - -#. The following restrictions apply when you create ECSs using an image: - - a. You cannot create an ECS on a specified host. - b. If a tenant backs up a disk in an ECS, the disk can be deleted only after the tenant deletes all the snapshots of the disk. - c. The flavors with different resource types cannot be adjusted if you adjust the specifications of an ECS created using an image. - -#. Native APIs /v2/{project_id}/servers and /v2.1/{project_id}/servers provided by the public cloud platform is developed based on and compatible with the community-version native OpenStack API. - - Compared with the community-version native API, this API has the following restrictions when you create an ECS using a specified image: - - - Community-version native OpenStack API: creates an ECS using the local disk by default. - - Native API provided by the public cloud platform: creates an ECS using the shared storage as the system disk. - - Specifically, when you use the native API to create an ECS: - - a. You can query information about the disks attached to the ECS. - b. The ECS system disk uses the EVS disk quota. - c. You cannot query ECSs created based on a specified image using the image filtering function. - -#. When you create an ECS with a specified disk, ensure that the disk and the ECS are in the same AZ. - -#. The **device_name** field configured in **block_device_mapping_v2** during the ECS creation does not take effect. The system generates a device name by default. - -#. ECSs cannot be created in networks with **provider:network_type** set to **geneve**. - - .. note:: - - **provider:network_type** being set to **geneve** indicates the internal high-speed network for BMSs. - -#. If your ECS is remotely logged in using a key, use the **key_name** parameter. If your ECS is remotely logged in using a password, use the **adminPass** parameter. Linux ECSs support **user_data** for injection. Windows ECSs support **admin_pass** for injection. - -#. If the image based on which the ECS is created uses the native OpenStack API, ensure that the specified AZ and system disk capacity and type used when the ECS is created are the same as those used when the image is created. Otherwise, the ECS creation will fail. - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table40519951: - -.. table:: **Table 2** Request parameters - - +--------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+===========+========+===========================================================================================================================================================================================+ - | server | Yes | Object | Specifies the ECS information. For details, see :ref:`Table 3 `. | - +--------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os:scheduler_hints | No | Object | Specifies the ECS scheduling information. For details, see :ref:`Table 8 `. This parameter is not available for BMSs. | - +--------------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table64008488102639: - -.. table:: **Table 3** **server** parameters - - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=========================+=================+====================+=============================================================================================================================================================================================================================================================================================================================================================================+ - | imageRef | No | String | Specifies the ECS image ID or URL. | - | | | | | - | | | | - Example image ID: 3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2 | - | | | | - Example image URL: http://glance.openstack.example.com/images/3b8d6fef-af77-42ab-b8b7-5a7f0f0af8f2 | - | | | | - If you use a specified disk as the system disk to create an ECS, this parameter is not required. If you do not use a disk to create an ECS, you must set a valid UUID. Otherwise, the API will return error code **400**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - Certain ECS flavors cannot support all public images provided on the public cloud platform. To obtain the images supported by an ECS flavor, log in to the management console, view the images displayed on the **Create ECS** page, and obtain the image IDs on the **Image Management Service** page. | - | | | | - If the creation fails, modify the parameter settings. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavorRef | Yes | String | Specifies the flavor ID or URL. | - | | | | | - | | | | For example: c3.2xlarge | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the ECS name. The value contains 1 to 255 characters. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | ECS hostnames comply with `RFC952 `__ and `RFC1123 `__ naming rules. It is recommended that you configure hostnames using digits, letters (case sensitive), and hyphens (-). Underscores (_) are converted into hyphens (-) by default. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Map | Specifies the ECS metadata. For details, see :ref:`Table 4 `. | - | | | | | - | | | | - The key contains 1 to 255 characters. | - | | | | - The value contains 0 to 255 characters. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | adminPass | No | String | Specifies the initial login password of the administrator account for logging in to an ECS using password authentication. The Linux administrator is **root**, and the Windows administrator is **Administrator**. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | block_device_mapping_v2 | No | Array of objects | Indicates the V2 API for specifying the ECS storage device. This is an extended attribute. This is the storage resource API of the new version. You are not allowed to create ECSs in batches when the volume is specified. For details, see :ref:`Table 5 `. This parameter is not available for BMSs. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_drive | No | String | Specifies the config_drive disk to be attached to the ECS during the ECS creation for transferring information to the ECS. This is an extended attribute. | - | | | | | - | | | | This function is not supported. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | No | Array of objects | Specifies the security group that the ECS belongs to. This parameter is an extended attribute. The default parameter value is **default**. | - | | | | | - | | | | This parameter is valid when you create an ECS on a specified network. For an existing port, the requested security groups are invalid. For details, see :ref:`Table 6 `. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | networks | Yes | Array of objects | Specifies information about the ECS NIC. This parameter is an extended attribute. This parameter must be specified if multiple tenant networks are used. For details, see :ref:`Table 7 `. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_name | No | String | Specifies the name of a key pair. This parameter is an extended attribute. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_data | No | String | Specifies the user data to be injected to the ECS during the creation. Text and text files can be injected. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The content of **user_data** must be encoded with base64. | - | | | | - The maximum size of the content to be injected (before encoding) is 32 KB. | - | | | | | - | | | | For more information about the user data to be injected, see "Injecting User Data into ECSs" in *Elastic Cloud Server User Guide*. | - | | | | | - | | | | Examples | - | | | | | - | | | | Before base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | #! /bin/bash | - | | | | echo user_test >> /home/user.txt | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | rem cmd | - | | | | echo 111 > c:\aaa.txt | - | | | | | - | | | | After base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA== | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0 | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | availability_zone | No | String | Specifies the AZ of a specified ECS. This is an extended attribute. | - | | | | | - | | | | This parameter is mandatory when you create an ECS. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | return_reservation_id | No | Boolean | Specifies whether the reservation IDs of the ECSs created in a batch are returned. This is an extended attribute. You can query the ECSs created this time based on the returned reservation IDs. | - | | | | | - | | | | - **true**: The reservation IDs are returned. | - | | | | - **false**: The ECS information is returned. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | When you create ECSs in a batch, this parameter is available. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | min_count | No | Integer | Specifies the minimum number of ECSs that can be created. This is an extended attribute. | - | | | | | - | | | | The default value is **1**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | When you use a specified image to create ECSs, this parameter is available. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | max_count | No | Integer | Specifies the maximum number of ECSs that can be created. | - | | | | | - | | | | The default value of **max_count** is the same as that of **min_count**. | - | | | | | - | | | | Note: | - | | | | | - | | | | - The **max_count** value must be greater than or equal to the **min_count** value. | - | | | | - If both **min_count** and **max_count** are specified, the number of ECSs that can be created depends on host resources. If host resources permit, you can create a maximum number of ECSs ranging from **min_count** to **max_count** values. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | When you use a specified image to create ECSs, this parameter is available. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | No | String | Specifies the disk configuration mode. The value can be **AUTO** or **MANUAL**. | - | | | | | - | | | | - **MANUAL**: indicates that the image space of the system disk cannot be expanded. | - | | | | - **AUTO**: indicates that the image space of the system disk can be automatically expanded to a value same as that specified in flavor. | - | | | | | - | | | | This function is not supported. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Specifies the description of an ECS, which is a null string by default. This is an extended attribute. | - | | | | | - | | | | This parameter is supported in microversion 2.19 and later. | - | | | | | - | | | | - Can contain a maximum of 85 characters. | - | | | | - Cannot contain special characters, such as < and >. | - +-------------------------+-----------------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table2373623012315: - -.. table:: **Table 4** **metadata** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================+ - | admin_pass | No | String | Specifies the password of user **Administrator** for logging in to a Windows ECS. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is mandatory when a Windows ECS using password authentication is created. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table15044407105358: - -.. table:: **Table 5** **block_device_mapping_v2** parameters - - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +=======================+=================+=================+=====================================================================================================================================================================================================================================================================================================+ - | source_type | String | Yes | Specifies the source type of the volume device. Its value can be **volume**, **image**, **snapshot**, or **blank**. | - | | | | | - | | | | If you use a volume to create an ECS, set **source_type** to **volume**. If you use an image to create an ECS, set **source_type** to **image**. If you use a snapshot to create an ECS, set **source_type** to **snapshot**. If you create an empty data volume, set **source_type** to **blank**. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If **source_type** is **snapshot** and **boot_index** is 0, the EVS disk of this snapshot must be the system disk. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | destination_type | String | No | Specifies the target type of the disk device. Its value can only be **volume**. | - | | | | | - | | | | - **volume**: indicates the volume type. | - | | | | - **local**: indicates the local file, which has not been supported. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | guest_format | String | No | Specifies the local file system format. Its value can be **swap** or **ext4**. | - | | | | | - | | | | This function is not supported. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | device_name | String | No | Specifies the disk device name. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This field has been discarded. | - | | | | | - | | | | The specified **device_name** does not take effect. The system generates a device name by default. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | delete_on_termination | Boolean | No | Specifies whether disks are deleted when an ECS is deleted. Its default value is **false**. | - | | | | | - | | | | - **true**: When an ECS is deleted, its disks are deleted. | - | | | | - **false**: When an ECS is deleted, its disks are not deleted. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_index | String | No | Specifies whether it is a boot disk. **0** specifies a boot disk, and **-1** specifies a non-boot disk. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If **source_type** of the volume device is **volume**, there must be one **boot_index** whose value is **0**. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | uuid | String | No | - If **source_type** is **volume**, the value of this parameter is the volume UUID. | - | | | | - If **source_type** is **snapshot**, the value of this parameter is the snapshot UUID. | - | | | | - If **source_type** is **image**, the value of this parameter is the image UUID. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_size | Integer | No | Specifies the volume size. The value is an integer. This parameter is mandatory when **source_type** is set to **image** or **blank**, and **destination_type** is set to **volume**. | - | | | | | - | | | | Unit: GB | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_type | String | No | Specifies the volume type. This parameter is recommended when **source_type** is set to **image** and **destination_type** is set to **volume**. | - +-----------------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table16920677105453: - -.. table:: **Table 6** **security_groups** parameters - - ========= ========= ====== ========================================== - Parameter Mandatory Type Description - ========= ========= ====== ========================================== - name No String Specifies the security group name or UUID. - ========= ========= ====== ========================================== - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table9995892105551: - -.. table:: **Table 7** **networks** parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================================================================================================================================+ - | port | No | String | Specifies the network port UUID. | - | | | | | - | | | | This parameter must be set when the network UUID is not specified. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | uuid | No | String | Specifies the network UUID. | - | | | | | - | | | | This parameter must be set when the network port is not specified. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ip | No | String | Specifies the fixed IP address. Parameter **port** in the three network parameters (**port**, **uuid**, and **fixed_ip**) has the highest priority. If parameter **fixed_ip** is set, you must specify the UUID. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table12534817105641: - -.. table:: **Table 8** **os:scheduler_hints** parameters - - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+==================+=======================================================================================================================================================================+ - | group | No | String | Specifies the anti-affinity group. | - | | | | | - | | | | The value is in UUID format. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Ensure that the ECS group uses the anti-affinity policy. You are not advised to use other policies. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | different_host | No | Array of strings | The function has not been supported, and this field is reserved. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | same_host | No | Array of strings | The function has not been supported, and this field is reserved. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | The function has not been supported, and this field is reserved. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | build_near_host_ip | No | String | The function has not been supported, and this field is reserved. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenancy | No | String | Specifies whether the ECS is created on a Dedicated Host (DeH) or in a shared pool (default). | - | | | | | - | | | | The value can be **shared** or **dedicated**. | - | | | | | - | | | | - **shared**: indicates the shared pool. | - | | | | - **dedicated**: indicates the DeH. | - | | | | | - | | | | The parameter value also takes effect for ECS query operations. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dedicated_host_id | No | String | Specifies the DeH ID. | - | | | | | - | | | | This parameter takes effect only when the value of **tenancy** is **dedicated**. | - | | | | | - | | | | If you do not specify this parameter, the system will automatically assign a DeH to you to deploy ECSs. | - | | | | | - | | | | The parameter value also takes effect for ECS query operations. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | check_resources | No | String | Specifies whether to check resource sufficiency when creating an ECS. If this parameter is not configured, the system does not check resource sufficiency by default. | - | | | | | - | | | | The value can be **true** or **false**. The default value is **false**. | - | | | | | - | | | | - **true**: indicates that the system will check resource sufficiency. If the resources are insufficient, the check result will be returned. | - | | | | - **false**: indicates that the system will not check resource sufficiency. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Since the resource usage is dynamic, the resource sufficiency check result is not accurate. | - +--------------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 9 ` describes the response parameters. - -.. _en-us_topic_0068473331__table44736746: - -.. table:: **Table 9** Response parameters - - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=============================================================================================================================+ - | server | Object | Specifies ECS information. For details, see :ref:`Table 10 `. | - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__en-us_topic_0057972661_table37882063: - -.. table:: **Table 10** **server** field description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================================================+ - | id | String | Specifies the ECS ID in UUID format. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies the URI of the ECS. For details, see :ref:`Table 11 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of objects | Specifies the security groups to which the ECS belongs. For details, see :ref:`Table 12 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | String | Specifies the disk configuration mode. | - | | | | - | | | - **MANUAL**: indicates that the image space of the system disk cannot be expanded. | - | | | - **AUTO**: indicates that the image space of the system disk can be automatically expanded to a value same as that specified in flavor. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | reservation_id | String | Specifies a filtering criteria to query the created ECSs. | - | | | | - | | | .. note:: | - | | | | - | | | When you create ECSs in a batch, this parameter is available. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | adminPass | String | Specifies the password of user **Administrator** for logging in to a Windows ECS. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0068473331__table16539321: - -.. table:: **Table 11** **links** field description - - ========= ====== ========================================= - Parameter Type Description - ========= ====== ========================================= - rel String Specifies the shortcut link marker name. - href String Provides the corresponding shortcut link. - ========= ====== ========================================= - -.. _en-us_topic_0068473331__table761507165933: - -.. table:: **Table 12** **security_groups** field description - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - name String Specifies the security group name or UUID. - ========= ====== ========================================== - -Example Request (Creating an ECS) ---------------------------------- - -Example URL request - -.. code-block:: - - POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers - POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers - -**Example 1: Use an image to create an ECS through the API block_device_mapping_v2.** - -.. code-block:: - - { - "server": { - "flavorRef": "2", - "name": "wjvm48", - "metadata": { - "name": "name_xx1", - "id": "id_xxxx1" - }, - "block_device_mapping_v2": [{ - "source_type": "image", - "destination_type": "volume", - "uuid": "b023fe17-11db-4efb-b800-78882a0e394b", - "delete_on_termination": "False", - "boot_index": "0", - "volume_type": "SAS", - "volume_size": "40" - }], - "security_groups": [{ - "name": "name_xx5_sg" - }], - "networks": [{ - "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", - "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", - "fixed_ip": "10.20.30.137" - }], - "key_name": "test", - "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", - "availability_zone":"az1-dc1" - } - } - -**Example 2: Use a snapshot to create an ECS through the API block_device_mapping_v2.** - -.. note:: - - When **source_type** is **snapshot**, **boot_index** is **0**, and the EVS disk corresponding to the snapshot must be a system disk. - -.. code-block:: - - { - "server":{ - "name":"wjvm48", - "availability_zone":"az1-dc1", - "block_device_mapping_v2": [ - { - "source_type":"snapshot", - "boot_index":"0", - "uuid":"df51997d-ee35-4fb3-a372-e2ac933a6565", //Specifies the snapshot ID, which is returned by the API for creating a snapshot. - "destination_type":"volume" - } - ], - "flavorRef":"s3.xlarge.2", - "max_count":1, - "min_count":1, - "networks": [ - { - "uuid":"79a68cef-0936-4e21-b1f4-b800ecb70246" - } - ] - } - } - -**Example 3: Use a disk to create an ECS through the API block_device_mapping_v2.** - -.. code-block:: - - { - "server": { - "flavorRef": "2", - "name": "wjvm48", - "metadata": { - "name": "name_xx1", - "id": "id_xxxx1" - }, - "block_device_mapping_v2": [{ - "source_type": "volume", - "destination_type": "volume", - "uuid": "bd7e4f86-b004-4745-bea2-a55b1085f107", - "delete_on_termination": "False", - "boot_index": "0", - "volume_type": "dsware", - "volume_size": "40" - }], - "security_groups": [{ - "name": "name_xx5_sg" - }], - "networks": [{ - "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", - "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", - "fixed_ip": "10.20.30.137" - }], - "key_name": "test", - "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", - "availability_zone":"az1-dc1" - } - } - -**Example 4: Create an ECS through the API imageRef.** - -.. code-block:: - - { - "server": { - "flavorRef": "2", - "name": "wjvm48", - "metadata": { - "name": "name_xx1", - "id": "id_xxxx1" - }, - "adminPass": "name_xx1", - "imageRef": "6b344c54-d606-4e1a-a99e-a7d0250c3d14", - "security_groups": [{ - "name": "name_xx5_sg" - }], - "networks": [{ - "uuid": "fd40e6f8-942d-4b4e-a7ae-465287b02a2c", - "port": "e730a11c-1a19-49cc-8797-cee2ad67af6f", - "fixed_ip": "10.20.30.137" - }], - "key_name": "test", - "user_data": "ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA==", - "availability_zone":"az1-dc1" - } - } - -Example Response (Creating an ECS) ----------------------------------- - -.. code-block:: - - { - "server": { - "security_groups": [ - { - "name": "name_xx5_sg" - } - ], - "OS-DCF:diskConfig": " MANUAL", - "id": "567c1557-0eca-422c-bfce-149d6b8f1bb8", - "links": [ - { - "href": "http://192.168.82.230:8774/v2/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", - "rel": "self" - }, - { - "href": "http://192.168.82.230:8774/dc4059e8e7994f2498b514ca04cdaf44/servers/567c1557-0eca-422c-bfce-149d6b8f1bb8", - "rel": "bookmark" - } - ], - "adminPass": "name_xx1" - } - } - -Example Request (Creating ECSs in a Batch) ------------------------------------------- - -.. code-block:: - - { - "server": { - "availability_zone":"az1.dc1", - "name": "test", - "imageRef": "10ff4f01-35b6-4209-8397-359cb4475fa0", - "flavorRef": "s3.medium", - "return_reservation_id": "true", - "networks": [ - { - "uuid": "51bead38-d1a3-4d08-be20-0970c24b7cab" - } - ], - "min_count": "2", - "max_count": "3" - } - } - -Example Response (Creating ECSs in a Batch) -------------------------------------------- - -.. code-block:: - - { - "reservation_id": "r-3fhpjulh" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/deleting_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/deleting_an_ecs.rst deleted file mode 100644 index 56501322..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/deleting_an_ecs.rst +++ /dev/null @@ -1,64 +0,0 @@ -:original_name: en-us_topic_0025560296.html - -.. _en-us_topic_0025560296: - -Deleting an ECS -=============== - -Function --------- - -This API is used to delete an ECS. - -Constraints ------------ - -When an ECS is deleted, all NICs attached to the ECS through the OpenStack Nova API will be deleted. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id} - -DELETE /v2/{project_id}/servers/{server_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0025560296__table2659898791032: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/servers/{server_id} - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/index.rst deleted file mode 100644 index 19afd4a4..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0124385015: - -==================== -Lifecycle Management -==================== - -.. toctree:: - :maxdepth: 1 - - creating_an_ecs - modifying_ecs_information - deleting_an_ecs - querying_ecss - querying_details_about_ecss - querying_details_about_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/modifying_ecs_information.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/modifying_ecs_information.rst deleted file mode 100644 index f83a7596..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/modifying_ecs_information.rst +++ /dev/null @@ -1,295 +0,0 @@ -:original_name: en-us_topic_0020212692.html - -.. _en-us_topic_0020212692: - -Modifying ECS Information -========================= - -Function --------- - -This API is used to modify ECS information. Only the name and description of an ECS can be modified. - -URI ---- - -PUT /v2.1/{project_id}/servers/{server_id} - -PUT /v2/{project_id}/servers/{server_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212692__table44564854: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212692__table13100926: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==================================================================================================================+ - | server | Yes | Object | Specifies the ECS data structure. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212692__table26827213163326: - -.. table:: **Table 3** **server** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================+ - | name | No | String | Specifies the name of the modified ECS. | - | | | | | - | | | | The length is greater than 0 and less than 256 | - +-----------------+-----------------+-----------------+---------------------------------------------------------------+ - | description | No | String | Describes the ECS. The value contains a maximum of 255 bytes. | - | | | | | - | | | | This parameter is supported in microversion 2.19 and later. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0020212692__table44736746: - -.. table:: **Table 4** Response parameters - - +-----------+--------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================+ - | server | Object | Specifies ECS information. For details, see :ref:`Table 5 `. | - +-----------+--------+-----------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212692__table11253402: - -.. table:: **Table 5** **server** field description - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================================================================================================================================================+ - | tenant_id | String | Specifies the tenant or project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image | String | Specifies the image ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv4 | String | Reserved | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | addresses | Object | Specifies the attributed network information of the ECS. | - | | | | - | | | The structure is Map. | - | | | | - | | | For details, see :ref:`Table 6 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS metadata. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv6 | String | Reserved | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the time when the ECS was created. The time is in the format of "2019-05-22T03:19:19Z". | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hostId | String | Specifies the host ID of the ECS. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | Object | Specifies the ECS flavor. For details, see :ref:`Table 7 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | String | Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the ID of the user to which an ECS belongs. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the modified name of the ECS. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | Integer | Reserved | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of Object | Specifies ECS shortcut links. For details, see :ref:`Table 8 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the unique ID of an ECS. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Specifies the time when the ECS was updated last time. | - | | | | - | | | The time is in the format of "2019-05-22T03:19:19Z". | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | locked | Boolean | Specifies the ECS lock status, which is **True** when the ECS is locked and **False** when the ECS is unlocked. | - | | | | - | | | This parameter is supported in microversion 2.9 and later. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the ECS. | - | | | | - | | | This parameter is supported in microversion 2.19 and later. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Specifies ECS tags. | - | | | | - | | | This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the **tags** field. | - | | | | - | | | Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules: | - | | | | - | | | - The key and value of a tag are connected using an equal sign (=), for example, key=value. | - | | | - If the value is empty, only the key is returned. | - | | | | - | | | - The key and value of a tag are connected using an equal sign (=), for example, key=value. | - | | | - If the value is empty, only the key is returned. | - | | | | - | | | For more details about upgraded tag functions, see :ref:`Tag Types `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the ECS status. | - | | | | - | | | Options: | - | | | | - | | | **ACTIVE**, **BUILD**, **ERROR**, **HARD_REBOOT**, **MIGRATING**, **REBOOT**, **RESIZE**, **REVERT_RESIZE**, **SHELVED**, **SHELVED_OFFLOADED**, **SHUTOFF**, **UNKNOWN**, and **VERIFY_RESIZE** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212692__table1656029015527: - -.. table:: **Table 6** Data structure of the network which an ECS accesses - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=========================================================================================+ - | addr | String | Specifies the IP address. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | version | Integer | Specifies the type of an IP address. The value of this parameter can be **4** or **6**. | - | | | | - | | | - **4**: The type of the IP address is IPv4. | - | | | - **6**: The type of the IP address is IPv6. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212692__table19588408: - -.. table:: **Table 7** **flavor** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================+ - | id | String | Specifies the ECS ID. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS types. For details, see :ref:`Table 8 `. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | vcpus | Integer | Specifies the number of vCPUs in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | disk | Integer | Specifies the system disk size in the ECS flavor. Value **0** indicates that the disk size is not limited. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ephemeral | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | swap | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | original_name | String | Specifies the name of the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | extra_specs | Object | Indicates an extended flavor field. For details, see :ref:`os_extra_specs (flavor) Field Description `. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212692__table64121649: - -.. table:: **Table 8** **links** field description - - ========= ====== ======================================== - Parameter Type Description - ========= ====== ======================================== - rel String Specifies the shortcut link marker name. - href String Specifies the shortcut link. - ========= ====== ======================================== - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2/{project_id}/servers/{server_id} - PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id} - -.. code-block:: - - { - "server": { - "name": "new-server-test" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "server": { - "tenant_id": "7910a6e50b80402ba028c8d96c1b31fe", - "image": "", - "accessIPv4": "", - "addresses": { - "03be5c1e-e05d-4905-a105-c3bd9b730bdc": [ - { - "addr": "192.168.0.72", - "version": 4 - } - ] - }, - "metadata": {}, - "accessIPv6": "", - "created": "2018-05-17T03:15:48Z", - "hostId": "7dc82f6b1d406200fc63e395cf4829cbffcb49de0e9c75c5773f201f", - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/flavors/c3.1U1G" - } - ], - "id": "c3.1U1G" - }, - "OS-DCF:diskConfig": "MANUAL", - "user_id": "d698a78532ca430f8daec1858f2b500e", - "name": "new-server-test", - "progress": 0, - "links": [ - { - "rel": "self", - "href": "https://None/v2/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" - }, - { - "rel": "bookmark", - "href": "https://None/7910a6e50b80402ba028c8d96c1b31fe/servers/1a19ef4f-be0a-4526-bf2f-14b4464d536a" - } - ], - "id": "1a19ef4f-be0a-4526-bf2f-14b4464d536a", - "updated": "2018-05-21T00:36:27Z", - "status": "ACTIVE" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecs.rst deleted file mode 100644 index 9c9172de..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecs.rst +++ /dev/null @@ -1,425 +0,0 @@ -:original_name: en-us_topic_0020212690.html - -.. _en-us_topic_0020212690: - -Querying Details About ECSs -=========================== - -Function --------- - -This API is used to query details about an ECS by ECS ID. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id} - -GET /v2/{project_id}/servers/{server_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212690__table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212690__table44736746: - -.. table:: **Table 2** Response parameters - - +-----------+--------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================+ - | server | Object | Specifies ECS information. For details, see :ref:`Table 3 `. | - +-----------+--------+-----------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table26210179: - -.. table:: **Table 3** **server** field description - - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================================+=======================+============================================================================================================================================================================================================================================================+ - | name | String | Specifies the ECS name. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies an ECS uniquely. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the ECS status. | - | | | | - | | | Options: | - | | | | - | | | **ACTIVE**, **BUILD**, **DELETED**, **ERROR**, **HARD_REBOOT**, **MIGRATING**, **PAUSED**, **REBOOT**, **REBUILD**, **RESIZE**, **REVERT_RESIZE**, **SHUTOFF**, **SHELVED**, **SHELVED_OFFLOADED**, **SOFT_DELETED**, **SUSPENDED**, and **VERIFY_RESIZE** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the time when the ECS was created. The time is in the format of "2019-05-22T07:48:19Z". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Specifies the time when the ECS was updated last time. The time is in the format of "2019-05-22T07:48:19Z". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | Object | Specifies the ECS flavor. For details, see :ref:`Table 4 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image | Object | Specifies the ECS image information. For an ECS created using an image, the image ID and link are returned. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the tenant to which the ECS belongs. The parameter value is the same as the project ID specified by **project_id**. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_name | String | Specifies the SSH key name. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the ID of the user to which an ECS belongs. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS metadata. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hostId | String | Specifies the host ID of the ECS. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | addresses | Object | Specifies the network addresses of an ECS. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of objects | Specifies the security groups to which the ECS belongs. For details, see :ref:`Table 9 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies ECS shortcut links. For details, see :ref:`Table 6 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Specifies ECS tags. | - | | | | - | | | This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the **tags** field. | - | | | | - | | | Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules: | - | | | | - | | | - The key and value of a tag are connected using an equal sign (=), for example, key=value. | - | | | - If the value is empty, only the key is returned. | - | | | | - | | | For more details about upgraded tag functions, see :ref:`Tag Types `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os:scheduler_hints | Object | Specifies the ECS scheduling information. For details, see :ref:`Table 11 `. This parameter is not available for BMSs. and is only available in DeH scenarios. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | String | Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image. | - | | | | - | | | Options: | - | | | | - | | | - **AUTO**: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition. | - | | | | - | | | - **MANUAL**: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-AZ:availability_zone | String | Specifies the AZ ID. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:host | String | Specifies the name of the host on which the ECS is deployed. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:hypervisor_hostname | String | Specifies the hostname of the hypervisor. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:instance_name | String | Specifies the ECS ID. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:power_state | Integer | Specifies the ECS power status. This is an extended attribute. | - | | | | - | | | Options: 0, 1, 2, 3, and 4 | - | | | | - | | | - **0**: pending | - | | | - **1**: running | - | | | - **2**: paused | - | | | - **3**: shutdown | - | | | - **4**: crashed | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:task_state | String | Specifies the ECS task status. This is an extended attribute. | - | | | | - | | | For details about options, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:vm_state | String | Specifies the ECS status. This is an extended attribute. | - | | | | - | | | Options: | - | | | | - | | | **ACTIVE**, **BUILDING**, **STOPPED**, **RESIZED**, **PAUSED**, **SUSPENDED**, **RESCUED**, **ERROR**, **DELETED**, **SOFT_DELETED**, **SHELVED**, and **SHELVED_OFFLOADED** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-SRV-USG:launched_at | String | Specifies the time when the ECS was started. This is an extended attribute. The time is in the format of "2019-05-22T07:48:19.000000". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-SRV-USG:terminated_at | String | Specifies the time when the ECS was deleted. This is an extended attribute. The time is in the format of "2019-05-22T07:48:19.000000". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os-extended-volumes:volumes_attached | Array of objects | Specifies information about the EVS disks attached to the ECS. For details, see :ref:`Table 8 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fault | Object | Describes ECS faults. | - | | | | - | | | This parameter is optional. It is returned when an error occurs on an ECS. | - | | | | - | | | For details, see :ref:`Table 10 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the ECS. | - | | | | - | | | This parameter is supported in microversion 2.19 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_status | String | Specifies the nova-compute status. | - | | | | - | | | - **UP**: The nova-compute status is normal. | - | | | - **UNKNOWN**: The nova-compute status is unknown. | - | | | - **DOWN**: the nova-compute status is abnormal. | - | | | - **MAINTENANCE**: The nova-compute is in maintenance state. | - | | | - **Null**: There is no host information on the ECS. | - | | | | - | | | This parameter is supported in microversion 2.16 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:hostname | String | Specifies the name of the host accommodating the ECS. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:reservation_id | String | Specifies the reserved ECS ID if multiple ECSs are created in a batch. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:launch_index | Integer | Specifies the sequence in which ECSs created in a batch start. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:kernel_id | String | Specifies the UUID of the kernel image if an AMI image is used. In other scenarios, leave this parameter blank. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:ramdisk_id | String | Specifies the UUID of the Ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:root_device_name | String | Specifies the device name of the ECS system disk. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:user_data | String | Specifies the user data specified during ECS creation. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | locked | Boolean | Specifies the ECS lock status, which is **True** when the ECS is locked and **False** when the ECS is unlocked. | - | | | | - | | | This parameter is supported in microversion 2.9 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv4 | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv6 | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_drive | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | Integer | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table29241163: - -.. table:: **Table 4** **flavor** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================+ - | id | String | Specifies the ECS ID. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS types. | - | | | | - | | | For details, see :ref:`Table 6 `. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | vcpus | Integer | Specifies the number of vCPUs in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | disk | Integer | Specifies the system disk size in the ECS flavor. Value **0** indicates that the disk size is not limited. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | ephemeral | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | swap | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | original_name | String | Specifies the name of the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | extra_specs | Object | Indicates an extended flavor field. For details, see :ref:`os_extra_specs (flavor) Field Description `. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table1080891111402: - -.. table:: **Table 5** **image** field description - - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+===================================================================================================================+ - | id | String | Specifies the image ID. | - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS images. For details, see :ref:`Table 6 `. | - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table35230296: - -.. table:: **Table 6** **links** field description - - ========= ====== ========================================= - Parameter Type Description - ========= ====== ========================================= - rel String Specifies the shortcut link marker name. - href String Provides the corresponding shortcut link. - ========= ====== ========================================= - -.. _en-us_topic_0020212690__table1972725101724: - -.. table:: **Table 7** Data structure of the network which an ECS accesses - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+=========================================================================================+ - | addr | String | Specifies the IP address. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | version | Integer | Specifies the type of an IP address. The value of this parameter can be **4** or **6**. | - | | | | - | | | - **4**: The type of the IP address is IPv4. | - | | | - **6**: The type of the IP address is IPv6. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | OS-EXT-IPS-MAC:mac_addr | String | Specifies the MAC address. This is an extended attribute. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | OS-EXT-IPS:type | String | Specifies the IP address assignment mode. This is an extended attribute. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table10024873122234: - -.. table:: **Table 8** **os-extended-volumes:volumes_attached** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the EVS disk ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | delete_on_termination | Boolean | Specifies whether to delete additional disks when deleting the ECS. | - | | | | - | | | By default, this parameter is set to **False**. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__table2053207517233: - -.. table:: **Table 9** **security_groups** field description - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - name String Specifies the security group name or UUID. - ========= ====== ========================================== - -.. _en-us_topic_0020212690__table1075312230549: - -.. table:: **Table 10** **fault** field description - - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+=========================================================================================================+ - | code | Integer | Specifies the error code. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the time when an error occurred. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | message | String | Describes an error. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | details | String | Specifies details about an error. This parameter is optional and is returned only when it is not empty. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212690__en-us_topic_0057972661_table12534817105641: - -.. table:: **Table 11** **os:scheduler_hints** parameters - - +-------------------+-----------------+------------------+----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+==================+==================================================================================+ - | tenancy | No | Array of strings | Creates ECSs on a dedicated or shared host. | - | | | | | - | | | | The value of this parameter can be **dedicated** or **shared**. | - +-------------------+-----------------+------------------+----------------------------------------------------------------------------------+ - | dedicated_host_id | No | Array of strings | Specifies the DeH ID. | - | | | | | - | | | | This parameter takes effect only when the value of **tenancy** is **dedicated**. | - +-------------------+-----------------+------------------+----------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id} - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id} - -Example Response ----------------- - -.. code-block:: - - { - "server": { - "addresses": { - "68269e6e-4a27-441b-8029-35373ad50bd9": [ - { - "addr": "192.168.0.3", - "version": 4, - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:1b:35:78", - "OS-EXT-IPS:type": "fixed" - } - ] - }, - "created": "2012-08-20T21:11:09Z", - "flavor": { - "id": "1", - "links": [ - { - "href": "http://openstack.example.com/openstack/flavors/1", - "rel": "bookmark" - } - ] - }, - "hostId": "65201c14a29663e06d0748e561207d998b343e1d164bfa0aafa9c45d", - "id": "893c7791-f1df-4c3d-8383-3caae9656c62", - "image": "", - "links": [ - { - "href": "http://openstack.example.com/v2/openstack/servers/893c7791-f1df-4c3d-8383-3caae9656c62", - "rel": "self" - }, - { - "href": "http://openstack.example.com/openstack/servers/893c7791-f1df-4c3d-8383-3caae9656c62", - "rel": "bookmark" - } - ], - "metadata": {}, - "name": "new-server-test", - "progress": 0, - "status": "ACTIVE", - "tenant_id": "openstack", - "updated": "2012-08-20T21:11:09Z", - "user_id": "fake" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecss.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecss.rst deleted file mode 100644 index e713d412..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_details_about_ecss.rst +++ /dev/null @@ -1,487 +0,0 @@ -:original_name: en-us_topic_0020212689.html - -.. _en-us_topic_0020212689: - -Querying Details About ECSs -=========================== - -Function --------- - -This API is used to query details about ECSs. - -URI ---- - -GET /v2.1/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip} - -GET /v2/{project_id}/servers/detail?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212689__table31251786: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | changes-since | No | String | Specifies the timestamp of the last ECS status update, which is used to filter out the ECSs with statuses updated later than the timestamp. The format must comply with ISO 8601 in the format of CCYY-MM-DDThh:mm:ss+/-hh:mm, for example, 2018-01-17T03:03:32Z. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image | No | String | Specifies the image ID. | - | | | | | - | | | | When image is used as a filter criterion, other filter criteria and paging criteria are not supported. If both the image and other filter criteria are specified, the image filter criterion is used. If the query criteria do not contain the image filter criterion, API functions are not restricted. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | No | String | Specifies the ECS flavor ID, which is fuzzy matched. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Specifies the ECS name, which is fuzzy matched. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the ECS status. | - | | | | | - | | | | Options: | - | | | | | - | | | | **ACTIVE**, **BUILD**, **ERROR**, **HARD_REBOOT**, **MIGRATING**, **REBOOT**, **REBUILD**, **RESIZE**, **REVERT_RESIZE**, **SHUTOFF**, and **VERIFY_RESIZE** | - | | | | | - | | | | In microversion 2.37, the system will return an empty list for the **status** field out of the preceding options. In microversion 2.38 and later, the system will return error 400. | - | | | | | - | | | | For details, see :ref:`ECS Statuses `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the upper limit on the number of returned results. | - | | | | | - | | | | Each page contains 25 ECSs by default, and a maximum of 1000 ECSs are returned. For large volumes of data, you are advised to set the value to **100**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies the ECS ID to which the marker points. The query will start from its next ID. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | String | Queries ECSs with tags containing the specified value. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | not-tags | No | String | Queries ECSs with tags not containing the specified value. The value is the tag key. | - | | | | | - | | | | For details about key rules, see :ref:`Tag Types `. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key". | - | | | | | - | | | | For example, an existing tag is **a.b**. After the tag function upgrade, query the tag using "not-tags=a". | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reservation_id | No | String | Specifies the ID returned when ECSs are created in a batch. This parameter is used to query ECSs created in a batch. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | String | Sorts query results by ECS attribute. The default sorting order is the reverse order of **created_at**. | - | | | | | - | | | | The value can be **created_at**, **auto_disk_config**, **availability_zone**, **display_description**, **display_name**, **host**, **host_name**, **image_ref**, **instance_type_id**, **kernel_id**, **key_name**, **launch_index**, **launched_at**, **locked_by**, **node**, **power_state**, **project_id**, **ramdisk_id**, **reservation_id**, **root_device_name**, **task_state**, **terminated_at**, **user_id**, **updated_at**, **uuid**, or **vm_state**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip | No | String | Indicates the filtering result for IPv4 addresses, which are fuzzy matched. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0020212689__table61256692: - -.. table:: **Table 3** Response parameters - - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+===================================================================================================================================+ - | servers | Array of objects | Specifies the ECSs to be queried. For details, see :ref:`Table 4 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | servers_links | Array of objects | Specifies the link of the next page in pagination query. For details, see :ref:`Table 6 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table1549812072413: - -.. table:: **Table 4** **servers** field description - - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================================+=======================+============================================================================================================================================================================================================================================================+ - | name | String | Specifies the ECS name. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies an ECS uniquely. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the ECS status. | - | | | | - | | | Options: | - | | | | - | | | **ACTIVE**, **BUILD**, **DELETED**, **ERROR**, **HARD_REBOOT**, **MIGRATING**, **PAUSED**, **REBOOT**, **REBUILD**, **RESIZE**, **REVERT_RESIZE**, **SHUTOFF**, **SHELVED**, **SHELVED_OFFLOADED**, **SOFT_DELETED**, **SUSPENDED**, and **VERIFY_RESIZE** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the time when the ECS was created. The time is in the format of "2019-05-22T07:48:53Z". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Specifies the time when the ECS was updated last time. The time is in the format of "2019-05-22T07:48:53Z". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | Object | Specifies the ECS flavor. | - | | | | - | | | For details, see :ref:`Table 5 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image | Object | Specifies the ECS image information. For an ECS created using an image, the image ID and link are returned. | - | | | | - | | | For details, see :ref:`Table 11 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the ID of the tenant to which the ECS belongs. The parameter value is the same as the project ID specified by **project_id**. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_name | String | Specifies the SSH key name. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the ID of the user to which an ECS belongs. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS metadata. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hostId | String | Specifies the host ID of the ECS. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | addresses | Object | Specifies the network addresses of an ECS. | - | | | | - | | | For details, see :ref:`Table 7 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_groups | Array of objects | Specifies the security groups to which the ECS belongs. | - | | | | - | | | For details, see :ref:`Table 9 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies ECS shortcut links. | - | | | | - | | | For details, see :ref:`Table 6 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os:scheduler_hints | Object | Specifies the ECS scheduling information. For details, see :ref:`Table 12 `. This parameter is only available for DeHs. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | String | Specifies the disk configuration mode. This is an extended attribute. This field is valid for the ECS started using an image. | - | | | | - | | | Options: | - | | | | - | | | - **AUTO**: This API uses a single partition to build an ECS with the target disk size. The API automatically adjusts the file system to adapt to the entire partition. | - | | | - **MANUAL**: This API uses the partitioning scheme in the source image and the file system to build the ECS. If the target disk size is large, the API does not partition the remaining disk space. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-AZ:availability_zone | String | Specifies the AZ ID. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:host | String | Specifies the name of the host on which the ECS is deployed. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:hypervisor_hostname | String | Specifies the hostname of the hypervisor. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:instance_name | String | Specifies the ECS ID. This is an extended attribute. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:power_state | Integer | Specifies the ECS power status. This is an extended attribute. | - | | | | - | | | Options: **0**, **1**, **2**, **3**, and **4** | - | | | | - | | | - **0**: pending | - | | | - **1**: running | - | | | - **2**: paused | - | | | - **3**: shutdown | - | | | - **4**: crashed | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:task_state | String | Specifies the ECS task status. This is an extended attribute. | - | | | | - | | | For details about options, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-STS:vm_state | String | Specifies the ECS status. This is an extended attribute. | - | | | | - | | | Options: | - | | | | - | | | **ACTIVE**, **BUILDING**, **STOPPED**, **RESIZED**, **PAUSED**, **SUSPENDED**, **RESCUED**, **ERROR**, **DELETED**, **SOFT_DELETED**, **SHELVED**, and **SHELVED_OFFLOADED** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-SRV-USG:launched_at | String | Specifies the time when the ECS was started. This is an extended attribute. The time is in the format of "2019-05-22T07:48:19.000000". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-SRV-USG:terminated_at | String | Specifies the time when the ECS was deleted. This is an extended attribute. | - | | | | - | | | The time is in the format of "2019-05-22T07:48:19.000000". | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | os-extended-volumes:volumes_attached | Array of objects | Specifies information about the EVS disks attached to the ECS. | - | | | | - | | | For details, see :ref:`Table 8 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fault | Object | Describes ECS faults. | - | | | | - | | | This parameter is optional. It is returned when an error occurs on an ECS. | - | | | | - | | | For details, see :ref:`Table 10 `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the ECS. | - | | | | - | | | This parameter is supported in microversion 2.19 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_status | String | Specifies the nova-compute status. | - | | | | - | | | - **UP**: The nova-compute status is normal. | - | | | - **UNKNOWN**: The nova-compute status is unknown. | - | | | - **DOWN**: the nova-compute status is abnormal. | - | | | - **MAINTENANCE**: The nova-compute is in maintenance state. | - | | | - Empty string: There is no host information on the ECS. | - | | | | - | | | This parameter is supported in microversion 2.16 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:hostname | String | Specifies the name of the host accommodating the ECS. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:reservation_id | String | Specifies the reserved ECS ID if multiple ECSs are created in a batch. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:launch_index | Integer | Specifies the sequence in which ECSs created in a batch start. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:kernel_id | String | Specifies the UUID of the kernel image if an AMI image is used. In other scenarios, leave this parameter blank. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:ramdisk_id | String | Specifies the UUID of the Ramdisk image if an AMI image is used. In other scenarios, leave this parameter blank. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:root_device_name | String | Specifies the device name of the ECS system disk. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OS-EXT-SRV-ATTR:user_data | String | Specifies the user data specified during ECS creation. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Specifies ECS tags. | - | | | | - | | | This parameter is supported in microversion 2.26 and later. If the microversion is not used for query, the response does not contain the **tags** field. | - | | | | - | | | Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules: | - | | | | - | | | - The key and value of a tag are connected using an equal sign (=), for example, key=value. | - | | | - If the value is empty, only the key is returned. | - | | | | - | | | For more details about upgraded tag functions, see :ref:`Tag Types `. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | locked | Boolean | Specifies the ECS lock status, which is **True** when the ECS is locked and **False** when the ECS is unlocked. | - | | | | - | | | This parameter is supported in microversion 2.9 and later. | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv4 | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | accessIPv6 | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_drive | String | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | Integer | Reserved | - +--------------------------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table19588408: - -.. table:: **Table 5** **flavor** field description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================================================================+ - | id | String | Specifies the ECS ID. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS types. For details, see :ref:`Table 6 `. | - | | | | - | | | This parameter is not supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | vcpus | Integer | Specifies the number of vCPUs in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory size (MB) in the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | disk | Integer | Specifies the system disk size in the ECS flavor. Value **0** indicates that the disk size is not limited. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | ephemeral | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | swap | Integer | Reserved | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | original_name | String | Specifies the name of the ECS flavor. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - | extra_specs | Object | Extended flavor field | - | | | | - | | | For details, see :ref:`Data Structure for Query Details About Specifications `. | - | | | | - | | | This parameter is supported in microversion 2.47 and later. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table16539321: - -.. table:: **Table 6** **servers_links** and **links** field description - - ========= ====== ======================================== - Parameter Type Description - ========= ====== ======================================== - rel String Specifies the shortcut link marker name. - href String Specifies the shortcut link. - ========= ====== ======================================== - -.. _en-us_topic_0020212689__table1656029015527: - -.. table:: **Table 7** Data structure of the network which an ECS accesses - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+=========================================================================================+ - | addr | String | Specifies the IP address. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | version | Integer | Specifies the type of an IP address. The value of this parameter can be **4** or **6**. | - | | | | - | | | - **4**: The type of the IP address is IPv4. | - | | | - **6**: The type of the IP address is IPv6. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | OS-EXT-IPS-MAC:mac_addr | String | Specifies the MAC address. This is an extended attribute. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | OS-EXT-IPS:type | String | Specifies the IP address assignment mode. This is an extended attribute. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table20591095122442: - -.. table:: **Table 8** **os-extended-volumes:volumes_attached** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | Specifies the EVS disk ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | delete_on_termination | Boolean | Specifies whether to delete additional disks when deleting the ECS. | - | | | | - | | | By default, this parameter is set to **False**. | - | | | | - | | | This parameter is supported in microversion 2.3 and later. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table761507165933: - -.. table:: **Table 9** **security_groups** field description - - ========= ====== ========================================== - Parameter Type Description - ========= ====== ========================================== - name String Specifies the security group name or UUID. - ========= ====== ========================================== - -.. _en-us_topic_0020212689__table1075312230549: - -.. table:: **Table 10** **fault** field description - - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+=========================================================================================================+ - | code | Integer | Specifies the error code. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the time when an error occurred. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | message | String | Describes an error. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - | details | String | Specifies details about an error. This parameter is optional and is returned only when it is not empty. | - +-----------+---------+---------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__table1080891111402: - -.. table:: **Table 11** **image** field description - - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+===================================================================================================================+ - | id | String | Specifies the image ID. | - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies shortcut links for ECS images. For details, see :ref:`Table 6 `. | - +-----------+------------------+-------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212689__en-us_topic_0057972661_table12534817105641: - -.. table:: **Table 12** **os:scheduler_hints** parameters - - +-------------------+-----------------+------------------+----------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+==================+============================================================================+ - | tenancy | No | Array of strings | Creates ECSs on a dedicated or shared host. | - | | | | | - | | | | The value of this parameter can be **dedicated** or **shared**. | - +-------------------+-----------------+------------------+----------------------------------------------------------------------------+ - | dedicated_host_id | No | Array of strings | Specifies the DeH ID. | - | | | | | - | | | | This parameter takes effect only when **tenancy** is set to **dedicated**. | - +-------------------+-----------------+------------------+----------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/detail - GET https://{endpoint}/v2.1/{project_id}/servers/detail - -Example Response ----------------- - -.. code-block:: - - { - "servers": [ - { - "addresses": { - "68269e6e-4a27-441b-8029-35373ad50bd9": [ - { - "addr": "192.168.0.3", - "version": 4 - } - ] - }, - "created": "2012-09-07T16:56:37Z", - "flavor": { - "id": "1", - "links": [ - { - "href": "http://openstack.example.com/openstack/flavors/1", - "rel": "bookmark" - } - ] - }, - "hostId": "16d193736a5cfdb60c697ca27ad071d6126fa13baeb670fc9d10645e", - "id": "05184ba3-00ba-4fbc-b7a2-03b62b884931", - "image": "", - "links": [ - { - "href": "http://openstack.example.com/v2/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", - "rel": "self" - }, - { - "href": "http://openstack.example.com/openstack/servers/05184ba3-00ba-4fbc-b7a2-03b62b884931", - "rel": "bookmark" - } - ], - "metadata": {}, - "name": "new-server-test", - "progress": 0, - "status": "ACTIVE", - "tenant_id": "openstack", - "updated": "2012-09-07T16:56:37Z", - "user_id": "fake" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_ecss.rst b/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_ecss.rst deleted file mode 100644 index 4200e0e2..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/lifecycle_management/querying_ecss.rst +++ /dev/null @@ -1,166 +0,0 @@ -:original_name: en-us_topic_0020212688.html - -.. _en-us_topic_0020212688: - -Querying ECSs -============= - -Function --------- - -This API is used to query ECSs. - -URI ---- - -GET /v2.1/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={reservation_id}&ip={ip} - -GET /v2/{project_id}/servers?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}¬-tags={not-tags}&reservation_id={eservation_id}&ip={ip} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212688__table5536817: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================================================================================================================================================================================+ - | changes-since | No | String | Specifies the timestamp of the last ECS status update, which is used to filter out the ECSs with statuses updated later than the timestamp. The format must comply with ISO 8601 in the format of CCYY-MM-DDThh:mm:ss+/-hh:mm, for example, 2018-01-17T03:03:32Z. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image | No | String | Specifies the image ID. | - | | | | | - | | | | When image is used as a filter criterion, other filter criteria and paging criteria are not supported. If both the image and other filter criteria are specified, the image filter criterion is used. If the query criteria do not contain the image filter criterion, API functions are not restricted. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | No | String | Specifies the ECS type ID, which is fuzzy matched. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Specifies the ECS name, which is fuzzy matched. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the ECS status. | - | | | | | - | | | | Options: | - | | | | | - | | | | **ACTIVE**, **BUILD**, **ERROR**, **HARD_REBOOT**, **MIGRATING**, **REBOOT**, **REBUILD**, **RESIZE**, **REVERT_RESIZE**, **SHUTOFF**, and **VERIFY_RESIZE** | - | | | | | - | | | | In microversion 2.37, the system will return an empty list for the **status** field out of the preceding options. In microversion 2.38 and later, the system will return error 400. | - | | | | | - | | | | For details, see :ref:`ECS Statuses `. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Specifies the upper limit on the number of returned results. | - | | | | | - | | | | The default value on each page is 25, and the information of a maximum of 1000 ECSs is displayed on each page. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | marker | No | String | Specifies the ECS ID to which the marker points. The query will start from its next ID. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | No | String | Queries ECSs with tags containing the specified value. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | not-tags | No | String | Queries ECSs with tags not containing the specified value. The value is the tag key. | - | | | | | - | | | | For details about key rules, see :ref:`Tag Types `. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key". | - | | | | | - | | | | For example, an existing tag is **a.b**. After the tag function upgrade, query the tag using "not-tags=a". | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reservation_id | No | String | Specifies the ID returned when ECSs are created in a batch. This parameter is used to query ECSs created in a batch. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_key | No | String | Sorts query results by ECS attribute. The default sorting order is the reverse order of **created_at**. | - | | | | | - | | | | Options: **created_at**, **availability_zone**, **display_name**, **host**, **instance_type_id**, **key_name**, **project_id**, **user_id**, **updated_at**, **uuid**, and **vm_state** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip | No | String | Indicates the filtering result for IPv4 addresses, which are fuzzy matched. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0020212688__table44736746: - -.. table:: **Table 3** Response parameters - - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+===================================================================================================================================+ - | servers | Array of objects | Specifies the ECSs to be queried. For details, see :ref:`Table 4 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | servers_links | Array of objects | Specifies the link of the next page in pagination query. For details, see :ref:`Table 5 `. | - +---------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212688__table11253402: - -.. table:: **Table 4** **servers** field description - - +-----------+------------------+--------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+==================+========================================================================================================+ - | name | String | Specifies the ECS name. | - +-----------+------------------+--------------------------------------------------------------------------------------------------------+ - | id | String | Specifies an ECS uniquely. | - +-----------+------------------+--------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies ECS shortcut links. For details, see :ref:`Table 5 `. | - +-----------+------------------+--------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212688__table64121649: - -.. table:: **Table 5** **servers_links** and **links** field description - - ========= ====== ======================================== - Parameter Type Description - ========= ====== ======================================== - rel String Specifies the shortcut link marker name. - href String Specifies the shortcut link. - ========= ====== ======================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers - GET https://{endpoint}/v2.1/{project_id}/servers - -Example Response ----------------- - -.. code-block:: - - { - "servers": [ - { - "id": "616fb98f-46ca-475e-917e-2563e5a8cd19", - "links": [ - { - "href": "http://openstack.example.com/v2/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", - "rel": "self" - }, - { - "href": "http://openstack.example.com/openstack/servers/616fb98f-46ca-475e-917e-2563e5a8cd19", - "rel": "bookmark" - } - ], - "name": "new-server-test" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst deleted file mode 100644 index 0e9692c7..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/configuring_ecs_metadata.rst +++ /dev/null @@ -1,110 +0,0 @@ -:original_name: en-us_topic_0077847902.html - -.. _en-us_topic_0077847902: - -Configuring ECS Metadata -======================== - -Function --------- - -This API is used to configure ECS metadata. - -When you call this API, all the metadata of this ECS will be deleted, and the ECS uses the value configured in the request. - -Constraints ------------ - -An ECS must be in active, stopped, paused, or suspended state, which is specified by **OS-EXT-STS:vm_state**. - -URI ---- - -PUT /v2.1/{project_id}/servers/{server_id}/metadata - -PUT /v2/{project_id}/servers/{server_id}/metadata - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0077847902__en-us_topic_0057973166_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0077847902__en-us_topic_0057973166_table58874912: - -.. table:: **Table 2** Request - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +=================+=================+=================+======================================================================================================================================================================================================================+ - | metadata | Object | Yes | Specifies the user-defined metadata key-value pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | A key contains a maximum of 255 Unicode characters and cannot be empty. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | A value contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0077847902__en-us_topic_0057973166_table52843024: - -.. table:: **Table 3** Response parameters - - ========= ====== =================================================== - Parameter Type Description - ========= ====== =================================================== - metadata Object Specifies the user-defined metadata key-value pair. - ========= ====== =================================================== - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata - PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata - -.. code-block:: - - { - "metadata": { - "key1": "value1", - "key2": "value2" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "metadata": { - "key1": "value1", - "key2": "value2" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/deleting_specified_ecs_metadata.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/deleting_specified_ecs_metadata.rst deleted file mode 100644 index 3cdb00d6..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/deleting_specified_ecs_metadata.rst +++ /dev/null @@ -1,65 +0,0 @@ -:original_name: en-us_topic_0025560299.html - -.. _en-us_topic_0025560299: - -Deleting Specified ECS Metadata -=============================== - -Function --------- - -This API is used to delete specified ECS metadata. - -Constraints ------------ - -An ECS must be in active, stopped, paused, or suspended state, which is specified by **OS-EXT-STS:vm_state**. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/metadata/{key} - -DELETE /v2/{project_id}/servers/{server_id}/metadata/{key} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0025560299__table14014174185439: - -.. table:: **Table 1** Parameter description - - ========== ========= =============================== - Parameter Mandatory Description - ========== ========= =============================== - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - key Yes Specifies the ECS metadata key. - ========== ========= =============================== - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key} - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/index.rst deleted file mode 100644 index 5e3330bb..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0065817681: - -=================== -Metadata Management -=================== - -.. toctree:: - :maxdepth: 1 - - updating_ecs_metadata - configuring_ecs_metadata - deleting_specified_ecs_metadata - querying_ecs_metadata - obtaining_ecs_metadata_with_a_specified_key - modifying_ecs_metadata_with_a_specified_key diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst deleted file mode 100644 index 5417203a..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/modifying_ecs_metadata_with_a_specified_key.rst +++ /dev/null @@ -1,110 +0,0 @@ -:original_name: en-us_topic_0025567413.html - -.. _en-us_topic_0025567413: - -Modifying ECS Metadata with a Specified Key -=========================================== - -Function --------- - -This API is used to modify the ECS metadata with a specified key. - -- If the metadata does not contain the target field, the field is automatically added. -- If the metadata contains the target field, the field value is automatically updated. - -Constraints ------------ - -An ECS must be in active, stopped, paused, or suspended state, which is specified by **OS-EXT-STS:vm_state**. - -URI ---- - -PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key} - -PUT /v2/{project_id}/servers/{server_id}/metadata/{key} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0025567413__table258804192629: - -.. table:: **Table 1** Parameter description - - ========== ========= =============================== - Parameter Mandatory Description - ========== ========= =============================== - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - key Yes Specifies the ECS metadata key. - ========== ========= =============================== - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0025567413__table21113531192629: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================================================================================+ - | meta | Yes | Object | Specifies the user-defined metadata key pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and cannot be left blank. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0025567413__table34681280192629: - -.. table:: **Table 3** Response parameters - - ========= ====== =================================================== - Parameter Type Description - ========= ====== =================================================== - meta Object Specifies the user-defined metadata key-value pair. - ========= ====== =================================================== - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata/{key} - PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata/{key} - -.. code-block:: - - { - "meta":{ - "key":"value" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "meta":{ - "key":"value" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/obtaining_ecs_metadata_with_a_specified_key.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/obtaining_ecs_metadata_with_a_specified_key.rst deleted file mode 100644 index f9942757..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/obtaining_ecs_metadata_with_a_specified_key.rst +++ /dev/null @@ -1,76 +0,0 @@ -:original_name: en-us_topic_0065817714.html - -.. _en-us_topic_0065817714: - -Obtaining ECS Metadata with a Specified Key -=========================================== - -Function --------- - -This API is used to obtain ECS metadata with a specified key. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/metadata/{key} - -GET /v2/{project_id}/servers/{server_id}/metadata/{key} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817714__en-us_topic_0057973169_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= =============================== - Parameter Mandatory Description - ========== ========= =============================== - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - key Yes Specifies the ECS metadata key. - ========== ========= =============================== - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817714__en-us_topic_0057973169_table40140147: - -.. table:: **Table 2** Response parameters - - ========= ====== =================================================== - Parameter Type Description - ========= ====== =================================================== - meta Object Specifies the user-defined metadata key-value pair. - ========= ====== =================================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata/key1 - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata/key1 - -Example Response ----------------- - -.. code-block:: - - { - "meta": { - "key1": "value1" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/querying_ecs_metadata.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/querying_ecs_metadata.rst deleted file mode 100644 index 59e412c2..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/querying_ecs_metadata.rst +++ /dev/null @@ -1,79 +0,0 @@ -:original_name: en-us_topic_0065817713.html - -.. _en-us_topic_0065817713: - -Querying ECS Metadata -===================== - -Function --------- - -This API is used to query ECS metadata. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/metadata - -GET /v2/{project_id}/servers/{server_id}/metadata - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817713__en-us_topic_0057973165_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -.. note:: - - Pagination query is not supported. - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817713__en-us_topic_0057973165_table48538422: - -.. table:: **Table 2** Response parameters - - +-----------+-----------+--------+-----------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=====================================================+ - | metadata | Yes | Object | Specifies the user-defined metadata key-value pair. | - +-----------+-----------+--------+-----------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/998af54b-5762-4041-abc1-f98a2c27b3a2/metadata - -Example Response ----------------- - -.. code-block:: - - { - "metadata": { - "wj": "True" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/metadata_management/updating_ecs_metadata.rst b/ecs/api-ref/result/openstack_nova_apis/metadata_management/updating_ecs_metadata.rst deleted file mode 100644 index b8290f8f..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/metadata_management/updating_ecs_metadata.rst +++ /dev/null @@ -1,110 +0,0 @@ -:original_name: en-us_topic_0025560298.html - -.. _en-us_topic_0025560298: - -Updating ECS Metadata -===================== - -Function --------- - -This API is used to update ECS metadata. - -- If the metadata does not contain the target field, the field is automatically added. -- If the metadata contains the target field, the field value is automatically updated. -- If the field in the metadata is not requested, the field value remains unchanged. - -Constraints ------------ - -An ECS must be in active, stopped, paused, or suspended state, which is specified by **OS-EXT-STS:vm_state**. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/metadata - -POST /v2/{project_id}/servers/{server_id}/metadata - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0025560298__table18618337185333: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0025560298__table52485804185333: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================================================================================+ - | metadata | Yes | Object | Specifies the user-defined metadata key-value pair. | - | | | | | - | | | | For a metadata key: | - | | | | | - | | | | It contains a maximum of 255 Unicode characters and cannot be left blank. A key can contain uppercase letters (A-Z), lowercase letters (a-z), digits (0-9), hyphens (-), underscores (_), colons (:), and periods (.). | - | | | | | - | | | | For a metadata value: | - | | | | | - | | | | A value contains a maximum of 255 Unicode characters. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0025560298__table48150236185333: - -.. table:: **Table 3** Response parameters - - ========= ====== =================================================== - Parameter Type Description - ========= ====== =================================================== - metadata Object Specifies the user-defined metadata key-value pair. - ========= ====== =================================================== - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/metadata - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/metadata - -.. code-block:: - - { - "metadata": { - "key": "value" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "metadata":{ - "key":"value" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/network_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/network_management/index.rst deleted file mode 100644 index 44c72a77..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/network_management/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0031167513: - -================== -Network Management -================== - -.. toctree:: - :maxdepth: 1 - - querying_networks - querying_the_networks_of_a_specified_ecs - querying_the_specified_network_of_an_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_networks.rst b/ecs/api-ref/result/openstack_nova_apis/network_management/querying_networks.rst deleted file mode 100644 index 31dc6e30..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_networks.rst +++ /dev/null @@ -1,126 +0,0 @@ -:original_name: en-us_topic_0031169828.html - -.. _en-us_topic_0031169828: - -Querying Networks -================= - -Function --------- - -This API is used to query the networks available to a tenant. - -Constraints ------------ - -You can query only the network ID and label (network name). Other fields are all null. - -URI ---- - -GET /v2.1/{project_id}/os-networks - -GET /v2/{project_id}/os-networks - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031169828__table60562285165259: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0031169828__table50321718145545: - -.. table:: **Table 2** Response parameters - - +------------+-----------+--------+------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+======================================================+ - | id | Yes | String | Specifies the network ID in UUID format. | - +------------+-----------+--------+------------------------------------------------------+ - | label | Yes | String | Specifies the network name. | - +------------+-----------+--------+------------------------------------------------------+ - | broadcast | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | cidr | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | cidr_v6 | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | dns1 | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | dns2 | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | gateway | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | gateway_v6 | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | netmask | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | netmask_v6 | Yes | String | The value can only be null. | - +------------+-----------+--------+------------------------------------------------------+ - | bridge | No | String | The value is fixed to be null and is in UUID format. | - +------------+-----------+--------+------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/os-networks - GET https://{endpoint}/v2.1/{project_id}/os-networks - -Example Response ----------------- - -.. code-block:: - - { - "networks": [ - { - "id": "04468f37-500a-4a80-88da-af823e7a1d6c", - "cidr_v6": null, - "gateway": null, - "label": "network_demo1", - "broadcast": null, - "netmask": null, - "cidr": null, - "dns2": null, - "gateway_v6": null, - "netmask_v6": null, - "dns1": null - }, - { - "id": "1fcff959-21d0-4ba8-976a-974cb564c977", - "cidr_v6": null, - "gateway": null, - "label": "network_demo2", - "broadcast": null, - "netmask": null, - "cidr": null, - "dns2": null, - "gateway_v6": null, - "netmask_v6": null, - "dns1": null - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_networks_of_a_specified_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_networks_of_a_specified_ecs.rst deleted file mode 100644 index a72d771a..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_networks_of_a_specified_ecs.rst +++ /dev/null @@ -1,121 +0,0 @@ -:original_name: en-us_topic_0031169058.html - -.. _en-us_topic_0031169058: - -Querying the Networks of a Specified ECS -======================================== - -Function --------- - -This API is used to query the networks of an ECS. - -Constraints ------------ - -None - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/ips - -GET /v2/{project_id}/servers/{server_id}/ips - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031169058__table60562285165259: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0031169058__table53480673143936: - -.. table:: **Table 2** Response parameters - - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==========================================================================================================================+ - | addresses | Yes | Object | Specifies the network address of the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0031169058__table56891490143956: - -.. table:: **Table 3** **addresses** parameter structure description - - +--------------------------------------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============================================+===========+==================+==========================================================================================================================================================+ - | Name of the network where the ECS accesses | Yes | Array of objects | Specifies the network where the ECS accesses. For details about the network parameter, see :ref:`Table 4 `. | - +--------------------------------------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0031169058__table22651992144025: - -.. table:: **Table 4** ECS network parameter structure description - - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - | Attribute | Type | CRUD | Default Value | Constraint | Remarks | - +===========+=========+======+===============+===================+======================================================================================+ - | version | Integer | R | N/A | 4 or 6 | Specifies the IP address version. The value of this parameter can be **4** or **6**. | - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - | addr | String | R | N/A | IP address format | Specifies the IP address. | - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips - -Example Response ----------------- - -.. code-block:: - - { - "addresses": { - "demo_net": [ - { - "version": 4, - "addr": "10.0.0.4" - }, - { - "version": 4, - "addr": "192.150.73.132" - } - ], - "private_net": [ - { - "version": 4, - "addr": "10.176.42.16" - }, - { - "version": 6, - "addr": "::babe:10.176.42.16" - } - ] - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_specified_network_of_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_specified_network_of_an_ecs.rst deleted file mode 100644 index 33eea6f6..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/network_management/querying_the_specified_network_of_an_ecs.rst +++ /dev/null @@ -1,107 +0,0 @@ -:original_name: en-us_topic_0031169059.html - -.. _en-us_topic_0031169059: - -Querying the Specified Network of an ECS -======================================== - -Function --------- - -This API is used to query the specified network of an ECS. - -Constraints ------------ - -None - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/ips/{networkName} - -GET /v2/{project_id}/servers/{server_id}/ips/{networkName} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0031169059__table60562285165259: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. table:: **Table 2** Request parameters - - =========== ========= ====== =============================== - Parameter Mandatory Type Description - =========== ========= ====== =============================== - server_id Yes String Specifies the ECS ID. - networkName Yes String Specifies the ECS network name. - =========== ========= ====== =============================== - -Request -------- - -None - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0031169059__table56891490143956: - -.. table:: **Table 3** Response parameters - - +--------------------------------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================================+============+================================================================================================================================================+ - | Name of the network where the ECS accesses | List(Dict) | Specifies the network where the ECS accesses. For details about the network, see :ref:`Table 4 `. | - +--------------------------------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0031169059__table22651992144025: - -.. table:: **Table 4** ECS network parameter structure description - - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - | Attribute | Type | CRUD | Default Value | Constraint | Remarks | - +===========+=========+======+===============+===================+======================================================================================+ - | version | Integer | R | N/A | 4 or 6 | Specifies the IP address version. The value of this parameter can be **4** or **6**. | - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - | addr | String | R | N/A | IP address format | Specifies the IP address. | - +-----------+---------+------+---------------+-------------------+--------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/ips/{networkName} - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/ips/{networkName} - -Example Response ----------------- - -.. code-block:: - - { - "demo_net": [ - { - "version": 4, - "addr": "10.0.0.4" - }, - { - "version": 4, - "addr": "192.150.73.132" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/nic_management/adding_a_nic_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/nic_management/adding_a_nic_to_an_ecs.rst deleted file mode 100644 index 3195ff0e..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/nic_management/adding_a_nic_to_an_ecs.rst +++ /dev/null @@ -1,178 +0,0 @@ -:original_name: en-us_topic_0020212664.html - -.. _en-us_topic_0020212664: - -Adding a NIC to an ECS -====================== - -Function --------- - -This API is used to add a NIC to an ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/os-interface - -POST /v2/{project_id}/servers/{server_id}/os-interface - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212664__table55925239: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212664__table21989419: - -.. table:: **Table 2** Request parameters - - +---------------------+-----------+--------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+========+==========================================================================================================+ - | interfaceAttachment | Yes | Object | Specifies the NICs to be added. For details, see :ref:`Table 3 `. | - +---------------------+-----------+--------+----------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212664__table44975500: - -.. table:: **Table 3** **interfaceAttachment** field description - - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+==========================================================================================================================================================================================+ - | port_id | No | String | Specifies the port ID. | - | | | | | - | | | | Either **port_id** or **net_id** is used each time. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net_id | No | String | Specifies the network ID. | - | | | | | - | | | | Either **port_id** or **net_id** is used each time. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | No | Array of objects | Specifies a private IP address. | - | | | | | - | | | | This parameter cannot be specified when **port_id** is used. | - | | | | | - | | | | This parameter must be used with **net_id**. | - | | | | | - | | | | Only the first element in the list is valid. If two or more elements are used, an error will be reported. For details, see :ref:`Table 4 `. | - +-----------------+-----------------+------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212664__table26224215175117: - -.. table:: **Table 4** **fixed_ips** field description - - ========== ========= ====== ========================= - Parameter Mandatory Type Description - ========== ========= ====== ========================= - ip_address No String Specifies the IP address. - ========== ========= ====== ========================= - -Response --------- - -:ref:`Table 5 ` describes the response parameters. - -.. _en-us_topic_0020212664__table60398192112020: - -.. table:: **Table 5** Response parameters - - +---------------------+--------+----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+========+==============================================================================================+ - | interfaceAttachment | Object | Specifies ECS NICs. For details, see :ref:`Table 6 `. | - +---------------------+--------+----------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212664__table49017803: - -.. table:: **Table 6** **interfaceAttachment** field description - - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+==================+=================================================================================================================+ - | port_state | String | Specifies the port state. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of objects | Specifies IP addresses for NICs. For details, see :ref:`Table 7 `. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | port_id | String | Specifies the port ID. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | net_id | String | Specifies the network ID. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - | mac_addr | String | Specifies the MAC address. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212664__table35098076112057: - -.. table:: **Table 7** **fixed_ips** field description - - ========== ====== =============================================== - Parameter Type Description - ========== ====== =============================================== - subnet_id String Specifies the ID of the subnet used by the NIC. - ip_address String Specifies the NIC IP address. - ========== ====== =============================================== - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface - -.. code-block:: - - { - "interfaceAttachment" : { - "fixed_ips" : [ - { - "ip_address" : "192.168.1.3" - } - ], - "net_id" : "3cb9bc59-5699-4588-a4b1-b87f96708bc6" - } - } - -.. code-block:: - - { - "interfaceAttachment" : { - "port_id" : "ce531f90-199f-48c0-816c-13e38010b442" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "interfaceAttachment": { - "port_state": "DOWN", - "fixed_ips": [ - { - "subnet_id": "d9cfef77-0151-4c2a-9ed5-d951ada8adf3", - "ip_address": "10.0.1.11" - } - ], - "port_id": " ce531f90-199f-48c0-816c-13e38010b442", - "net_id": "0dc714fa-9022-4a03-bb22-9821a396bb9d", - "mac_addr": "fa:16:3e:63:75:b2" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/nic_management/deleting_a_nic_from_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/nic_management/deleting_a_nic_from_an_ecs.rst deleted file mode 100644 index 10a91618..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/nic_management/deleting_a_nic_from_an_ecs.rst +++ /dev/null @@ -1,79 +0,0 @@ -:original_name: en-us_topic_0020212666.html - -.. _en-us_topic_0020212666: - -Deleting a NIC from an ECS -========================== - -Function --------- - -This API is used to delete a NIC from an ECS based on the port ID. - -Constraints ------------ - -The primary NIC of an ECS has routing rules configured and cannot be deleted. - -When an ECS NIC is detached, all NICs attached to the ECS through the OpenStack Nova API will be deleted. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/os-interface/{port_id}{?reserve_port} - -DELETE /v2/{project_id}/servers/{server_id}/os-interface/{port_id}{?reserve_port} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212666__table34333880: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+==============================================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------+ - | port_id | Yes | Specifies the port ID of the NIC. | - | | | | - | | | .. note:: | - | | | | - | | | When the ID is the same as the ECS primary NIC ID, the system will return error code 403. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------+ - | reserve_port | No | Indicates whether to retain the NIC port after the NIC is unbound. | - | | | | - | | | **True**: indicates that the port is reserved. | - | | | | - | | | **False**: indicates that the port is deleted. This is the default value. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{port_id} - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{port_id} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/nic_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/nic_management/index.rst deleted file mode 100644 index 77aa2762..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/nic_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0020212660: - -============== -NIC Management -============== - -.. toctree:: - :maxdepth: 1 - - querying_ecs_nics - querying_nics_of_an_ecs - adding_a_nic_to_an_ecs - deleting_a_nic_from_an_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_ecs_nics.rst b/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_ecs_nics.rst deleted file mode 100644 index 5feb6b6b..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_ecs_nics.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: en-us_topic_0020212661.html - -.. _en-us_topic_0020212661: - -Querying ECS NICs -================= - -Function --------- - -This API is used to query information about ECS NICs. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-interface - -GET /v2/{project_id}/servers/{server_id}/os-interface - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212661__table38523909: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212661__table25276401: - -.. table:: **Table 2** Response parameters - - +----------------------+------------------+----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================+==================+==============================================================================================+ - | interfaceAttachments | Array of objects | Specifies ECS NICs. For details, see :ref:`Table 3 `. | - +----------------------+------------------+----------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212661__table49805933: - -.. table:: **Table 3** **interfaceAttachments** field description - - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+==================+===================================================================================================================+ - | port_state | String | Specifies the NIC port status. | - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of objects | Specifies private IP addresses for NICs. For details, see :ref:`Table 4 `. | - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | net_id | String | Specifies the network ID to which the NIC port belongs. | - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | port_id | String | Specifies the ID of the NIC port. | - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - | mac_addr | String | Specifies the MAC address of the NIC. | - +------------+------------------+-------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212661__table19750463: - -.. table:: **Table 4** **fixed_ips** field description - - ========== ====== =================================================== - Parameter Type Description - ========== ====== =================================================== - subnet_id String Specifies the subnet of the NIC private IP address. - ip_address String Specifies the NIC private IP address. - ========== ====== =================================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface - -Example Response ----------------- - -.. code-block:: - - { - "interfaceAttachments": [ - { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", - "ip_address": "192.168.1.3" - } - ], - "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", - "port_id": "ce531f90-199f-48c0-816c-13e38010b442", - "mac_addr": "fa:16:3e:4c:2c:30" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_nics_of_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_nics_of_an_ecs.rst deleted file mode 100644 index e26c946f..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/nic_management/querying_nics_of_an_ecs.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: en-us_topic_0020212662.html - -.. _en-us_topic_0020212662: - -Querying NICs of an ECS -======================= - -Function --------- - -This API is used to query NICs of an ECS based on the NIC ID. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id} - -GET /v2/{project_id}/servers/{server_id}/os-interface/{id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212662__table25654779: - -.. table:: **Table 1** Parameter description - - ========== ========= ================================= - Parameter Mandatory Description - ========== ========= ================================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - id Yes Specifies the port ID of the NIC. - ========== ========= ================================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0020212662__table59131099: - -.. table:: **Table 2** Response parameters - - +---------------------+--------+----------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+========+==============================================================================================+ - | interfaceAttachment | Object | Specifies ECS NICs. For details, see :ref:`Table 3 `. | - +---------------------+--------+----------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212662__table24005299: - -.. table:: **Table 3** **interfaceAttachment** field description - - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+==================+===========================================================================================================+ - | port_state | String | Specifies the NIC port status. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - | fixed_ips | Array of objects | Specifies IP addresses for NICs. For details, see :ref:`Table 4 `. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - | net_id | String | Specifies the network ID to which the NIC port belongs. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - | port_id | String | Specifies the ID of the NIC port. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - | mac_addr | String | Specifies the MAC address of the NIC. | - +------------+------------------+-----------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212662__table53180163: - -.. table:: **Table 4** **fixed_ips** field description - - ========== ====== =============================================== - Parameter Type Description - ========== ====== =============================================== - subnet_id String Specifies the ID of the subnet used by the NIC. - ip_address String Specifies the NIC IP address. - ========== ====== =============================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/servers/{server_id}/os-interface/{id} - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/os-interface/{id} - -Example Response ----------------- - -.. code-block:: - - { - "interfaceAttachment": - { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "f8a6e8f8-c2ec-497c-9f23-da9616de54ef", - "ip_address": "192.168.1.3" - } - ], - "net_id": "3cb9bc59-5699-4588-a4b1-b87f96708bc6", - "port_id": "ce531f90-199f-48c0-816c-13e38010b442", - "mac_addr": "fa:16:3e:4c:2c:30" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/security_group_management/adding_a_security_group.rst b/ecs/api-ref/result/openstack_nova_apis/security_group_management/adding_a_security_group.rst deleted file mode 100644 index 9a7752ef..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/security_group_management/adding_a_security_group.rst +++ /dev/null @@ -1,88 +0,0 @@ -:original_name: en-us_topic_0067161469.html - -.. _en-us_topic_0067161469: - -Adding a Security Group -======================= - -Function --------- - -This API is used to add an ECS to a security group. - -You are suggested to add an ECS to a maximum of five security groups. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067161469__table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0067161469__en-us_topic_0058745339_table44724688204850: - -.. table:: **Table 2** Request parameter - - +------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+========+============================================================================================================================================================+ - | addSecurityGroup | Yes | Object | Specifies the security group where the ECS is added. For details, see :ref:`Table 3 `. | - +------------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067161469__en-us_topic_0058745339_table59377750205027: - -.. table:: **Table 3** **addSecurityGroup** parameter description - - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=====================================================================================================================================+ - | name | Yes | String | Specifies the UUID or name of the security group to which the ECS is added. The configuration takes effect for the NICs on the ECS. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "addSecurityGroup": { - "name": "sg-test" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/security_group_management/deleting_a_security_group.rst b/ecs/api-ref/result/openstack_nova_apis/security_group_management/deleting_a_security_group.rst deleted file mode 100644 index 01dd569f..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/security_group_management/deleting_a_security_group.rst +++ /dev/null @@ -1,86 +0,0 @@ -:original_name: en-us_topic_0067161717.html - -.. _en-us_topic_0067161717: - -Deleting a Security Group -========================= - -Function --------- - -This API is used to delete a security group for an ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067161717__table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0067161717__en-us_topic_0058745339_table44724688204850: - -.. table:: **Table 2** Request parameter - - +---------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+========+==============================================================================================================================================================+ - | removeSecurityGroup | Yes | Object | Specifies the security group to be deleted for an ECS. For details, see :ref:`Table 3 `. | - +---------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067161717__en-us_topic_0058745339_table59377750205027: - -.. table:: **Table 3** **removeSecurityGroup** parameter description - - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=========================================================================================================================================+ - | name | Yes | String | Specifies the UUID or name of the security group from which the ECS is removed. The configuration takes effect for the NICs on the ECS. | - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "removeSecurityGroup": { - "name": "sg-test" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/security_group_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/security_group_management/index.rst deleted file mode 100644 index 1c0d1bd1..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/security_group_management/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0031167514: - -========================= -Security Group Management -========================= - -.. toctree:: - :maxdepth: 1 - - adding_a_security_group - deleting_a_security_group - querying_security_groups_for_a_specified_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/security_group_management/querying_security_groups_for_a_specified_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/security_group_management/querying_security_groups_for_a_specified_ecs.rst deleted file mode 100644 index 9d4bc030..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/security_group_management/querying_security_groups_for_a_specified_ecs.rst +++ /dev/null @@ -1,206 +0,0 @@ -:original_name: en-us_topic_0065817702.html - -.. _en-us_topic_0065817702: - -Querying Security Groups for a Specified ECS -============================================ - -Function --------- - -This API is used to query security groups for a specified ECS. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/os-security-groups - -GET /v2/{project_id}/servers/{server_id}/os-security-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table35383970: - -.. table:: **Table 2** Response parameters - - +-----------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+==================+============================================================================================================================+ - | security_groups | Yes | Array of objects | Specifies security groups. For details, see :ref:`Table 3 `. | - +-----------------+-----------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table19346796: - -.. table:: **Table 3** **security_group** objects - - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+==================+=================================================================================================================================+ - | description | Yes | String | Specifies information about a security group. It must contain 0 to 255 characters. | - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the security group ID in UUID format. | - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the security group name. It must contain 0 to 255 characters. | - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | rules | Yes | Array of objects | Specifies security group rules. For details, see :ref:`Table 4 `. | - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | Yes | String | Specifies the tenant or project ID. | - +-------------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table44319244: - -.. table:: **Table 4** **security_group_rule** objects - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=========================================================================================================================================================================================================+ - | parent_group_id | Yes | String | Specifies the associated security group ID in UUID format. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | Yes | String | Specifies the protocol type or the IP protocol number. The value can be **icmp**, **tcp**, **udp**, or the IP protocol number. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Yes | Integer | Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than **to_port**. | - | | | | | - | | | | When **ip_protocol** is **icmp**, this parameter specifies a port type with a length from 0 to 255 characters. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Yes | Integer | Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than **from_port**. | - | | | | | - | | | | When **ip_protocol** is **icmp**, it specifies the code. The value ranges from 0 to 255. If both **from_port** and **to_port** are **-1**, any ICMP packet can be transmitted. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_range | Yes | Object | Specifies the peer IP segment in CIDR format. For details, see :ref:`Table 5 `. | - | | | | | - | | | | The value of **ip_range** or **group** must be empty. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group | Yes | Object | Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see :ref:`Table 6 `. | - | | | | | - | | | | The value of **ip_range** or **group** must be empty. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the security group rule ID in UUID format. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table4101480163218: - -.. table:: **Table 5** **ip_range** objects - - ========= ========= ====== ============================================= - Parameter Mandatory Type Description - ========= ========= ====== ============================================= - cidr No String Specifies the peer IP segment in CIDR format. - ========= ========= ====== ============================================= - -.. _en-us_topic_0065817702__en-us_topic_0057972666_table9527961163416: - -.. table:: **Table 6** **group** objects - - +-----------+-----------+--------+------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================+ - | tenant_id | No | String | Specifies the ID of the tenant of the peer security group. | - +-----------+-----------+--------+------------------------------------------------------------+ - | name | No | String | Specifies the name of the peer security group. | - +-----------+-----------+--------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups - GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/servers/65fae4c2-3a09-46c6-af12-3b04f1fdba1e/os-security-groups - -Example Response ----------------- - -.. code-block:: - - { - "security_groups": [ - { - "rules": [ - { - "from_port": null, - "group": { - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "name": "default" - }, - "ip_protocol": null, - "to_port": null, - "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "ip_range": {}, - "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee" - }, - { - "from_port": null, - "group": { - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "name": "default" - }, - "ip_protocol": null, - "to_port": null, - "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "ip_range": {}, - "id": "f9371051-d7e1-4be4-8748-77b1e0913730" - } - ], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "description": "default", - "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "name": "default" - }, - { - "rules": [ - { - "from_port": 200, - "group": {}, - "ip_protocol": "tcp", - "to_port": 400, - "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "ip_range": { - "cidr": "0.0.0.0/0" - }, - "id": "3330120d-bbd1-4a73-bda9-0196a84d5670" - }, - { - "from_port": 201, - "group": {}, - "ip_protocol": "tcp", - "to_port": 400, - "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "ip_range": { - "cidr": "0.0.0.0/0" - }, - "id": "b550c9a6-970a-462d-984e-265e88020818" - } - ], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "description": "desc-sg", - "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "name": "test-sg" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/confirming_ecs_specifications_modification.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/confirming_ecs_specifications_modification.rst deleted file mode 100644 index a87b366b..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/confirming_ecs_specifications_modification.rst +++ /dev/null @@ -1,86 +0,0 @@ -:original_name: en-us_topic_0028714262.html - -.. _en-us_topic_0028714262: - -Confirming ECS Specifications Modification -========================================== - -Function --------- - -This API is used to confirm the specifications modification of an ECS. - -Constraints ------------ - -Before calling this API, ensure that the ECS status (which can be queried using the API for querying details about the ECS) meets the following requirements: - -OS-EXT-STS:vm_state=resized - -OS-EXT-STS:task_state="" - -status=VERIFY_RESIZE - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0028714262__table54458463165029: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0028714262__table47783938165029: - -.. table:: **Table 2** Request parameters - - +---------------+-----------+------+--------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+======+==================================================+ - | confirmResize | Yes | Null | Confirms the modification to ECS specifications. | - +---------------+-----------+------+--------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "confirmResize" : null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/creating_an_image_using_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/creating_an_image_using_an_ecs.rst deleted file mode 100644 index bd26904f..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/creating_an_image_using_an_ecs.rst +++ /dev/null @@ -1,122 +0,0 @@ -:original_name: en-us_topic_0065817694.html - -.. _en-us_topic_0065817694: - -Creating an Image Using an ECS -============================== - -Function --------- - -This API is used to create an image using an ECS. After the creation, you can use this image to create ECSs. - -Images created using an ECS are stored on storage nodes as snapshots. - -.. note:: - - This API is a native OpenStack API that is not applicable to the images on the public cloud platform. - - - To create a system disk image or data disk image, use the IMS API (**POST /v2/cloudimages/action**). For details, see "Creating an Image" in *Image Management Service API Reference*. - - To create a full-ECS image, use the IMS API (**POST /v1/cloudimages/wholeimages/action**). For details, see "Creating a Full-ECS Image" in *Image Management Service API Reference*. - -Constraints ------------ - -#. An ECS in the error state cannot be used to create an image. -#. If an image created using an ECS is used to create a new ECS, the new ECS must be located in the same AZ as the original ECS. -#. After an ECS is deleted, the images and snapshots created using this ECS will not be automatically deleted. You must manually delete them. -#. After an image created using an ECS is deleted, the associated snapshots will not be automatically deleted (this function is implemented by native OpenStack). You must manually delete such snapshots. -#. The image created using an ECS cannot be used to create data disks. -#. The images created using the API described in this section (URI: POST /v2/{project_id}/servers/{server_id}/action or POST /v2.1/{project_id}/servers/{server_id}/action) cannot be exported to OBS buckets. If such images must be exported, use the IMS API (**POST /v2/cloudimages/action**). For details, see "Creating an Image" in *Image Management Service API Reference*. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817694__table9179610161220: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817694__table3529164221216: - -.. table:: **Table 2** Request parameters - - +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+========================================================================================================================================+ - | createImage | Yes | Object | Specifies the image created using ECS. For details, see :ref:`Table 3 `. | - +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817694__en-us_topic_0057972976_table47198018: - -.. table:: **Table 3** **createImage** field description - - +-----------+-----------+--------+-------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===========================================================================================+ - | name | Yes | String | Specifies the image name with a length greater than 0 bytes and less than 243 bytes. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the image attribute with a length greater than 0 bytes and less than 255 bytes. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------+ - -Response --------- - -+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------+ -| Parameter | Mandatory | Type | Description | -+=================+=================+=================+================================================================================+ -| Location | Yes | String | Specifies the local URL of the image, which is returned in the request header. | -| | | | | -| | | | This parameter is not supported in microversion 2.44 and later. | -+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------+ -| image_id | Yes | String | Specifies the image UUID. | -| | | | | -| | | | This parameter is supported in microversion 2.45 and later. | -+-----------------+-----------------+-----------------+--------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "createImage" : { - "name" : "new-image-name", - "metadata": { - "ImageType": "Gold", - "ImageVersion": "2.0" - } - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/index.rst deleted file mode 100644 index 25e5a163..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _en-us_topic_0124385016: - -================= -Status Management -================= - -.. toctree:: - :maxdepth: 1 - - starting_an_ecs - restarting_an_ecs - stopping_an_ecs - locking_an_ecs - unlocking_an_ecs - rebuilding_an_ecs - creating_an_image_using_an_ecs - modifying_the_specifications_of_an_ecs - confirming_ecs_specifications_modification - rolling_back_ecs_specifications_modification diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/locking_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/locking_an_ecs.rst deleted file mode 100644 index 2ced7ff0..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/locking_an_ecs.rst +++ /dev/null @@ -1,77 +0,0 @@ -:original_name: en-us_topic_0065817690.html - -.. _en-us_topic_0065817690: - -Locking an ECS -============== - -Function --------- - -This API is used to lock an ECS. - -You are only allowed to lock your own ECSs. After ECSs are locked, you will not be able to perform management operations on them, including life cycle management, status management, NIC management, disk management, and password management. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817690__en-us_topic_0057973175_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817690__en-us_topic_0057973175_table18228066: - -.. table:: **Table 2** Request parameters - - ========= ==== ========= ============= - Parameter Type Mandatory Description - ========= ==== ========= ============= - lock Null Yes Locks an ECS. - ========= ==== ========= ============= - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "lock": null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/modifying_the_specifications_of_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/modifying_the_specifications_of_an_ecs.rst deleted file mode 100644 index 6805f2fc..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/modifying_the_specifications_of_an_ecs.rst +++ /dev/null @@ -1,83 +0,0 @@ -:original_name: en-us_topic_0028714261.html - -.. _en-us_topic_0028714261: - -Modifying the Specifications of an ECS -====================================== - -Function --------- - -This API is used to modify the specifications of an ECS. - -For a running ECS, the system will automatically stop the ECS, copy the ECS data to the target node, which can be the source node, and then restart the ECS. - -This API supports automatic rollback if the underlying resources are insufficient. - -This API must be used with the API for verifying ECS specifications modification (POST /v2.1/{project_id}/servers/{server_id}/action) or the API for rolling back ECS specifications modification (POST /v2.1/{project_id}/servers/{server_id}/action) if an ECS is detected to be in **VERIFY_RESIZE** state and its **OS-EXT-STS:vm_state** is **RESIZED**. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0028714261__table3588765216457: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0028714261__table2242889516457: - -.. table:: **Table 2** Request parameters - - ========= ========= ====== =================================== - Parameter Mandatory Type Description - ========= ========= ====== =================================== - flavorRef Yes String Specifies the new flavor ID or URI. - ========= ========= ====== =================================== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "resize" : { - "flavorRef" : "s6.medium.2" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/rebuilding_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/rebuilding_an_ecs.rst deleted file mode 100644 index 61fff8b2..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/rebuilding_an_ecs.rst +++ /dev/null @@ -1,276 +0,0 @@ -:original_name: en-us_topic_0065817688.html - -.. _en-us_topic_0065817688: - -Rebuilding an ECS -================= - -Function --------- - -This API is used to rebuild an ECS. - -You can use the original image or another image to rebuild an ECS. This API supports different OSs. - -This API is native from the community for defcore tests. - -If you are required to reinstall or change an ECS OS, ECS APIs are recommended. For details, see "Reinstalling an ECS OS (Using an Image with Cloud-Init Installed)" and "Changing an OS (Using an Image with Cloud-Init Installed)". - -Constraints ------------ - -- ECSs in the error state cannot be rebuilt. -- The password cannot be set during the rebuilding. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817688__en-us_topic_0058745339_table46110007: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817688__en-us_topic_0058745339_table44724688204850: - -.. table:: **Table 2** Request parameter - - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+========================================================================================================================+ - | rebuild | Yes | Object | Rebuilds an ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817688__en-us_topic_0058745339_table59377750205027: - -.. table:: **Table 3** **rebuild** parameters - - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+=====================================================================================================================================+ - | name | No | String | Specifies the name of the rebuilt ECS. | - | | | | | - | | | | The value contains 1 to 254 characters. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the metadata of the rebuilt ECS. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | imageRef | Yes | String | Specifies the image ID or URL. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | adminPass | No | String | Specifies the password for logging in to the rebuilt ECS. This parameter does not take effect. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | No | String | Not supported | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | preserve_ephemeral | No | Boolean | Specifies whether to retain the temporary disk. This parameter is not supported. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | key_name | No | String | Specifies the key pair name. If the value is null, the existing key pair is left blank. | - | | | | | - | | | | This parameter is supported in microversion 2.54 and later. | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | user_data | No | String | Specifies the user data to be injected during the ECS creation. This is an extended attribute. Text and text files can be injected. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - The content of **user_data** must be encoded with base64. | - | | | | - The maximum size of the content to be injected (before encoding) is 32 KB. | - | | | | | - | | | | For more information about the user data to be injected, see "Injecting User Data into ECSs" in *Elastic Cloud Server User Guide*. | - | | | | | - | | | | Examples | - | | | | | - | | | | Before base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | #! /bin/bash | - | | | | echo user_test >> /home/user.txt | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | rem cmd | - | | | | echo 111 > c:\aaa.txt | - | | | | | - | | | | After base64 encoding: | - | | | | | - | | | | - Linux | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | IyEgL2Jpbi9iYXNoDQplY2hvIHVzZXJfdGVzdCAmZ3Q7Jmd0OyAvaG9tZS91c2VyLnR4dA== | - | | | | | - | | | | - Windows | - | | | | | - | | | | .. code-block:: | - | | | | | - | | | | cmVtIGNtZA0KZWNobyAxMTEgJmd0OyBjOlxhYWEudHh0 | - +--------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817688__en-us_topic_0058745339_table49173801205341: - -.. table:: **Table 4** Response parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | status | String | Specifies the ECS status. | - | | | | - | | | Values: | - | | | | - | | | - **ACTIVE** | - | | | - **REBOOT** | - | | | - **HARD_REBOOT** | - | | | - **REBUILD** | - | | | - **MIGRATING** | - | | | - **BUILD** | - | | | - **SHUTOFF** | - | | | - **RESIZE** | - | | | - **VERIFY_RESIZE** | - | | | - **ERROR** | - | | | - **DELETED** | - | | | | - | | | For details, see :ref:`ECS Statuses `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | updated | String | Specifies the time when the ECS was updated last time. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | hostId | String | Specifies the ID of the host on which the ECS is deployed. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | addresses | Array of objects | Specifies the network attribute of the ECS. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Describes the ECS. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | image | Object | Specifies the ECS image information. For the ECS that boots from a volume, the value is left blank. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | flavor | Object | Specifies the ECS flavor. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the ECS ID in UUID format. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | user_id | String | Specifies the user UUID of the ECS. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the ECS name. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the UUID of the tenant who owns the ECS. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | OS-DCF:diskConfig | String | Specifies the diskConfig type. It is an extended attributed. | - | | | | - | | | - **MANUAL**: The image space cannot be expanded. | - | | | - **AUTO**: The image space on the system disk will be automatically expanded to keep the same as that set in the flavor. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | accessIPv4 | String | Discarded | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | accessIPv6 | String | Discarded | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | progress | String | Specifies the ECS creation progress. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the ECS metadata. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "rebuild" : { - "imageRef" : "3ed456f5-3d8f-4383-a6c9-312032afcd1a", - "name" : "rebuildName", - "metadata" : { - "rebuild" : "rebuild vm" - } - } - } - -Example Response ----------------- - -.. code-block:: - - { - "server": { - "tenant_id": "7459f9935ed2422eb9800fea1d4d9378", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://172.30.32.132:443/7459f9935ed2422eb9800fea1d4d9378/images/3ed456f5-3d8f-4383-a6c9-312032afcd1a" - } - ], - "id": "3ed456f5-3d8f-4383-a6c9-312032afcd1a" - }, - "accessIPv4": "", - "addresses": { - "443dd9e3-c165-4764-ad92-b17fcf12a3eb": [ - { - "addr": "192.168.0.119", - "version": 4 - } - ] - }, - "metadata": { - "name": "rebuildName" - }, - "accessIPv6": "", - "created": "2016-09-19T01:13:26Z", - "hostId": "fd16ebd9c2629e8595875cc1e1400fa67f392431d7937fcc9cf37671", - "adminPass": "qGVjnEjY3ZoY", - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://172.30.32.132:443/7459f9935ed2422eb9800fea1d4d9378/flavors/normal1" - } - ], - "id": "normal1" - }, - "OS-DCF:diskConfig": "MANUAL", - "user_id": "ed2965d80d394be0b41e56f50ac650ca", - "name": "rebuildName", - "progress": 0, - "links": [ - { - "rel": "self", - "href": "https://172.30.32.132:443/v2/7459f9935ed2422eb9800fea1d4d9378/servers/ea681a24-9b24-4f49-98ef-8e1f73acf19e" - }, - { - "rel": "bookmark", - "href": "https://172.30.32.132:443/7459f9935ed2422eb9800fea1d4d9378/servers/ea681a24-9b24-4f49-98ef-8e1f73acf19e" - } - ], - "id": "ea681a24-9b24-4f49-98ef-8e1f73acf19e", - "updated": "2016-09-19T07:22:05Z", - "status": "REBUILD" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/restarting_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/restarting_an_ecs.rst deleted file mode 100644 index e90240ef..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/restarting_an_ecs.rst +++ /dev/null @@ -1,89 +0,0 @@ -:original_name: en-us_topic_0020212650.html - -.. _en-us_topic_0020212650: - -Restarting an ECS -================= - -Function --------- - -This API is used to restart a single ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212650__table62669527: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212650__table37818817: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================================================================================+ - | reboot | Yes | Object | Specifies the operation to restart the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212650__table10346346162744: - -.. table:: **Table 3** **reboot** field description - - +-----------------+-----------------+-----------------+----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================+ - | type | Yes | String | Specifies the type of the restart operation. | - | | | | | - | | | | - **SOFT**: soft restart | - | | | | - **HARD**: forcible restart (hard restart) | - +-----------------+-----------------+-----------------+----------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "reboot": { - "type": "SOFT" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/rolling_back_ecs_specifications_modification.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/rolling_back_ecs_specifications_modification.rst deleted file mode 100644 index 74f6159d..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/rolling_back_ecs_specifications_modification.rst +++ /dev/null @@ -1,88 +0,0 @@ -:original_name: en-us_topic_0028714263.html - -.. _en-us_topic_0028714263: - -Rolling Back ECS Specifications Modification -============================================ - -Function --------- - -This API is used to roll back ECS specifications modification. - -Constraints ------------ - -After the rollback, the data modified during migration will be lost. - -Before calling this API, ensure that the ECS status (which can be queried using the API for querying details about the ECS) meets the following requirements: - -OS-EXT-STS:vm_state=resized - -OS-EXT-STS:task_state="" - -status=VERIFY_RESIZE - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0028714263__table60562285165259: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0028714263__table7412452165259: - -.. table:: **Table 2** Request parameters - - +--------------+-----------+------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+======+==============================================================+ - | revertResize | Yes | Null | Confirms the rollback of the ECS specification modification. | - +--------------+-----------+------+--------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "revertResize" : null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/starting_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/starting_an_ecs.rst deleted file mode 100644 index 37523578..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/starting_an_ecs.rst +++ /dev/null @@ -1,74 +0,0 @@ -:original_name: en-us_topic_0020212648.html - -.. _en-us_topic_0020212648: - -Starting an ECS -=============== - -Function --------- - -This API is used to start a single ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212648__table48630964: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212648__table48180537: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------+------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+======+========================================================================+ - | os-start | Yes | Null | Specifies the operation to start the ECS. The data structure is empty. | - +-----------+-----------+------+------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "os-start": {} - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/stopping_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/stopping_an_ecs.rst deleted file mode 100644 index ee2c6047..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/stopping_an_ecs.rst +++ /dev/null @@ -1,87 +0,0 @@ -:original_name: en-us_topic_0020212652.html - -.. _en-us_topic_0020212652: - -Stopping an ECS -=============== - -Function --------- - -This API is used to stop a single ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0020212652__table52155720: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0020212652__table54550461: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=========================================================================================================================+ - | os-stop | Yes | Object | Specifies the operation to stop the ECS. For details, see :ref:`Table 3 `. | - +-----------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0020212652__table10346346162744: - -.. table:: **Table 3** **os-stop** field description - - +-----------------+-----------------+-----------------+------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+============================================================+ - | type | No | String | Specifies an ECS stop type. The default value is **SOFT**. | - | | | | | - | | | | - **SOFT**: normal ECS stop | - | | | | - **HARD**: forcible ECS stop | - +-----------------+-----------------+-----------------+------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "os-stop": {} - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/status_management/unlocking_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/status_management/unlocking_an_ecs.rst deleted file mode 100644 index e3895b38..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/status_management/unlocking_an_ecs.rst +++ /dev/null @@ -1,77 +0,0 @@ -:original_name: en-us_topic_0065817691.html - -.. _en-us_topic_0065817691: - -Unlocking an ECS -================ - -Function --------- - -This API is used to unlock an ECS. - -After an ECS is unlocked, common users are allowed to manage the ECS. - -URI ---- - -POST /v2.1/{project_id}/servers/{server_id}/action - -POST /v2/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817691__en-us_topic_0057973176_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817691__en-us_topic_0057973176_table65978805: - -.. table:: **Table 2** Request parameters - - ========= ========= ==== =============== - Parameter Mandatory Type Description - ========= ========= ==== =============== - unlock Yes Null Unlocks an ECS. - ========= ========= ==== =============== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/servers/{server_id}/action - POST https://{endpoint}/v2.1/{project_id}/servers/{server_id}/action - -.. code-block:: - - { - "unlock": null - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_a_tag_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_a_tag_to_an_ecs.rst deleted file mode 100644 index 64d4c1e7..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_a_tag_to_an_ecs.rst +++ /dev/null @@ -1,107 +0,0 @@ -:original_name: en-us_topic_0065820825.html - -.. _en-us_topic_0065820825: - -Adding a Tag to an ECS -====================== - -This API is used to add a tag to an ECS. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -Constraints ------------ - -- The tag contains a maximum of 80 characters. -- A tag can only consist of digits, letters, hyphens (-), and underscores (_). -- A maximum of 50 tags can be added to an ECS. -- An empty tag cannot be created. - -URI ---- - -PUT /v2.1/{project_id}/servers/{server_id}/tags/{tag} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820825__en-us_topic_0057972840_table32475667: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+=====================================================================================================================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tag | Yes | Specifies the key of the tag to be added. | - | | | | - | | | For details about key rules, see :ref:`Tag Types `. | - | | | | - | | | .. note:: | - | | | | - | | | Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key". | - | | | | - | | | For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -.. table:: **Table 2** Response parameters - - ========= ====== ============================= - Parameter Type Description - ========= ====== ============================= - message String Example: "

\n\n\n" - code String Example: "201 Created" - title String Example: "Created" - ========= ====== ============================= - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag} - -Example Response ----------------- - -By default, the response is in HTML format. - -.. code-block:: - - - - 201 Created - - -

201 Created

-

- - - - - - -JSON format - -.. code-block:: - - { - "message": "

\n\n\n", - "code": "201 Created", - "title": "Created" - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_tags_to_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_tags_to_an_ecs.rst deleted file mode 100644 index 9b3f3738..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/adding_tags_to_an_ecs.rst +++ /dev/null @@ -1,94 +0,0 @@ -:original_name: en-us_topic_0065820823.html - -.. _en-us_topic_0065820823: - -Adding Tags to an ECS -===================== - -This API is used to add tags to an ECS. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -URI ---- - -PUT /v2.1/{project_id}/servers/{server_id}/tags - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820823__en-us_topic_0057972838_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065820823__en-us_topic_0057972838_table28387752: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+=======================================================================================+ - | tags | Yes | Array of strings | Specifies ECS tags. | - | | | | | - | | | | A maximum of 50 tags can be configured, and each tag can contain up to 80 characters. | - | | | | | - | | | | Can only consist of digits, letters, hyphens (-), and underscores (_). | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------+ - -Response --------- - -.. table:: **Table 3** Response parameters - - ========= ========= ================ =================== - Parameter Mandatory Type Description - ========= ========= ================ =================== - tags Yes Array of strings Specifies ECS tags. - ========= ========= ================ =================== - -.. table:: **Table 4** Reserved tag parameters - - ================= ==================================== - Tag Name Description - ================= ==================================== - \__type_baremetal Specifies that the server is a BMS. - \__type_virtual Specifies that the server is an ECS. - ================= ==================================== - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags - -.. code-block:: - - { - "tags": ["baz", "foo", "qux"] - } - -Example Response ----------------- - -.. code-block:: - - { - "tags": ["baz", "foo", "qux"] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_a_specified_tag_from_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_a_specified_tag_from_an_ecs.rst deleted file mode 100644 index 40158725..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_a_specified_tag_from_an_ecs.rst +++ /dev/null @@ -1,72 +0,0 @@ -:original_name: en-us_topic_0065820827.html - -.. _en-us_topic_0065820827: - -Deleting a Specified Tag from an ECS -==================================== - -This API is used to delete a specified tag from an ECS. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -Constraints ------------ - -- The tag contains a maximum of 80 characters. -- If a tag contains non-URL-safe characters, perform URL encoding. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/tags/{tag} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820827__en-us_topic_0057972842_table536172734712: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+===================================================================================================================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tag | Yes | Specifies the key of the tag to be deleted. If no key is specified, all tags of the ECS will be deleted. | - | | | | - | | | For details about key rules, see :ref:`Tag Types `. | - | | | | - | | | .. note:: | - | | | | - | | | Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", delete tags using "Key". | - | | | | - | | | For example, an existing tag is **a.b**. After the tag function upgrade, delete the tag using "a". | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_tags_from_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_tags_from_an_ecs.rst deleted file mode 100644 index 25dac7fd..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/deleting_tags_from_an_ecs.rst +++ /dev/null @@ -1,55 +0,0 @@ -:original_name: en-us_topic_0065820824.html - -.. _en-us_topic_0065820824: - -Deleting Tags from an ECS -========================= - -This API is used to delete all tags of an ECS. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -URI ---- - -DELETE /v2.1/{project_id}/servers/{server_id}/tags - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820824__en-us_topic_0057972839_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/index.rst deleted file mode 100644 index ff7b30f5..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _en-us_topic_0108433460: - -============== -Tag Management -============== - -.. toctree:: - :maxdepth: 1 - - tag_types - querying_tags_of_an_ecs - adding_tags_to_an_ecs - deleting_tags_from_an_ecs - adding_a_tag_to_an_ecs - querying_a_specified_tag_for_an_ecs - deleting_a_specified_tag_from_an_ecs diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_a_specified_tag_for_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_a_specified_tag_for_an_ecs.rst deleted file mode 100644 index a508a0b4..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_a_specified_tag_for_an_ecs.rst +++ /dev/null @@ -1,66 +0,0 @@ -:original_name: en-us_topic_0065820826.html - -.. _en-us_topic_0065820826: - -Querying a Specified Tag for an ECS -=================================== - -This API is used to query whether an ECS has a specified tag. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/tags/{tag} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820826__en-us_topic_0057972841_table32475667: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+=====================================================================================================================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | server_id | Yes | Specifies the ECS ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tag | Yes | Specifies the key of the tag to be queried. If no key is specified, all tags of the ECS will be displayed. | - | | | | - | | | For details about key rules, see :ref:`Tag Types `. | - | | | | - | | | .. note:: | - | | | | - | | | Tag functions have been upgraded on the public cloud. If the tags added before the function upgrade are in the format of "Key.Value", query tags using "Key". | - | | | | - | | | For example, an existing tag is "a.b". The tag can be queried in the format of "tag=a.b" before and in the format of "tag=a" now according to the new tag rules. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags/{tag} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_tags_of_an_ecs.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_tags_of_an_ecs.rst deleted file mode 100644 index 77c2c0c9..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/querying_tags_of_an_ecs.rst +++ /dev/null @@ -1,78 +0,0 @@ -:original_name: en-us_topic_0065820822.html - -.. _en-us_topic_0065820822: - -Querying Tags of an ECS -======================= - -This API is used to query all tags of an ECS. - -You are required to use the HTTP header **X-OpenStack-Nova-API-Version: 2.26** to specify the microversion on the client. - -URI ---- - -GET /v2.1/{project_id}/servers/{server_id}/tags - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820822__en-us_topic_0057972837_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065820822__en-us_topic_0057972838_table28387752: - -.. table:: **Table 2** Response parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================================+ - | tags | Array of strings | Specifies ECS tags. | - | | | | - | | | Tag functions have been upgraded on the public cloud. After the upgrade, the tag values returned by the system comply with the following rules: | - | | | | - | | | - The key and value of a tag are connected using an equal sign (=), for example, key=value. | - | | | - If the value is empty, only the key is returned. | - | | | | - | | | For more details about upgraded tag functions, see :ref:`Tag Types `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2.1/{project_id}/servers/{server_id}/tags - -Example Response ----------------- - -Example response - -.. code-block:: - - { - "tags": ["baz=xyy", "foo", "qux"] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tag_management/tag_types.rst b/ecs/api-ref/result/openstack_nova_apis/tag_management/tag_types.rst deleted file mode 100644 index 67aaf06c..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tag_management/tag_types.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: en-us_topic_0065817686.html - -.. _en-us_topic_0065817686: - -Tag Types -========= - -Tag functions have been upgraded on the platform. After the upgrade, a tag consists of a key and a value. Keys and values comply with the following rules: - -- For the tags created after the upgrade, all characters in **tags** are automatically used as a key, and the value is empty. Tags consist of only digits, letters, hyphens (-), and underscores (_). -- For the tags that have been created before the upgrade: - - - If no period (.) is used in **tags**, all characters in **tags** are used as a key, and the value is empty. - - If periods (.) are used in **tags**, the characters before the first period are used as a key and the characters after the first period are used as a value. - -After the tag function upgrade, tag management APIs are classified as the APIs for 1D tags and the APIs for 2D tags. - -- A 1D tag contains a string. All APIs for 1D tags are native OpenStack APIs. For details, see this section. -- A 2D tag consists of a key and a value. All APIs for 2D tags are ECS APIs. For details, see :ref:`Tag Management `. - -.. note:: - - - You are advised to use the APIs of the same type to add, delete, modify, or query tags. - - You are advised to use 2D tags. diff --git a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/index.rst b/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/index.rst deleted file mode 100644 index 5344133d..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0111860833: - -======================= -Tenant Quota Management -======================= - -.. toctree:: - :maxdepth: 1 - - querying_tenant_quota_limits - querying_tenant_quotas - querying_default_quotas diff --git a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_default_quotas.rst b/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_default_quotas.rst deleted file mode 100644 index 25aa68cd..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_default_quotas.rst +++ /dev/null @@ -1,140 +0,0 @@ -:original_name: en-us_topic_0065817716.html - -.. _en-us_topic_0065817716: - -Querying Default Quotas -======================= - -Function --------- - -This API is used to query default quotas. - -URI ---- - -GET /v2.1/{project_id}/os-quota-sets/{project_id}/defaults - -GET /v2/{project_id}/os-quota-sets/{project_id}/defaults - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817716__en-us_topic_0057973201_table258804192629: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817716__en-us_topic_0057973201_en-us_topic_0057973197_table62068690: - -.. table:: **Table 2** Response parameters - - +-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================================================+ - | quota_set | Object | Specifies the **quota_set** object. For details, see :ref:`Table 3 `. | - +-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817716__en-us_topic_0057973201_table29589013: - -.. table:: **Table 3** **quota_set** parameter description - - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+=========================================================================================+ - | cores | Integer | Specifies the quantity quota of vCPUs. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | fixed_ips | Integer | Specifies the quantity quota of fixed IP addresses. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | floating_ips | Integer | Specifies the quantity quota of floating IP addresses. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | id | String | Specifies the project UUID. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_file_content_bytes | Integer | Specifies the size quota (bytes) of the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.57 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_file_path_bytes | Integer | Specifies the size quota (bytes) of the path for the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.57 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_files | Integer | Specifies the quantity quota of the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.57 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | instances | Integer | Specifies the quantity quota of ECSs. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | key_pairs | Integer | Specifies the quota of key pairs. This parameter is not supported. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | metadata_items | Integer | Specifies the metadata quantity quota. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory quota (MB). | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | security_group_rules | Integer | Specifies the quota of security group rules. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | security_groups | Integer | Specifies the quota of security groups. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | server_groups | Integer | Specifies the quantity quota of ECS groups. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | server_group_members | Integer | Specifies the size quota of ECS groups. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e/defaults - GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e/defaults - -Example Response ----------------- - -.. code-block:: - - { - "quota_set": { - "injected_file_content_bytes": 10240, - "metadata_items": 128, - "server_group_members": 10, - "server_groups": 10, - "ram": 51200, - "floating_ips": 10, - "key_pairs": 100, - "injected_file_path_bytes": 255, - "instances": 10, - "security_group_rules": 20, - "injected_files": 5, - "cores": 20, - "fixed_ips": -1, - "id": "474eff20eee84b2e87b5717cc7f34dd8", - "security_groups": 10 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quota_limits.rst b/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quota_limits.rst deleted file mode 100644 index 0f623a48..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quota_limits.rst +++ /dev/null @@ -1,195 +0,0 @@ -:original_name: en-us_topic_0065817717.html - -.. _en-us_topic_0065817717: - -Querying Tenant Quota Limits -============================ - -Function --------- - -This API is used to query tenant quota limits. - -Tenants are only allowed to query their own quota limits. - -URI ---- - -GET /v2.1/{project_id}/limits?project_id={project_id} - -GET /v2/{project_id}/limits?project_id={project_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817717__en-us_topic_0057973197_table258804192629: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817717__en-us_topic_0057973197_table62068690: - -.. table:: **Table 2** Response parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==========================================================================================================================+ - | limits | Object | Specifies tenant limits. For details, see :ref:`Table 3 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817717__en-us_topic_0057973197_table35022095: - -.. table:: **Table 3** **limits** parameter information - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+================================================================================================================================+ - | rate | List | The value is empty. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | absolute | Object | Specifies tenant quota limits. For details, see :ref:`Table 4 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817717__en-us_topic_0057973197_table37171349: - -.. table:: **Table 4** **absolute** parameter information - - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+=================================================================+ - | maxServerMeta | String | Specifies the limit of ECS metadata quantity. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxPersonality | String | Specifies the quantity limit of injected files. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - | | | | - | | | This parameter is not supported in microversion 2.56 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalServerGroupsUsed | String | Specifies the number of used ECS groups. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxImageMeta | String | Specifies the limit of the image metadata quantity. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - | | | | - | | | This parameter is not supported in microversion 2.38 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxPersonalitySize | String | Specifies the size limit of injected files. | - | | | | - | | | If the value is **-1**, there is no size limit. | - | | | | - | | | This parameter is not supported in microversion 2.56 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxTotalRAMSize | String | Specifies the total memory size limit. | - | | | | - | | | If the value is **-1**, there is no size limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxTotalKeypairs | String | Specifies the limit of key pair quantity. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxSecurityGroupRules | String | Specifies the maximum number of security group rules. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - | | | | - | | | This parameter is not supported in microversion 2.35 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxServerGroups | String | Specifies the maximum number of ECS groups. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalCoresUsed | String | Specifies the number of used cores. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalRAMUsed | String | Specifies the size of used memory. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxSecurityGroups | String | Specifies the maximum number of security groups. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - | | | | - | | | This parameter is not supported in microversion 2.35 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalFloatingIpsUsed | String | Specifies the number of used floating IP addresses. | - | | | | - | | | This parameter is not supported in microversion 2.35 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalInstancesUsed | String | Specifies the number of used ECSs. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | totalSecurityGroupsUsed | String | Specifies the number of used security groups. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxTotalFloatingIps | String | Specifies the maximum number of floating IP addresses. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - | | | | - | | | This parameter is not supported in microversion 2.35 and later. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxTotalInstances | String | Specifies the maximum number of ECSs. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxTotalCores | String | Specifies the maximum number of cores. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - | maxServerGroupMembers | String | Specifies the maximum number of members in an ECS group. | - | | | | - | | | If the value is **-1**, there is no quantity limit. | - +-------------------------+-----------------------+-----------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/limits - GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/limits - -Example Response ----------------- - -.. code-block:: - - { - "limits": { - "rate": [], - "absolute": { - "maxServerMeta": 128, - "maxPersonality": 5, - "totalServerGroupsUsed": 0, - "maxImageMeta": 128, - "maxPersonalitySize": 10240, - "maxTotalRAMSize": 25165824, - "maxTotalKeypairs": -1, - "maxSecurityGroupRules": 20, - "maxServerGroups": -1, - "totalCoresUsed": 0, - "totalRAMUsed": 0, - "maxSecurityGroups": 10, - "totalFloatingIpsUsed": 0, - "totalInstancesUsed": 0, - "totalSecurityGroupsUsed": 0, - "maxTotalFloatingIps": 10, - "maxTotalInstances": 2048, - "maxTotalCores": 20480, - "maxServerGroupMembers": -1 - } - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quotas.rst b/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quotas.rst deleted file mode 100644 index 16e8e66e..00000000 --- a/ecs/api-ref/result/openstack_nova_apis/tenant_quota_management/querying_tenant_quotas.rst +++ /dev/null @@ -1,144 +0,0 @@ -:original_name: en-us_topic_0067298110.html - -.. _en-us_topic_0067298110: - -Querying Tenant Quotas -====================== - -Function --------- - -This API is used to query quotas, including ECSs, vCPUs, and memory. - -This API provides the **user_id** parameter for obtaining the quota configuration of a specified user. - -URI ---- - -GET /v2.1/{project_id}/os-quota-sets/{project_id}?user_id={user_id} - -GET /v2/{project_id}/os-quota-sets/{project_id}?user_id={user_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0067298110__en-us_topic_0057973199_table12637461156: - -.. table:: **Table 1** Parameter description - - +------------+-----------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +============+===========+=================================================================================================================+ - | project_id | Yes | Specifies the project ID. If the specified project does not exist, the default quota in the system is returned. | - +------------+-----------+-----------------------------------------------------------------------------------------------------------------+ - | user_id | No | Specifies the user ID. If the specified user does not exist, the default quota in the system is returned. | - +------------+-----------+-----------------------------------------------------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0067298110__en-us_topic_0057973199_en-us_topic_0057973197_table62068690: - -.. table:: **Table 2** Response parameters - - +-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================================================+ - | quota_set | Object | Specifies the **quota_set** object. For details, see :ref:`Table 3 `. | - +-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0067298110__en-us_topic_0057973199_table30231561: - -.. table:: **Table 3** **quota_set** parameter description - - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+=========================================================================================+ - | cores | Integer | Specifies the quantity quota of vCPUs. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | fixed_ips | Integer | Specifies the quantity quota of fixed IP addresses. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | floating_ips | Integer | Specifies the quantity quota of floating IP addresses. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | id | String | Specifies the project UUID. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_file_content_bytes | Integer | Specifies the size quota (bytes) of the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.56 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_file_path_bytes | Integer | Specifies the size quota (bytes) of the path for the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.56 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | injected_files | Integer | Specifies the quantity quota of the files to be injected. | - | | | | - | | | This parameter is not supported in microversion 2.56 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | instances | Integer | Specifies the quantity quota of ECSs. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | key_pairs | Integer | Specifies the quantity quota of key pairs. This parameter is not supported. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | metadata_items | Integer | Specifies the metadata quantity quota. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | ram | Integer | Specifies the memory quota (MB). | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | security_group_rules | Integer | Specifies the quota of security group rules. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | security_groups | Integer | Specifies the quantity quota of security groups. This parameter is not supported. | - | | | | - | | | This parameter is not supported in microversion 2.36 and later. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | server_groups | Integer | Specifies the quantity quota of ECS groups. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - | server_group_members | Integer | Specifies the size quota of ECS groups. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e - GET https://{endpoint}/v2.1/d9ebe43510414ef590a4aa158605329e/os-quota-sets/d9ebe43510414ef590a4aa158605329e - -Example Response ----------------- - -.. code-block:: - - { - "quota_set": { - "cores": 20, - "fixed_ips": 40, - "floating_ips": 10, - "id": "d9ebe43510414ef590a4aa158605329e", - "injected_file_content_bytes": 10240, - "injected_file_path_bytes": 255, - "injected_files": 5, - "instances": 20, - "key_pairs": 100, - "metadata_items": 128, - "ram": 51200, - "security_group_rules": 20, - "security_groups": 50, - "server_group_members": 10, - "server_groups": 10 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/creating_a_disk_discarded.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/creating_a_disk_discarded.rst deleted file mode 100644 index 4de6f988..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/creating_a_disk_discarded.rst +++ /dev/null @@ -1,169 +0,0 @@ -:original_name: en-us_topic_0065817708.html - -.. _en-us_topic_0065817708: - -Creating a Disk (Discarded) -=========================== - -Function --------- - -This API is used to create a disk. - -This API has been discarded. Use the EVS API "Creating EVS Disks (OpenStack Cinder API v2)". - -URI ---- - -POST /v2/{project_id}/os-volumes - -POST /v2.1/{project_id}/os-volumes - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817708__en-us_topic_0057973208_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817708__en-us_topic_0057973208_table34804632: - -.. table:: **Table 2** Request parameters - - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+=============================================================================+=================+===================================================================================================================================+ - | availability_zone | No | String | Specifies the AZ to which the volume to be created belongs. | - | | | | | - | | | | If the specified AZ does not exist, creating the volume failed, and the volume is in **error** state. | - | | | | | - | | | | The AZ to which the volume to be created belongs must be specified in the public cloud system. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | display_description | No | String | Specifies the volume description. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | snapshot_id | No | String | Specifies the snapshot ID. | - | | | | | - | | | | If this parameter is specified, the volume is to be created from a snapshot. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes (If the volume is created from a snapshot, this parameter is optional.) | Integer | Specifies the volume size. | - | | | | | - | | | | Unit: GB | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | display_name | No | String | Specifies the volume name. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | volume_type | No | String | Specifies the volume type. | - | | | | | - | | | | Currently, the value can be **SSD**, **SAS**, **SATA**, **co-p1**, or **uh-l1**. | - | | | | | - | | | | - **SSD**: specifies the ultra-I/O disk type. | - | | | | - **SAS**: specifies the high I/O disk type. | - | | | | - **SATA**: specifies the common I/O disk type. | - | | | | - **co-p1**: specifies the high I/O (performance-optimized I) disk type. | - | | | | - **uh-l1**: specifies the ultra-high I/O (latency-optimized) disk type. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | EVS disks of the **co-p1** and **uh-l1** types are used exclusively for high performance computing (HPC) and SAP HANA ECSs. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | Object | Specifies the volume metadata. | - +---------------------+-----------------------------------------------------------------------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0065817708__en-us_topic_0057973208_table36305920: - -.. table:: **Table 3** Response parameters - - +--------------------+------------------+-------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+=================================================+ - | id | String | Specifies the disk ID in UUID format. | - +--------------------+------------------+-------------------------------------------------+ - | displayName | String | Specifies the volume name. | - +--------------------+------------------+-------------------------------------------------+ - | status | String | Specifies the volume status. | - +--------------------+------------------+-------------------------------------------------+ - | attachments | Array of objects | Specifies the volume attachment information. | - +--------------------+------------------+-------------------------------------------------+ - | availabilityZone | String | Specifies the AZ to which the volume belongs. | - +--------------------+------------------+-------------------------------------------------+ - | createdAt | String | Specifies the time when the volume was created. | - +--------------------+------------------+-------------------------------------------------+ - | displayDescription | String | Specifies the volume description. | - +--------------------+------------------+-------------------------------------------------+ - | volumeType | String | Specifies the volume type. | - +--------------------+------------------+-------------------------------------------------+ - | snapshotId | String | Specifies the snapshot ID. | - +--------------------+------------------+-------------------------------------------------+ - | metadata | Object | Specifies the volume metadata. | - +--------------------+------------------+-------------------------------------------------+ - | size | Integer | Specifies the size of the volume. | - +--------------------+------------------+-------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes - POST https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes - -.. code-block:: - - { - "volume": { - "availability_zone": "az1-dc1", - "display_description": "test1", - "snapshot_id": null, - "size": 1, - "display_name": "test", - "volume_type": "SSD", - "metadata": { - "testkey": "testvalue" - } - } - } - -Example Response ----------------- - -.. code-block:: - - { - "volume": { - "displayDescription": "test1", - "volumeType": "SATA", - "createdAt": "2018-05-18T01:17:03.871808", - "metadata": { - "testkey": "testvalue", - "resourceSpecCode": "SATA" - }, - "attachments": [ - {} - ], - "snapshotId": null, - "size": 1, - "displayName": "test", - "id": "b4fb891c-c665-4478-92b0-8a7fa65a57cd", - "availabilityZone": "az1.dc1", - "status": "creating" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/deleting_a_disk_discarded.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/deleting_a_disk_discarded.rst deleted file mode 100644 index f6b9287d..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/deleting_a_disk_discarded.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0065817712.html - -.. _en-us_topic_0065817712: - -Deleting a Disk (Discarded) -=========================== - -Function --------- - -This API is used to delete a specified disk. - -This API has been discarded. Use the EVS API "Deleting an EVS Disk (OpenStack Cinder API v2)". - -Constraints ------------ - -- If the volume has a snapshot not deleted, the volume cannot be deleted. -- A volume that is being attached to an ECS cannot be deleted. -- A volume that is being migrated cannot be deleted. -- Only a volume in the available, error, error_restoring, or error_extending state can be deleted. - -URI ---- - -DELETE /v2/{project_id}/os-volumes/{volume_id} - -DELETE /v2.1/{project_id}/os-volumes/{volume_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817712__en-us_topic_0057973213_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - volume_id Yes Specifies the volume ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/0cf90bab-c513-46df-8559-45ba6de80e3f - DELETE https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/0cf90bab-c513-46df-8559-45ba6de80e3f - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/index.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/index.rst deleted file mode 100644 index 9b29edd8..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0267427881: - -===================================== -Disk Management (OpenStack Nova APIs) -===================================== - -.. toctree:: - :maxdepth: 1 - - querying_brief_information_about_disks_discarded - querying_detailed_information_about_disks_discarded - querying_information_about_a_disk_discarded - creating_a_disk_discarded - deleting_a_disk_discarded diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_brief_information_about_disks_discarded.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_brief_information_about_disks_discarded.rst deleted file mode 100644 index fbb68779..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_brief_information_about_disks_discarded.rst +++ /dev/null @@ -1,119 +0,0 @@ -:original_name: en-us_topic_0065817709.html - -.. _en-us_topic_0065817709: - -Querying Brief Information About Disks (Discarded) -================================================== - -Function --------- - -This API is used to query brief information about disks. - -This API has been discarded. Use the EVS API "Querying EVS Disks (OpenStack Cinder API v2)". - -URI ---- - -GET /v2/{project_id}/os-volumes - -GET /v2.1/{project_id}/os-volumes - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817709__en-us_topic_0057973209_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -N/A - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817709__en-us_topic_0057973209_table26952071: - -.. table:: **Table 2** Response parameters - - +--------------------+------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+====================================================+ - | id | String | Specifies the disk ID in UUID format. | - +--------------------+------------------+----------------------------------------------------+ - | displayName | String | Specifies the disk name. | - +--------------------+------------------+----------------------------------------------------+ - | status | String | Specifies the disk status. | - +--------------------+------------------+----------------------------------------------------+ - | attachments | Array of objects | Specifies the attachment information about a disk. | - +--------------------+------------------+----------------------------------------------------+ - | availabilityZone | String | Specifies the AZ to which the disk belongs. | - +--------------------+------------------+----------------------------------------------------+ - | createdAt | String | Specifies the time when the disk was created. | - +--------------------+------------------+----------------------------------------------------+ - | displayDescription | String | Specifies the disk description. | - +--------------------+------------------+----------------------------------------------------+ - | volumeType | String | Specifies the disk type. | - +--------------------+------------------+----------------------------------------------------+ - | snapshotId | String | Specifies the snapshot ID. | - +--------------------+------------------+----------------------------------------------------+ - | metadata | Object | Specifies the disk metadata. | - +--------------------+------------------+----------------------------------------------------+ - | size | Integer | Specifies the disk size. | - +--------------------+------------------+----------------------------------------------------+ - -.. table:: **Table 3** **attachments** field description - - ========= ====== ===================================================== - Parameter Type Description - ========= ====== ===================================================== - device String Specifies the directory to which the disk is mounted. - id String Specifies the ID of the attached resource. - serverId String Specifies the ECS ID. - volumeId String Specifies the ID of the attached disk. - ========= ====== ===================================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes - GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes - -Example Response ----------------- - -.. code-block:: - - { - "volumes": [ - { - "status": " available", - "attachments": [{}], - "availabilityZone": "nova", - "createdAt": "2016-05-20T07:57:56.299000", - "displayDescription": null, - "volumeType": null, - "dispalyName": "test", - "snapshotId": null, - "metadata": {}, - "id": "70b14513-faad-4646-b7ab-a065cef282b4", - "size": 1 - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_detailed_information_about_disks_discarded.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_detailed_information_about_disks_discarded.rst deleted file mode 100644 index dbfd328c..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_detailed_information_about_disks_discarded.rst +++ /dev/null @@ -1,119 +0,0 @@ -:original_name: en-us_topic_0065817710.html - -.. _en-us_topic_0065817710: - -Querying Detailed Information About Disks (Discarded) -===================================================== - -Function --------- - -This API is used to query detailed information about disks. - -This API has been discarded. Use the EVS API "Querying Details About All Disks (OpenStack Cinder API v2)". - -URI ---- - -GET /v2/{project_id}/os-volumes/detail - -GET /v2.1/{project_id}/os-volumes/detail - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817710__en-us_topic_0057973210_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -N/A - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817710__en-us_topic_0057973210_table20675657: - -.. table:: **Table 2** Response parameters - - +--------------------+------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+====================================================+ - | id | String | Specifies the disk ID in UUID format. | - +--------------------+------------------+----------------------------------------------------+ - | displayName | String | Specifies the disk name. | - +--------------------+------------------+----------------------------------------------------+ - | status | String | Specifies the disk status. | - +--------------------+------------------+----------------------------------------------------+ - | attachments | Array of objects | Specifies the attachment information about a disk. | - +--------------------+------------------+----------------------------------------------------+ - | availabilityZone | String | Specifies the AZ to which the disk belongs. | - +--------------------+------------------+----------------------------------------------------+ - | createdAt | String | Specifies the time when the disk was created. | - +--------------------+------------------+----------------------------------------------------+ - | displayDescription | String | Specifies the disk description. | - +--------------------+------------------+----------------------------------------------------+ - | volumeType | String | Specifies the disk type. | - +--------------------+------------------+----------------------------------------------------+ - | snapshotId | String | Specifies the snapshot ID. | - +--------------------+------------------+----------------------------------------------------+ - | metadata | Object | Specifies the disk metadata. | - +--------------------+------------------+----------------------------------------------------+ - | size | Integer | Specifies the disk size. | - +--------------------+------------------+----------------------------------------------------+ - -.. table:: **Table 3** **attachments** field description - - ========= ====== ===================================================== - Parameter Type Description - ========= ====== ===================================================== - device String Specifies the directory to which the disk is mounted. - id String Specifies the ID of the attached resource. - serverId String Specifies the ECS ID. - volumeId String Specifies the ID of the attached disk. - ========= ====== ===================================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/detail - GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/detail - -Example Response ----------------- - -.. code-block:: - - { - "volumes": [ - { - "status": "available", - "attachments": [{}], - "availabilityZone": "nova", - "createdAt": "2016-05-20T07:57:56.299000", - "displayDescription": null, - "volumeType": null, - "dispalyName": "test", - "snapshotId": null, - "metadata": {}, - "id": "70b14513-faad-4646-b7ab-a065cef282b4", - "size": 1 - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_information_about_a_disk_discarded.rst b/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_information_about_a_disk_discarded.rst deleted file mode 100644 index 2f246b22..00000000 --- a/ecs/api-ref/result/out-of-date_apis/disk_management_openstack_nova_apis/querying_information_about_a_disk_discarded.rst +++ /dev/null @@ -1,119 +0,0 @@ -:original_name: en-us_topic_0065817711.html - -.. _en-us_topic_0065817711: - -Querying Information About a Disk (Discarded) -============================================= - -Function --------- - -This API is used to query information about a specified disk. - -This API has been discarded. Use the EVS API "Querying Details About a Disk (OpenStack Cinder API v2)". - -URI ---- - -GET /v2/{project_id}/os-volumes/{volume_id} - -GET /v2.1/{project_id}/os-volumes/{volume_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817711__en-us_topic_0057973212_table2814978410562: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - volume_id Yes Specifies the disk ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817711__en-us_topic_0057973212_table27581142: - -.. table:: **Table 2** Response parameters - - +--------------------+------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +====================+==================+====================================================+ - | id | String | Specifies the disk ID in UUID format. | - +--------------------+------------------+----------------------------------------------------+ - | displayName | String | Specifies the disk name. | - +--------------------+------------------+----------------------------------------------------+ - | status | String | Specifies the disk status. | - +--------------------+------------------+----------------------------------------------------+ - | attachments | Array of objects | Specifies the attachment information about a disk. | - +--------------------+------------------+----------------------------------------------------+ - | availabilityZone | String | Specifies the AZ to which the disk belongs. | - +--------------------+------------------+----------------------------------------------------+ - | createdAt | String | Specifies the time when the disk was created. | - +--------------------+------------------+----------------------------------------------------+ - | displayDescription | String | Specifies the disk description. | - +--------------------+------------------+----------------------------------------------------+ - | volumeType | String | Specifies the disk type. | - +--------------------+------------------+----------------------------------------------------+ - | snapshotId | String | Specifies the snapshot ID. | - +--------------------+------------------+----------------------------------------------------+ - | metadata | Object | Specifies the disk metadata. | - +--------------------+------------------+----------------------------------------------------+ - | size | Integer | Specifies the disk size. | - +--------------------+------------------+----------------------------------------------------+ - -.. table:: **Table 3** **attachments** field description - - ========= ====== ===================================================== - Parameter Type Description - ========= ====== ===================================================== - device String Specifies the directory to which the disk is mounted. - id String Specifies the ID of the attached resource. - serverId String Specifies the ECS ID. - volumeId String Specifies the ID of the attached disk. - ========= ====== ===================================================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/70b14513-faad-4646-b7ab-a065cef282b4 - GET https://{endpoint}/v2.1/b84c367e4d1047fc9b54f28b400ddbc2/os-volumes/70b14513-faad-4646-b7ab-a065cef282b4 - -Example Response ----------------- - -.. code-block:: - - { - "volume": - { - "status": "available", - "attachments": [{}], - "availabilityZone": "nova", - "createdAt": "2016-05-20T07:57:56.299000", - "displayDescription": null, - "volumeType": null, - "dispalyName": "test", - "snapshotId": null, - "metadata": {}, - "id": "70b14513-faad-4646-b7ab-a065cef282b4", - "size": 1 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/assigning_a_floating_ip_address_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/assigning_a_floating_ip_address_discarded.rst deleted file mode 100644 index 126edab1..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/assigning_a_floating_ip_address_discarded.rst +++ /dev/null @@ -1,123 +0,0 @@ -:original_name: en-us_topic_0065820816.html - -.. _en-us_topic_0065820816: - -Assigning a Floating IP Address (Discarded) -=========================================== - -Function --------- - -This API is used to assign a floating IP address. - -This API has been discarded. Use the API described in "Assigning a Floating IP Address". - -Constraints ------------ - -You need to obtain a network resource pool that provides floating IP addresses. To do so, run **GET /v2.0/networks?router:external=True** or **neutron net-external-list**. - -URI ---- - -POST /v2/{project_id}/os-floating-ips - -POST /v2.1/{project_id}/os-floating-ips - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820816__en-us_topic_0057972670_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065820816__en-us_topic_0057972670_table62287048: - -.. table:: **Table 2** Request parameters - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +=================+=================+=================+=====================================================================================================================================+ - | tenant_id | String | Yes | Specifies the tenant ID specified in the URI. | - | | | | | - | | | | The value is in UUID format. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | pool | String | No | Specifies the network resource pool that provides floating IP addresses. If it is not specified, the default resource pool is used. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0065820816__en-us_topic_0057972670_table56026474: - -.. table:: **Table 3** Response parameters - - +-------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================================================================+ - | floating_ip | Yes | Object | Specifies the floating IP address. For details, see :ref:`Table 4 `. | - +-------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065820816__en-us_topic_0057972670_table55642234: - -.. table:: **Table 4** **floating_ip** objects - - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================+ - | fixed_ip | Yes | String | Specifies a private IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the floating IP address ID in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Specifies the ID of a bound ECS in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | ip | Yes | String | Specifies the floating IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | pool | Yes | String | Specifies the name of a network resource pool that provides floating IP addresses. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips - POST https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips - -.. code-block:: - - { - "pool": "external" - } - -Example Response ----------------- - -.. code-block:: - - { - "floating_ip": { - "id": "7aa2aa63-3097-4cfe-a2e4-596c301d3b1b", - "pool": "external", - "ip": "10.154.53.184", - "fixed_ip": null, - "instance_id": null - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/binding_a_floating_ip_address_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/binding_a_floating_ip_address_discarded.rst deleted file mode 100644 index 31334c86..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/binding_a_floating_ip_address_discarded.rst +++ /dev/null @@ -1,90 +0,0 @@ -:original_name: en-us_topic_0065817718.html - -.. _en-us_topic_0065817718: - -Binding a Floating IP Address (Discarded) -========================================= - -Function --------- - -This API is used to bind a floating IP address for an ECS. - -This API has been discarded. Since microversion 2.44, the system will return error 404 when you call this API. You are advised to use the VPC API "Updating a Floating IP Address". - -URI ---- - -POST /v2/{project_id}/servers/{server_id}/action - -POST /v2.1/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817718__en-us_topic_0057972997_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817718__en-us_topic_0057972997_table49322741: - -.. table:: **Table 2** Request parameter - - +---------------+-----------+--------+----------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+========+==========================================================+ - | addFloatingIp | Yes | Object | Specifies the floating IP address to be bound to an ECS. | - +---------------+-----------+--------+----------------------------------------------------------+ - -.. table:: **Table 3** **addFloatingIp** parameter information - - +---------------+-----------+--------+-------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+========+===============================================================================+ - | address | Yes | String | Specifies the floating IP address. | - +---------------+-----------+--------+-------------------------------------------------------------------------------+ - | fixed_address | No | String | Specifies the fixed IP address with which the floating IP address associates. | - +---------------+-----------+--------+-------------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - -.. code-block:: - - { - "addFloatingIp" : { - "address" : "10.144.2.1", - "fixed_address" : "192.168.1.3" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/index.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/index.rst deleted file mode 100644 index 64a9424a..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _en-us_topic_0065817682: - -==================================================== -Floating IP Address Management (OpenStack Nova APIs) -==================================================== - -.. toctree:: - :maxdepth: 1 - - binding_a_floating_ip_address_discarded - unbinding_a_floating_ip_address_discarded - assigning_a_floating_ip_address_discarded - querying_floating_ip_addresses_discarded - querying_details_about_a_floating_ip_address_discarded - releasing_a_floating_ip_address_discarded - querying_floating_ip_address_pools_discarded diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_details_about_a_floating_ip_address_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_details_about_a_floating_ip_address_discarded.rst deleted file mode 100644 index aef03b56..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_details_about_a_floating_ip_address_discarded.rst +++ /dev/null @@ -1,99 +0,0 @@ -:original_name: en-us_topic_0065820818.html - -.. _en-us_topic_0065820818: - -Querying Details About a Floating IP Address (Discarded) -======================================================== - -Function --------- - -This API is used to query the details about a floating IP address based on the ID of the IP address. - -This API has been discarded. Use the API described in "Querying a Floating IP Address". - -URI ---- - -GET /v2/{project_id}/os-floating-ips/{floating_ip_id} - -GET /v2.1/{project_id}/os-floating-ips/{floating_ip_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820818__en-us_topic_0057972673_table32475667: - -.. table:: **Table 1** Parameter description - - ============== ========= ============================================ - Parameter Mandatory Description - ============== ========= ============================================ - project_id Yes Specifies the project ID. - floating_ip_id Yes Specifies the ID of the floating IP address. - ============== ========= ============================================ - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065820818__en-us_topic_0057972673_table38246063: - -.. table:: **Table 2** Response parameters - - +-------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================================================================+ - | floating_ip | Yes | Object | Specifies the floating IP address. For details, see :ref:`Table 3 `. | - +-------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065820818__en-us_topic_0057972673_table65314517: - -.. table:: **Table 3** **floating_ip** objects - - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================+ - | fixed_ip | Yes | String | Specifies a private IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the floating IP address ID in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Specifies the ID of a bound ECS in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | ip | Yes | String | Specifies the floating IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | pool | Yes | String | Specifies the name of a network resource pool that provides floating IP addresses. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418 - GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418 - -Example Response ----------------- - -.. code-block:: - - { - "floating_ip":{ - "id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418", - "pool": "external", - "ip": "10.154.51.235", - "fixed_ip": "192.168.1.2", - "instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_address_pools_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_address_pools_discarded.rst deleted file mode 100644 index 833fd75f..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_address_pools_discarded.rst +++ /dev/null @@ -1,94 +0,0 @@ -:original_name: en-us_topic_0065820820.html - -.. _en-us_topic_0065820820: - -Querying Floating IP Address Pools (Discarded) -============================================== - -Function --------- - -This API is used to query floating IP address pools. - -There is only one network resource pool that can be queried through this API by tenants in Open Telekom Cloud live network environment. - -This API has been discarded. Use the API described in "Querying Networks". - -Constraints ------------ - -The API parameter is as follows: router:external=True - -.. code-block:: - - GET /networks?router:external=True //Name in the result is returned. - -URI ---- - -GET /v2/{project_id}/os-floating-ip-pools - -GET /v2.1/{project_id}/os-floating-ip-pools - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820820__en-us_topic_0057972835_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065820820__en-us_topic_0057972835_table54779151: - -.. table:: **Table 2** Response parameters - - +-------------------+-----------+------------------+-----------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+==================+=====================================================+ - | floating_ip_pools | Yes | Array of objects | Specifies the floating IP address pool. | - +-------------------+-----------+------------------+-----------------------------------------------------+ - | name | Yes | String | Specifies the name of the floating IP address pool. | - +-------------------+-----------+------------------+-----------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools - GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ip-pools - -Example Response ----------------- - -.. code-block:: - - { - "floating_ip_pools": [ - { - "name": "pool1" - }, - { - "name": "pool2" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_addresses_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_addresses_discarded.rst deleted file mode 100644 index acdb7100..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/querying_floating_ip_addresses_discarded.rst +++ /dev/null @@ -1,113 +0,0 @@ -:original_name: en-us_topic_0065820817.html - -.. _en-us_topic_0065820817: - -Querying Floating IP Addresses (Discarded) -========================================== - -Function --------- - -This API is used to query floating IP addresses. - -This API has been discarded. Use the API described in "Querying Floating IP Addresses". - -URI ---- - -GET /v2/{project_id}/os-floating-ips - -GET /v2.1/{project_id}/os-floating-ips - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820817__en-us_topic_0057972671_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065820817__en-us_topic_0057972671_table49535170: - -.. table:: **Table 2** Response parameters - - +--------------+-----------+------------------+--------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+==================+======================================+ - | floating_ips | Yes | Array of objects | Specifies the floating IP addresses. | - +--------------+-----------+------------------+--------------------------------------+ - -.. table:: **Table 3** **floating_ip** objects - - =========== ========= ====== ================================== - Parameter Mandatory Type Description - =========== ========= ====== ================================== - floating_ip Yes Object Specifies the floating IP address. - =========== ========= ====== ================================== - -.. table:: **Table 4** **floating_ip** attributes - - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================+ - | fixed_ip | Yes | String | Specifies a private IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the floating IP address ID in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Specifies the ID of a bound ECS in UUID format. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | ip | Yes | String | Specifies the floating IP address. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | pool | Yes | String | Specifies the name of a network resource pool that provides floating IP addresses. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips - GET https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips - -Example Response ----------------- - -.. code-block:: - - { - "floating_ips": [ - { - "id": "05f71f43-f3c9-47ef-ac8d-9f02aef66418", - "pool": "external", - "ip": "10.154.51.235", - "fixed_ip": "192.168.1.2", - "instance_id": "8b380f68-5057-4aa2-a33a-170b37218fa8" - }, - { - "id": "a25236cf-dd76-4adc-916a-f0b4a24048d3", - "pool": "external", - "ip": "10.154.51.237", - "fixed_ip": null, - "instance_id": null - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/releasing_a_floating_ip_address_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/releasing_a_floating_ip_address_discarded.rst deleted file mode 100644 index fbbe6f14..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/releasing_a_floating_ip_address_discarded.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0065820819.html - -.. _en-us_topic_0065820819: - -Releasing a Floating IP Address (Discarded) -=========================================== - -Function --------- - -This API is used to release a floating IP address. - -This API has been discarded. Use the API described in "Deleting a Floating IP Address". - -URI ---- - -DELETE /v2/{project_id}/os-floating-ips/{floating_ip_id} - -DELETE /v2.1/{project_id}/os-floating-ips/{floating_ip_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065820819__en-us_topic_0057972674_table32475667: - -.. table:: **Table 1** Parameter description - - ============== ========= ============================================ - Parameter Mandatory Description - ============== ========= ============================================ - project_id Yes Specifies the project ID. - floating_ip_id Yes Specifies the ID of the floating IP address. - ============== ========= ============================================ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418 - DELETE https://{endpoint}/v2.1/e73621affb8f44e1bc01898747ca09d4/os-floating-ips/05f71f43-f3c9-47ef-ac8d-9f02aef66418 - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/unbinding_a_floating_ip_address_discarded.rst b/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/unbinding_a_floating_ip_address_discarded.rst deleted file mode 100644 index 9a7c849d..00000000 --- a/ecs/api-ref/result/out-of-date_apis/floating_ip_address_management_openstack_nova_apis/unbinding_a_floating_ip_address_discarded.rst +++ /dev/null @@ -1,87 +0,0 @@ -:original_name: en-us_topic_0065817719.html - -.. _en-us_topic_0065817719: - -Unbinding a Floating IP Address (Discarded) -=========================================== - -Function --------- - -This API is used to unbind a floating IP address from an ECS. - -This API has been discarded. Since microversion 2.44, the system will return error 404 when you call this API. You are advised to use the VPC API "Updating a Floating IP Address". - -URI ---- - -POST /v2/{project_id}/servers/{server_id}/action - -POST /v2.1/{project_id}/servers/{server_id}/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817719__en-us_topic_0057973008_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817719__en-us_topic_0057973008_table20592177: - -.. table:: **Table 2** Request parameter - - +------------------+-----------+--------+--------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+===========+========+============================================+ - | removeFloatingIp | Yes | Object | Unbinds a floating IP address from an ECS. | - +------------------+-----------+--------+--------------------------------------------+ - -.. table:: **Table 3** **removeFloatingIp** parameter information - - ========= ========= ====== ================================== - Parameter Mandatory Type Description - ========= ========= ====== ================================== - address Yes String Specifies the floating IP address. - ========= ========= ====== ================================== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - POST https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/servers/47e9be4e-a7b9-471f-92d9-ffc83814e07a/action - -.. code-block:: - - { - "removeFloatingIp" : { - "address" : "10.144.2.1" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/associating_an_fpga_image_with_an_ecs_image.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/associating_an_fpga_image_with_an_ecs_image.rst deleted file mode 100644 index 6d57af22..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/associating_an_fpga_image_with_an_ecs_image.rst +++ /dev/null @@ -1,87 +0,0 @@ -:original_name: en-us_topic_0065962598.html - -.. _en-us_topic_0065962598: - -Associating an FPGA Image with an ECS Image -=========================================== - -Function --------- - -This API is used to create a mapping between an FPGA image and an ECS image. - -URI ---- - -POST /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065962598__table28107133211632: - -.. table:: **Table 1** Parameter description - - ============= ========= ============================ - Parameter Mandatory Description - ============= ========= ============================ - project_id Yes Specifies the project ID. - fpga_image_id Yes Specifies the FPGA image ID. - ============= ========= ============================ - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065962598__table41782128362: - -.. table:: **Table 2** Request parameters - - ========= ====== ========= ======================== - Parameter Type Mandatory Description - ========= ====== ========= ======================== - image Object Yes Specifies the ECS image. - ========= ====== ========= ======================== - -.. table:: **Table 3** **image** field description - - ========= ====== ========= =========================== - Parameter Type Mandatory Description - ========= ====== ========= =========================== - id String Yes Specifies the ECS image ID. - ========= ====== ========= =========================== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association - -.. code-block:: - - { - "image": { - "id": "18efee75-e058-4c52-a49c-9e3ba4d1c8de" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/deleting_an_fpga_image.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/deleting_an_fpga_image.rst deleted file mode 100644 index e8687f89..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/deleting_an_fpga_image.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0065962599.html - -.. _en-us_topic_0065962599: - -Deleting an FPGA Image -====================== - -Function --------- - -This API is used to delete an FPGA image. - -URI ---- - -DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065962599__table44329634211725: - -.. table:: **Table 1** Parameter description - - ============= ========= ============================ - Parameter Mandatory Description - ============= ========= ============================ - project_id Yes Specifies the project ID. - fpga_image_id Yes Specifies the FPGA image ID. - ============= ========= ============================ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/{fpga_image_id} - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/disassociating_an_fpga_image_from_an_ecs_image.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/disassociating_an_fpga_image_from_an_ecs_image.rst deleted file mode 100644 index ce52fba1..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/disassociating_an_fpga_image_from_an_ecs_image.rst +++ /dev/null @@ -1,87 +0,0 @@ -:original_name: en-us_topic_0081950549.html - -.. _en-us_topic_0081950549: - -Disassociating an FPGA Image from an ECS Image -============================================== - -Function --------- - -This API is used to delete a mapping between an FPGA image and an ECS image. - -URI ---- - -DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0081950549__table28107133211632: - -.. table:: **Table 1** Parameter description - - ============= ========= ============================ - Parameter Mandatory Description - ============= ========= ============================ - project_id Yes Specifies the project ID. - fpga_image_id Yes Specifies the FPGA image ID. - ============= ========= ============================ - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0081950549__table41782128362: - -.. table:: **Table 2** Request parameters - - ========= ====== ========= ======================== - Parameter Type Mandatory Description - ========= ====== ========= ======================== - image Object Yes Specifies the ECS image. - ========= ====== ========= ======================== - -.. table:: **Table 3** **image** field description - - ========= ====== ========= =========================== - Parameter Type Mandatory Description - ========= ====== ========= =========================== - id String Yes Specifies the ECS image ID. - ========= ====== ========= =========================== - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association - -.. code-block:: - - { - "image": { - "id": "18efee75-e058-4c52-a49c-9e3ba4d1c8de" - } - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/index.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/index.rst deleted file mode 100644 index b71e4e87..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0065962596: - -============================ -FPGA Logical File Management -============================ - -.. toctree:: - :maxdepth: 1 - - registering_an_fpga_image - deleting_an_fpga_image - viewing_details_of_fpga_images - associating_an_fpga_image_with_an_ecs_image - disassociating_an_fpga_image_from_an_ecs_image - querying_associations_between_an_fpga_image_and_an_ecs_image diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/querying_associations_between_an_fpga_image_and_an_ecs_image.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/querying_associations_between_an_fpga_image_and_an_ecs_image.rst deleted file mode 100644 index 821e2fc9..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/querying_associations_between_an_fpga_image_and_an_ecs_image.rst +++ /dev/null @@ -1,174 +0,0 @@ -:original_name: en-us_topic_0081950550.html - -.. _en-us_topic_0081950550: - -Querying Associations Between an FPGA Image and an ECS Image -============================================================ - -Function --------- - -This API is used to query associations that are available to a tenant and between an FPGA image and an ECS image. - -URI ---- - -GET /v1/{project_id}/cloudservers/fpga_image/associations?image_id={image_id}&fpga_image_id={fpga_image_id}&page={page}&size={size} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0081950550__table35325481211756: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+==========================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | image_id | No | Specifies the ECS image ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | fpga_image_id | No | Specifies the FPGA image ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | page | No | Specifies the number of pages in a pagination query. | - | | | | - | | | The value of this parameter must meet the following requirements: | - | | | | - | | | - Must be a decimal integer. | - | | | - Ranges from 1 (inclusive) to 65,535 (exclusive). | - | | | - Cannot contain **+**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | size | No | Specifies the maximum records displayed on a page in a pagination query. | - | | | | - | | | - Must be a decimal integer. | - | | | - Ranges from 1 (inclusive) to 100 (inclusive). | - | | | - Cannot contain **+**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - -.. note:: - - - You can obtain the association only after specifying either **fpga_image_id** or **image_id**. Otherwise, only one empty list is returned. - - Pagination query takes effect only if parameters **page** and **size** both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed. If both **image_id** and **fpga_image_id** are used, pagination query specified by **page** and **size** does not take effect. - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0081950550__table41782128362: - -.. table:: **Table 2** Response parameters - - ============ ================ =============================== - Parameter Type Description - ============ ================ =============================== - associations Array of objects Specifies queried associations. - ============ ================ =============================== - -.. table:: **Table 3** **associations** field description - - ========== ================ ============================================ - Parameter Type Description - ========== ================ ============================================ - image_id String Specifies the ECS ID. - fpgaimages Array of objects Specifies details of associated FPGA images. - ========== ================ ============================================ - -.. table:: **Table 4** **fpgaimages** field description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | id | String | Specifies the FPGA image ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the FPGA image name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the FPGA image. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the FPGA image status. Options: | - | | | | - | | | - **active**: indicates that the FPGA image is available for use. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Integer | Specifies the size (MB) of the FPGA image file. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | createdAt | String | Specifies the time when the FPGA image was created. | - | | | | - | | | UTC time is used. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protected | Boolean | Specifies whether an FPGA image is protected. | - | | | | - | | | If an FPGA image is protected, it is associated with an image used to create ECSs and cannot be deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Specifies the FPGA image supplementation. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the FPGA image metadata. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_directory | String | Specifies the directory, in the format of "Bucket name:Directory", in which the log file for constructing the FPGA image is stored in OBS, for example, "obs-fpga:vu9p/log". | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/associations - -Example Response ----------------- - -.. code-block:: - - { - "associations": [ - { - "image_id": "89e38a0a-de83-4f3d-83b9-a2df2c605487", - "fpgaimages": [ - { - "id": "4010a32b5f231f04015f24259efd0429", - "name": "relate-test", - "description": "relate-test", - "status": "active", - "size": 40, - "createdAt": "2017-10-16 07:46:06", - "protected": true, - "message": null, - "metadata": { - "shell_type": "OCL", - "shell_version": "1.0" - }, - "log_directory": "obs-fpga:vu9p/log" - }, - { - "id": "4010a32b5f231f04015f23f0c07c041a", - "name": "name123", - "description": "desc123", - "status": "active", - "size": 60, - "createdAt": "2017-10-16 06:48:21", - "protected": true, - "message": null, - "metadata": { - "shell_type": "OCL", - "shell_version": "1.0" - }, - "log_directory": "obs-fpga:vu9p/log" - } - ] - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/registering_an_fpga_image.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/registering_an_fpga_image.rst deleted file mode 100644 index 766f05ce..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/registering_an_fpga_image.rst +++ /dev/null @@ -1,153 +0,0 @@ -:original_name: en-us_topic_0065962597.html - -.. _en-us_topic_0065962597: - -Registering an FPGA Image -========================= - -Function --------- - -This API is used to register an FPGA image. - -An FPGA image, which is also called accelerated engine image (AEI), is a logic FPGA file developed by a user. During FPGA image registration, the logic file must be stored in the Object Storage Service (OBS) bucket of the user. - -URI ---- - -POST /v1/{project_id}/cloudservers/fpga_image - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065962597__table10080802211311: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065962597__table5698154011375: - -.. table:: **Table 2** Request parameters - - ========== ====== ========= ====================================== - Parameter Type Mandatory Description - ========== ====== ========= ====================================== - fpga_image Object Yes Indicates details about an FPGA image. - ========== ====== ========= ====================================== - -.. table:: **Table 3** **fpga_image** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Mandatory | Description | - +=================+=================+=================+===================================================================================================================================================================================================+ - | location | String | Yes | Specifies the OBS bucket path in which the logic FPGA file is stored. The format of the path is "Bucket name:File name", for example, "obs-fpga:fpga.bin". | - | | | | | - | | | | Bucket naming rules comply with the following OBS requirements: | - | | | | | - | | | | - Consists of lowercase letters, digits, and special characters **.** and **-**. | - | | | | - Must start and end with a digit or letter. | - | | | | - Contains 3 to 63 characters. | - | | | | - Cannot be an IP address. | - | | | | - Cannot contain **..**, **.-**, or **-.**. | - | | | | | - | | | | A file name must conform to the following rules: | - | | | | | - | | | | - Consists of uppercase and lowercase letters, digits, hyphens (-), underscores (_), slashes (/), and periods (.). | - | | | | - Must end with **.bin** or **xclbin**. | - | | | | - Contains 4 to 64 characters. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Yes | Specifies the name of the FPGA image. | - | | | | | - | | | | Value range: | - | | | | | - | | | | - Contains only letters, digits, underscores, and hyphens. | - | | | | - Contains 1 to 64 characters. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Yes | Specifies the FPGA image metadata, which must be a valid JavaScript Object Notation (JSON) object. | - | | | | | - | | | | The number of characters in metadata after JSON serialization cannot exceed 1024. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | No | Describes an FPGA image. The value consists of uppercase and lowercase letters, digits, hyphens (-), underscores (_), periods (.), commas, and spaces. The value consists of 0 to 255 characters. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065962597__table551653634018: - -.. table:: **Table 4** Response parameters - - ========== ====== ====================================== - Parameter Type Description - ========== ====== ====================================== - fpga_image Object Indicates details about an FPGA image. - ========== ====== ====================================== - -.. table:: **Table 5** **fpga_image** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================+ - | id | String | ID of an FPGA image | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - | status | String | Specifies the FPGA image status. Options: | - | | | | - | | | - **saving**: indicates that the FPGA image file is being uploaded to the backend storage. | - | | | - **deleting**: indicates that the FPGA image is being deleted. | - | | | - **error**: indicates that creating the FPGA image failed. | - | | | - **active**: indicates that the FPGA image is available for use. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/cloudservers/fpga_image - -.. code-block:: - - { - "fpga_image": { - "location": "obs-fpga:fpga.bin", - "name": "fpga-image-test", - "description": "fpga description", - "metadata": { - "shell_type": "OCL", - "shell_version": "1.0" - } - } - } - -Example Response ----------------- - -.. code-block:: - - { - "fpga_image": { - "status": "saving", - "id": "4010a32c5c62bad9015c62dc2290002b" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/viewing_details_of_fpga_images.rst b/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/viewing_details_of_fpga_images.rst deleted file mode 100644 index b1e63c4d..00000000 --- a/ecs/api-ref/result/out-of-date_apis/fpga_logical_file_management/viewing_details_of_fpga_images.rst +++ /dev/null @@ -1,167 +0,0 @@ -:original_name: en-us_topic_0065962600.html - -.. _en-us_topic_0065962600: - -Viewing Details of FPGA Images -============================== - -Function --------- - -This API is used to view the details of the FPGA images of a tenant. - -URI ---- - -GET /v1/{project_id}/cloudservers/fpga_image/detail?fpga_image_id={fpga_image_id}&page={page}&size={size} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065962600__table972014396283: - -.. table:: **Table 1** Parameter description - - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+==========================================================================+ - | project_id | Yes | Specifies the project ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | fpga_image_id | No | Specifies the FPGA image ID. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | page | No | Specifies the number of pages in a pagination query. | - | | | | - | | | The value of this parameter must meet the following requirements: | - | | | | - | | | - Must be a decimal integer. | - | | | - Ranges from 1 (inclusive) to 65,535 (exclusive). | - | | | - Cannot contain **+**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - | size | No | Specifies the maximum records displayed on a page in a pagination query. | - | | | | - | | | - Must be a decimal integer. | - | | | - Ranges from 1 (inclusive) to 100 (inclusive). | - | | | - Cannot contain **+**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------+ - -.. note:: - - - Pagination query takes effect only if parameters **page** and **size** both have a value. If only one of them has a value, an error message indicating invalid parameter will be displayed. - - If **fpga_image_id** is used, pagination query specified by **page** and **size** does not take effect. - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065962600__table41782128362: - -.. table:: **Table 2** Response parameters - - +------------+------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +============+==================+====================================================+ - | count | Integer | Specifies the number of FPGA images to be queried. | - +------------+------------------+----------------------------------------------------+ - | fpgaimages | Array of objects | Specifies details of FPGA images. | - +------------+------------------+----------------------------------------------------+ - -.. table:: **Table 3** **fpgaimages** field description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | id | String | Specifies the FPGA image ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the FPGA image name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Describes the FPGA image. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the FPGA image status. Options: | - | | | | - | | | - **initialing**: indicates that the task of creating an FPGA image is being initialized. | - | | | - **scheduling**: indicates that the task of creating an FPGA image is waiting for scheduling. | - | | | - **creating**: indicates that the FPGA image is being created. | - | | | - **saving**: indicates that the FPGA image file is being uploaded to the backend storage. | - | | | - **deleting**: indicates that the FPGA image is being deleted. | - | | | - **error**: indicates that creating the FPGA image failed. | - | | | - **active**: indicates that the FPGA image is available for use. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Integer | Specifies the size (MB) of the FPGA image file. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | createdAt | String | Specifies the time when the FPGA image was created. | - | | | | - | | | Coordinated Universal Time (UTC) time is used. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protected | Boolean | Specifies whether an FPGA image is protected. | - | | | | - | | | If an FPGA image is protected, it is associated with an image used to create ECSs and cannot be deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Specifies the FPGA image supplementation. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the FPGA image metadata. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_directory | String | Specifies the directory, in the format of "Bucket name:Directory", in which the log file for constructing the FPGA image is stored in OBS, for example, "obs-fpga:vu9p/log". | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/cloudservers/fpga_image/detail - -Example Response ----------------- - -.. code-block:: - - { - "count": 2, - "fpgaimages": [ - { - "id": "4010a32c5c7d7711015c81ac714c009d", - "name": "FPGA001", - "description": "fpga test", - "status": "active", - "size": 40, - "createdAt": "2017-06-07 08:29:41", - "protected": false, - "message": null, - "metadata": { - "shell_type": "OCL", - "shell_version": "1.0" - }, - "log_directory": "obs-fpga:vu9p/log" - }, - { - "id": "4010a32c5c7d7711015c813e69bd002c", - "name": "FPGA002", - "description": "fpga test", - "status": "active", - "size": 43, - "createdAt": "2017-06-07 16:29:30", - "protected": true, - "message": null, - "metadata": { - "shell_type": "OCL", - "shell_version": "1.0" - }, - "log_directory": "obs-fpga:vu9p/log" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/deleting_an_image_discarded.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/deleting_an_image_discarded.rst deleted file mode 100644 index 319acdbd..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/deleting_an_image_discarded.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0065817699.html - -.. _en-us_topic_0065817699: - -Deleting an Image (Discarded) -============================= - -Function --------- - -This API is used to delete a specified image. The image cannot be restored after being deleted. - -This API has been discarded. Use the API described in "Deleting an Image (Native OpenStack API)". - -URI ---- - -DELETE /v2/{project_id}/images/{image_id} - -DELETE /v2.1/{project_id}/images/{image_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817699__table148747347424: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - image_id Yes Specifies the image ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images/6cad483b-e281-4985-a345-7afef1f3c5b7 - DELETE https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images/6cad483b-e281-4985-a345-7afef1f3c5b7 - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/index.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/index.rst deleted file mode 100644 index 7903b412..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0065817680: - -====================================== -Image Management (OpenStack Nova APIs) -====================================== - -.. toctree:: - :maxdepth: 1 - - querying_images_discarded - querying_image_details_discarded - querying_details_about_a_specified_image_discarded - querying_the_metadata_of_a_specified_image_discarded - deleting_an_image_discarded diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_details_about_a_specified_image_discarded.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_details_about_a_specified_image_discarded.rst deleted file mode 100644 index 4de24a34..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_details_about_a_specified_image_discarded.rst +++ /dev/null @@ -1,145 +0,0 @@ -:original_name: en-us_topic_0065817697.html - -.. _en-us_topic_0065817697: - -Querying Details About a Specified Image (Discarded) -==================================================== - -Function --------- - -This API is used to query the details about the specified image. - -This API has been discarded. Use the API described in "Querying Images (Native OpenStack API)". - -URI ---- - -GET /v2/{project_id}/images/{image_id} - -GET /v2.1/{project_id}/images/{image_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817697__table105393143396: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - image_id Yes Specifies the image ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817697__table128661753193915: - -.. table:: **Table 2** Response parameters - - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================+==================+======================================================================================================+ - | id | String | Specifies the image ID in UUID format. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | links | Array of objects | Specifies the shortcut link of the image. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the image name. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | metadata | Object | Specifies the key pair of the metadata. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | OS-EXT-IMG-SIZE:size | Integer | Specifies the image size. The value must be greater than zero. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | minDisk | Integer | Specifies the minimum disk size in GB required by the image. The value must be greater than zero. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | minRam | Integer | Specifies the minimum memory size in GB required by the image. The value must be greater than zero. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | progress | Integer | Specifies the image upload progress. The value must be greater than zero. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | status | String | Specifies the image status. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | created | String | Specifies the image creation time. The value is in ISO8601 format, such as **2013-06-09T06:42:18Z**. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - | updated | String | Specifies the image update time. The value is in ISO8601 format, such as **2013-06-09T06:42:18Z**. | - +----------------------+------------------+------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **links** parameter description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================+ - | href | Yes | String | Specifies the link of the corresponding resource. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rel | Yes | String | The value can be: | - | | | | | - | | | | - **self**: A self link contains a version link to the resource. Use these links when the link is followed immediately. | - | | | | - **bookmark**: A bookmark link provides a permanent link to a resource, which is suitable for long term storage. | - | | | | - **alternate**: An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image may have an alternate representation in the OpenStack image service. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | The type attribute provides a hint as to the type of representation to expect when following the link. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988 - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988 - -Example Response ----------------- - -.. code-block:: - - { - "image": { - "status": "ACTIVE", - "updated": "2015-12-27T02:52:25Z", - "name": "cirror", - "links": [ - { - "href": "https://compute.localdomain.com:8001/v2/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988", - "rel": "self" - }, - { - "href": "https://compute.localdomain.com:8001/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988", - "rel": "bookmark" - }, - { - "href": "https://https://image.az2.dc1.domainname.com:443/719e9483f42d4784a089862ac4c3e8d0/images/17a1890b-0fa4-485e-8505-14e294017988", - "type": "application/vnd.openstack.image", - "rel": "alternate" - } - ], - "created": "2015-12-27T02:52:24Z", - "minDisk": 0, - "progress": 100, - "minRam": 0, - "metadata": { - "__os_version": "CentOS 4.4 32bit", - "file_format": "img", - "file_name": "**.img", - "describe": "", - "__os_type": "Linux", - "virtual_env_type": "KVM", - "hw_disk_bus": "scsi" - }, - "id": "17a1890b-0fa4-485e-8505-14e294017988", - "OS-EXT-IMG-SIZE:size": 13167616 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_image_details_discarded.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_image_details_discarded.rst deleted file mode 100644 index c66be8bf..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_image_details_discarded.rst +++ /dev/null @@ -1,216 +0,0 @@ -:original_name: en-us_topic_0065817696.html - -.. _en-us_topic_0065817696: - -Querying Image Details (Discarded) -================================== - -Function --------- - -This API is used to query detailed information about an image list. - -This API has been discarded. Use the API described in "Querying Images (Native OpenStack API)". - -URI ---- - -GET /v2/{project_id}/images/detail?name={name}&status={status}&changes-since={changes-since}&minRam={minRam}&minDisk={inDisk} - -GET /v2.1/{project_id}/images/detail?name={name}&status={status}&changes-since={changes-since}&minRam={minRam}&minDisk={inDisk} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817696__table2497448193514: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Parameters in the following table can be used as URI parameters to filter query results. Usage: /v2/{tenant_id}/images/detail? name ={name}&status={status} - -:ref:`Table 2 ` describes the query parameters. - -.. _en-us_topic_0065817696__table8153553113616: - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================================================================================================================================================================================+ - | name | No | String | Specifies the image name. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the image status. | - | | | | | - | | | | You cannot query images when the value is set to **deleted**. The value depends on the status in Glance. :ref:`Table 3 ` shows the mapping relationship of image status in Nova and Glance. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | changes-since | No | String | Specifies the images modified after the **changes-since** time point. The value is in ISO8601 format, such as **2013-06-09T06:42:18Z**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minRam | No | Integer | Specifies the minimum memory size in MB required by the image. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minDisk | No | Integer | Specifies the minimum disk size in GB required by the image. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817696__table84817387373: - -.. table:: **Table 3** Mapping relationship of image status in Nova and Glance - - ====================== ==================== - Image Status in Glance Image Status in Nova - ====================== ==================== - queued saving - saving saving - active active - deleted deleted - ====================== ==================== - -Request -------- - -None - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817696__table510182515381: - -.. table:: **Table 4** Response parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===================================================================+ - | id | String | Specifies the image ID in UUID format. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | links | Array of objects | Specifies the shortcut link of the image. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | name | String | Specifies the image name. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | metadata | Object | Specifies the key pair of the metadata. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | OS-EXT-IMG-SIZE:size | Integer | Specifies the image size. | - | | | | - | | | The value must be greater than zero. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | minDisk | Integer | Specifies the minimum disk size in GB required by the image. | - | | | | - | | | The value must be greater than zero. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | minRam | Integer | Specifies the minimum memory size in GB required by the image. | - | | | | - | | | The value must be greater than zero. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | progress | Integer | Specifies the image upload progress. | - | | | | - | | | The value must be greater than zero. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | status | String | Specifies the image status. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | created | String | Specifies the image creation time. | - | | | | - | | | The value is in ISO8601 format, such as **2013-06-09T06:42:18Z**. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - | updated | String | Specifies the image update time. | - | | | | - | | | The value is in ISO8601 format, such as **2013-06-09T06:42:18Z**. | - +-----------------------+-----------------------+-------------------------------------------------------------------+ - -.. table:: **Table 5** **links** parameter description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================+ - | href | Yes | String | Specifies the link of the corresponding resource. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rel | Yes | String | The value can be: | - | | | | | - | | | | - **self**: A self link contains a version link to the resource. Use these links when the link is followed immediately. | - | | | | - **bookmark**: A bookmark link provides a permanent link to a resource, which is suitable for long term storage. | - | | | | - **alternate**: An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image may have an alternate representation in the OpenStack image service. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | The type attribute provides a hint as to the type of representation to expect when following the link. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images/detail - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images/detail - -Example Response ----------------- - -.. code-block:: - - { - "image": { - "OS-EXT-IMG-SIZE:size": 20578304, - "created": "2014-02-10T17:05:01Z", - "id": "ee10f19c-503c-44af-af2f-73d5e42f7a17", - "links": [ - { - "href": "http://172.25.150.84:8774/v2/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "self" - }, - { - "href": "http://172.25.150.84:8774/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "bookmark" - }, - { - "href": "http://172.25.150.84:9292/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "alternate", - "type": "application/vnd.openstack.image" - } - ], - "metadata": { - "clean_attempts": "3", - "image_location": "snapshot", - "image_state": "available", - "image_type": "snapshot", - "instance_type_ephemeral_gb": "0", - "instance_type_flavorid": "6", - "instance_type_id": "7", - "instance_type_memory_mb": "256", - "instance_type_name": "wj.ssd", - "instance_type_root_gb": "2", - "instance_type_rxtx_factor": "1.0", - "instance_type_swap": "0", - "instance_type_vcpus": "1", - "instance_uuid": "b600b5b1-ed8c-4814-aefa-8b903c894c20", - "os_type": "None", - "owner_id": "d9ebe43510414ef590a4aa158605329e", - "user_id": "74fe4ff0674b434b8a274077d8106c5b" - }, - "minDisk": 2, - "minRam": 0, - "name": "image1", - "progress": 100, - "server": { - "id": "b600b5b1-ed8c-4814-aefa-8b903c894c20", - "links": [ - { - "href": "http://172.25.150.84:8774/v2/d9ebe43510414ef590a4aa158605329e/servers/b600b5b1-ed8c-4814-aefa-8b903c894c20", - "rel": "self" - }, - { - "href": "http://172.25.150.84:8774/d9ebe43510414ef590a4aa158605329e/servers/b600b5b1-ed8c-4814-aefa-8b903c894c20", - "rel": "bookmark" - } - ] - }, - "status": "ACTIVE", - "updated": "2014-02-10T17:05:07Z" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_images_discarded.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_images_discarded.rst deleted file mode 100644 index 11d3a128..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_images_discarded.rst +++ /dev/null @@ -1,171 +0,0 @@ -:original_name: en-us_topic_0065817695.html - -.. _en-us_topic_0065817695: - -Querying Images (Discarded) -=========================== - -Function --------- - -This API is used to query all images. - -This API has been discarded. Use the API described in "Querying Images (Native OpenStack API)". - -URI ---- - -GET /v2/{project_id}/images?name={name}&status={status}&changes-since={changes-since}&minRam={minRam}&minDisk={inDisk} - -GET /v2.1/{project_id}/images?name={name}&status={status}&changes-since={changes-since}&minRam={minRam}&minDisk={inDisk} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817695__table15332113010326: - -.. table:: **Table 1** Path parameters - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Parameters in the following table can be used as URI parameters to filter query results. Usage: /v2/{project_id}/images? name ={name}&status={status} - -:ref:`Table 2 ` describes the query parameters. - -.. _en-us_topic_0065817695__table21481517103310: - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=========================================================================================================================================================================================================================================+ - | name | No | String | Specifies the image name. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Specifies the image status. | - | | | | | - | | | | You cannot query images when the value is set to **deleted**. The value depends on the status in Glance. :ref:`Table 3 ` shows the mapping relationship of image status in Nova and Glance. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | changes-since | No | String | Specifies the images modified after the **changes-since** time point. The parameter is in ISO 8601 time format, for example, 2013-06-09T06:42:18Z. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minRam | No | Integer | Specifies the minimum memory size in MB required by the image. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | minDisk | No | Integer | Specifies the minimum disk size in GB required by the image. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817695__table7740622133418: - -.. table:: **Table 3** Mapping relationship of image status in Nova and Glance - - ====================== ==================== - Image Status in Glance Image Status in Nova - ====================== ==================== - queued saving - saving saving - active active - deleted deleted - ====================== ==================== - -Request -------- - -None - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817695__table199957019352: - -.. table:: **Table 4** Response parameters - - +--------------+-----------+------------------+-------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+==================+===============================================================================+ - | images | Yes | Array of objects | Specifies the image information. | - +--------------+-----------+------------------+-------------------------------------------------------------------------------+ - | images_links | No | Array of objects | Specifies the information about the next page when you query images in pages. | - +--------------+-----------+------------------+-------------------------------------------------------------------------------+ - -.. table:: **Table 5** **images** information - - +-----------+-----------+------------------+-------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+===========================================+ - | id | Yes | String | Specifies the image ID in UUID format. | - +-----------+-----------+------------------+-------------------------------------------+ - | links | Yes | Array of objects | Specifies the shortcut link of the image. | - +-----------+-----------+------------------+-------------------------------------------+ - | name | Yes | String | Specifies the image name. | - +-----------+-----------+------------------+-------------------------------------------+ - -.. table:: **Table 6** **images_links** parameters - - +-----------+-----------+--------+--------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+====================================================================+ - | href | Yes | String | Specifies the URL of the next page when you query images in pages. | - +-----------+-----------+--------+--------------------------------------------------------------------+ - | rel | Yes | String | Specifies the query direction when you query images in pages. | - +-----------+-----------+--------+--------------------------------------------------------------------+ - -.. table:: **Table 7** **links** parameter description - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================+ - | href | Yes | String | Specifies the link of the corresponding resource. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rel | Yes | String | The value can be: | - | | | | | - | | | | - **self**: A self link contains a version link to the resource. Use these links when the link is followed immediately. | - | | | | - **bookmark**: A bookmark link provides a permanent link to a resource, which is suitable for long term storage. | - | | | | - **alternate**: An alternate link can contain an alternate representation of the resource. For example, an OpenStack Compute image may have an alternate representation in the OpenStack image service. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | The type attribute provides a hint as to the type of representation to expect when following the link. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images - -Example Response ----------------- - -.. code-block:: - - { - "images": [ - { - "id": "ee10f19c-503c-44af-af2f-73d5e42f7a17", - "links": [ - { - "href": "http://172.25.150.84:8774/v2/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "self" - }, - { - "href": "http://172.25.150.84:8774/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "bookmark" - }, - { - "href": "http://172.25.150.84:9292/d9ebe43510414ef590a4aa158605329e/images/ee10f19c-503c-44af-af2f-73d5e42f7a17", - "rel": "alternate", - "type": "application/vnd.openstack.image" - } - ], - "name": "image1" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_the_metadata_of_a_specified_image_discarded.rst b/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_the_metadata_of_a_specified_image_discarded.rst deleted file mode 100644 index 4d0f80d2..00000000 --- a/ecs/api-ref/result/out-of-date_apis/image_management_openstack_nova_apis/querying_the_metadata_of_a_specified_image_discarded.rst +++ /dev/null @@ -1,86 +0,0 @@ -:original_name: en-us_topic_0065817698.html - -.. _en-us_topic_0065817698: - -Querying the Metadata of a Specified Image (Discarded) -====================================================== - -Function --------- - -This API is used to query the metadata of the specified image. - -This API has been discarded. Use the API described in "Querying Image Metadata (Native OpenStack API)". - -URI ---- - -GET /v2/{project_id}/images/{image_id}/metadata - -GET /v2.1/{project_id}/images/{image_id}/metadata - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817698__table5587311174112: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - image_id Yes Specifies the image ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0065817698__table10666498410: - -.. table:: **Table 2** Response parameters - - ================== ====== ======================================= - Parameter Type Description - ================== ====== ======================================= - User customization String Specifies the key pair of the metadata. - ================== ====== ======================================= - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988/metadata - GET https://{endpoint}/v2.1/9c53a566cb3443ab910cf0daebca90c4/images/17a1890b-0fa4-485e-8505-14e294017988/metadata - -Example Response ----------------- - -.. code-block:: - - { - "metadata": { - "__os_version": "Suse Linux Enterprise 12.2 64bit", - "__image_source_type": "uds", - "__imagetype": "gold", - "__os_bit": "64", - "__os_type": "Suse", - "__isregistered": "true", - "__image_location": "192.168.80.11:5080:pcsimsbeta:suse12.2-addx710-05-11", - "virtual_env_type": "Ironic", - "__platform": "Suse", - "__support_o3s": "true" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/index.rst b/ecs/api-ref/result/out-of-date_apis/index.rst deleted file mode 100644 index 67eef284..00000000 --- a/ecs/api-ref/result/out-of-date_apis/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0267425395: - -================ -Out-of-Date APIs -================ - -.. toctree:: - :maxdepth: 1 - - tag_management/index - fpga_logical_file_management/index - image_management_openstack_nova_apis/index - security_group_management_openstack_nova_apis/index - disk_management_openstack_nova_apis/index - floating_ip_address_management_openstack_nova_apis/index diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_discarded.rst deleted file mode 100644 index 2c30f47a..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_discarded.rst +++ /dev/null @@ -1,129 +0,0 @@ -:original_name: en-us_topic_0090187680.html - -.. _en-us_topic_0090187680: - -Creating a Security Group (Discarded) -===================================== - -Function --------- - -This API is used to create a security group. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Creating a Security Group" in *Virtual Private Network API Reference*. - -URI ---- - -POST /v2/{project_id}/os-security-groups - -POST /v2.1/{project_id}/os-security-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0090187680__en-us_topic_0057972662_table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0090187680__en-us_topic_0057972662_table63943666: - -.. table:: **Table 2** Request parameters - - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+========================================================================================================================================================================+ - | security_group | Yes | Object | Specifies the security group, which is configured in the message body. For details, see :ref:`Table 3 `. | - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187680__en-us_topic_0057972662_table21940722: - -.. table:: **Table 3** Objects of request parameter **security_group** - - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================+ - | name | No | String | Specifies the security group name. It must contain 0 to 255 characters. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - | description | No | String | Specifies information about a security group. It must contain 0 to 255 characters. | - +-------------+-----------+--------+------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0090187680__en-us_topic_0057972662_table61502840: - -.. table:: **Table 4** Response parameters - - +----------------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+========+===============================================================================================================================+ - | security_group | Object | Specifies the security group. For details, see :ref:`Table 5 `. | - +----------------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187680__en-us_topic_0057972662_table27870469: - -.. table:: **Table 5** Objects of response parameter **security_group** - - +-------------+------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+==================+===============================================================+ - | description | String | Provides supplementary information about the security group. | - +-------------+------------------+---------------------------------------------------------------+ - | id | String | Specifies the security group ID in UUID format. | - +-------------+------------------+---------------------------------------------------------------+ - | name | String | Specifies the security group name. | - +-------------+------------------+---------------------------------------------------------------+ - | rules | Array of objects | Specifies the rules of the security group. The list is empty. | - +-------------+------------------+---------------------------------------------------------------+ - | tenant_id | String | Specifies the tenant or project ID. | - +-------------+------------------+---------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups - POST https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups - -.. code-block:: - - { - "security_group": { - "name": "test", - "description": "description" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "security_group": { - "rules": [], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "description": "desc-sg", - "id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42", - "name": "test-sg" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_rule_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_rule_discarded.rst deleted file mode 100644 index e35e4d16..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/creating_a_security_group_rule_discarded.rst +++ /dev/null @@ -1,167 +0,0 @@ -:original_name: en-us_topic_0065817703.html - -.. _en-us_topic_0065817703: - -Creating a Security Group Rule (Discarded) -========================================== - -Function --------- - -This API is used to create a security group rule. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Creating a Security Group Rule" in *Virtual Private Network API Reference*. - -URI ---- - -POST /v2/{project_id}/os-security-group-rules - -POST /v2.1/{project_id}/os-security-group-rules - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817703__en-us_topic_0057972667_table32475667: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817703__en-us_topic_0057972667_table58520811: - -.. table:: **Table 2** Request parameters - - +---------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+========+=============================================================================================================================================================================+ - | security_group_rule | Yes | Object | Specifies the security group rule, which is configured in the message body. For details, see :ref:`Table 3 `. | - +---------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817703__en-us_topic_0057972667_table46685187: - -.. table:: **Table 3** Objects of request parameter **security_group_rule** - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================================================================================================+ - | parent_group_id | Yes | String | Specifies the associated security group ID in UUID format. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | Yes | String | Specifies the IP protocol, which can be **icmp**, **tcp**, or **udp**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Yes | Integer | Specifies the start port. The value ranges from 1 to 65,535 and is no greater than the value of **to_port**. | - | | | | | - | | | | If the value of **ip_protocol** is **icmp**, this parameter specifies the ICMP type. The value ranges from **0** to **255**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Yes | Integer | Specifies the end port. The value ranges from **1** to **65,535** and cannot be less than **from_port**. | - | | | | | - | | | | If **ip_protocol** is **icmp**, this parameter specifies the ICMP code. The value ranges from 0 to 255. If both **from_port** and **to_port** are **-1**, any ICMP packet can be transmitted. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cidr | No | String | Specifies the IP address range. The address is in CIDR format, such as 192.168.0.0/24. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group_id | No | String | Specifies the source security group ID. If both **group_id** and **cidr** are set, **group_id** is used. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817703__en-us_topic_0057972667_table37057034: - -.. table:: **Table 4** Response parameters - - +---------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+========+=============================================================================================================================================================================+ - | security_group_rule | Yes | Object | Specifies the security group rule, which is configured in the message body. For details, see :ref:`Table 5 `. | - +---------------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817703__en-us_topic_0057972667_table64243102: - -.. table:: **Table 5** Objects of response parameter **security_group_rule** - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================+ - | parent_group_id | Yes | String | Specifies the associated security group ID in UUID format. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | Yes | String | Specifies the IP protocol, which can be **icmp**, **tcp**, or **udp**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Yes | Integer | Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than **to_port**. | - | | | | | - | | | | When the protocol type is set to ICMP, **from_port** is the ICMP type and ranges from 0 to 255. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Yes | Integer | Specifies the end port number. The value ranges from **1** to **65,535**. | - | | | | | - | | | | - When the protocol type is set to ICMP, **to_port** is the ICMP code and ranges from **0** to **255**. | - | | | | - If both **from_port** and **to_port** are **-1**, it indicates that any ICMP packet can be transmitted. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_range | Yes | Object | Specifies the IP address range, including the CIDR information, such as **"ip_range": {"cidr": "0.0.0.0/0"}**. For details, see the ip_range object. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group | Yes | Object | Nothing is returned. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the security group rule ID in UUID format. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** **ip_range** objects - - +-----------+-----------+--------+----------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+========================================================================================+ - | cidr | Yes | String | Specifies the IP address range. The address is in CIDR format, such as 192.168.0.0/24. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/os-security-group-rules - POST https://{endpoint}/v2.1/{project_id}/os-security-group-rules - -.. code-block:: - - { - "security_group_rule": { - "from_port": "443", - "ip_protocol": "tcp", - "to_port": "443", - "cidr": "0.0.0.0/0", - "parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "security_group_rule": { - "id": "F4966B29-D21D-B211-B6B4-0018E1C5D866", - "ip_range": { - "cidr": "0.0.0.0/0" - }, - "parent_group_id": "48700ff3-30b8-4e63-845f-a79c9633e9fb", - "to_port": 443, - "ip_protocol": "tcp", - "group": { - - }, - "from_port": 443 - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_discarded.rst deleted file mode 100644 index f28c0da7..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_discarded.rst +++ /dev/null @@ -1,62 +0,0 @@ -:original_name: en-us_topic_0065817701.html - -.. _en-us_topic_0065817701: - -Deleting a Security Group (Discarded) -===================================== - -Function --------- - -This API is used to delete a security group. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Deleting a Security Group" in *Virtual Private Network API Reference*. - -URI ---- - -DELETE /v2/{project_id}/os-security-groups/{security_group_id} - -DELETE /v2.1/{project_id}/os-security-groups/{security_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817701__en-us_topic_0057972665_table55945983: - -.. table:: **Table 1** Parameter description - - +-------------------+-----------+-----------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +===================+===========+=================================================================+ - | project_id | Yes | Specifies the project ID. | - +-------------------+-----------+-----------------------------------------------------------------+ - | security_group_id | Yes | Specifies the security group ID, which is specified in the URI. | - +-------------------+-----------+-----------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - DELETE https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/81f1d23b-b1e2-42cd-bdee-359b4a065a42 - DELETE https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/81f1d23b-b1e2-42cd-bdee-359b4a065a42 - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_rule_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_rule_discarded.rst deleted file mode 100644 index c2f9eadd..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/deleting_a_security_group_rule_discarded.rst +++ /dev/null @@ -1,64 +0,0 @@ -:original_name: en-us_topic_0065817704.html - -.. _en-us_topic_0065817704: - -Deleting a Security Group Rule (Discarded) -========================================== - -Function --------- - -This API is used to delete a security group rule. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Deleting a Security Group Rule" in *Virtual Private Network API Reference*. - -URI ---- - -DELETE /v2/{project_id}/os-security-group-rules/{security_group_rule_id} - -DELETE /v2.1/{project_id}/os-security-group-rules/{security_group_rule_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817704__en-us_topic_0057972668_table32475667: - -.. table:: **Table 1** Parameter description - - +------------------------+-----------+----------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +========================+===========+======================================================================+ - | project_id | Yes | Specifies the project ID. | - +------------------------+-----------+----------------------------------------------------------------------+ - | security_group_rule_id | Yes | Specifies the security group rule ID, which is specified in the URI. | - +------------------------+-----------+----------------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -None - -Example Request ---------------- - -Example request - -.. code-block:: - - DELETE https://{endpoint}/v2/3d72597871904daeb6887f75f848b531/os-security-group-rules/012fa2c6-bf4a-4b0b-b893-70d0caee81c7 - DELETE https://{endpoint}/v2.1/3d72597871904daeb6887f75f848b531/os-security-group-rules/012fa2c6-bf4a-4b0b-b893-70d0caee81c7 - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/index.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/index.rst deleted file mode 100644 index 5fe57e3b..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _en-us_topic_0267427144: - -=============================================== -Security Group Management (OpenStack Nova APIs) -=============================================== - -.. toctree:: - :maxdepth: 1 - - querying_security_groups_discarded - creating_a_security_group_discarded - querying_details_about_a_security_group_discarded - updating_a_security_group_discarded - deleting_a_security_group_discarded - creating_a_security_group_rule_discarded - deleting_a_security_group_rule_discarded diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_details_about_a_security_group_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_details_about_a_security_group_discarded.rst deleted file mode 100644 index a6d544dd..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_details_about_a_security_group_discarded.rst +++ /dev/null @@ -1,162 +0,0 @@ -:original_name: en-us_topic_0090187681.html - -.. _en-us_topic_0090187681: - -Querying Details About a Security Group (Discarded) -=================================================== - -Function --------- - -This API is used to query details about a security group. - -This API can only query the inbound security group rules. To query the outbound security group rules, see "Querying a Security Group" in "Security Group (Native OpenStack API)" in the *Virtual Private Cloud API Reference*. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Querying a Security Group" in *Virtual Private Network API Reference*. - -URI ---- - -GET /v2/{project_id}/os-security-groups/{security_group_id} - -GET /v2.1/{project_id}/os-security-groups/{security_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table55945983: - -.. table:: **Table 1** Parameter description - - +-------------------+-----------+-----------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +===================+===========+=================================================================+ - | project_id | Yes | Specifies the project ID. | - +-------------------+-----------+-----------------------------------------------------------------+ - | security_group_id | Yes | Specifies the security group ID, which is specified in the URI. | - +-------------------+-----------+-----------------------------------------------------------------+ - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table50358210: - -.. table:: **Table 2** Response parameters - - +----------------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+========+===============================================================================================================================+ - | security_group | Object | Specifies the security group. For details, see :ref:`Table 3 `. | - +----------------+--------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table35285314: - -.. table:: **Table 3** **security_group** objects - - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+==================+=================================================================================================================================+ - | description | String | Specifies information about a security group. It must contain 0 to 255 characters. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID in UUID format. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the security group name. It must contain 0 to 255 characters. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | rules | Array of objects | Specifies security group rules. For details, see :ref:`Table 4 `. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the tenant or project ID. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table19372405: - -.. table:: **Table 4** **security_group_rule** objects - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================================================================================================================================================================================================================+ - | parent_group_id | String | Specifies the associated security group ID in UUID format. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | String | Specifies the protocol type or the IP protocol number. The value can be **icmp**, **tcp**, **udp**, or the IP protocol number. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Integer | Specifies the start port number. The value ranges from **1** to **65,535** and cannot be greater than **to_port**. | - | | | | - | | | When **ip_protocol** is **icmp**, this parameter indicates the ICMP type field with a length from 0 to 255 characters. | - | | | | - | | | .. note:: | - | | | | - | | | The ICMP message type is determined by the type field and code field in the packet. For details, see **Appendix** > **ICMP-Port Range Relationship Table** in *Virtual Private Cloud API Reference*. **port_range_min** indicates the ICMP type, and **port_range_max** indicates the ICMP code. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Integer | Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than **from_port**. | - | | | | - | | | When **ip_protocol** is **icmp**, this parameter indicates the ICMP code field with a length from 0 to 255 characters. | - | | | | - | | | .. note:: | - | | | | - | | | The ICMP message type is determined by the type field and code field in the packet. For details, see **Appendix** > **ICMP-Port Range Relationship Table** in *Virtual Private Cloud API Reference*. **port_range_min** indicates the ICMP type, and **port_range_max** indicates the ICMP code. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_range | Object | Specifies the peer IP segment in CIDR format. For details, see :ref:`Table 5 `. | - | | | | - | | | Specify either **ip_range** or **group**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group | Object | Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see :ref:`Table 6 `. | - | | | | - | | | Specify either **ip_range** or **group**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group rule ID. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table4101480163218: - -.. table:: **Table 5** **ip_range** objects - - ========= ====== ============================================= - Parameter Type Description - ========= ====== ============================================= - cidr String Specifies the peer IP segment in CIDR format. - ========= ====== ============================================= - -.. _en-us_topic_0090187681__en-us_topic_0057972663_table9527961163416: - -.. table:: **Table 6** **group** objects - - +-----------+--------+------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+============================================================+ - | tenant_id | String | Specifies the ID of the tenant of the peer security group. | - +-----------+--------+------------------------------------------------------------+ - | name | String | Specifies the name of the peer security group. | - +-----------+--------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/81f1d23b-b1e2-42cd-bdee-359b4a065a42 - GET https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/81f1d23b-b1e2-42cd-bdee-359b4a065a42 - -Example Response ----------------- - -.. code-block:: - - { - "security_group": { - "rules": [], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "id": "81f1d23b-b1e2-42cd-bdee-359b4a065a42", - "name": "test-sg", - "description": "desc-sg" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_security_groups_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_security_groups_discarded.rst deleted file mode 100644 index 55a834e2..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/querying_security_groups_discarded.rst +++ /dev/null @@ -1,219 +0,0 @@ -:original_name: en-us_topic_0090187679.html - -.. _en-us_topic_0090187679: - -Querying Security Groups (Discarded) -==================================== - -Function --------- - -This API is used to query security groups. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Querying Security Groups" in *Virtual Private Network API Reference*. - -URI ---- - -GET /v2/{project_id}/os-security-groups - -GET /v2.1/{project_id}/os-security-groups - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table55945983: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -.. note:: - - Pagination query is not supported. - -Request -------- - -N/A - -Response --------- - -:ref:`Table 2 ` describes the response parameters. - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table66376806: - -.. table:: **Table 2** Response parameters - - +-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+==================+============================================================================================================================+ - | security_groups | Array of objects | Specifies security groups. For details, see :ref:`Table 3 `. | - +-----------------+------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table12520187: - -.. table:: **Table 3** **security_group** objects - - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+==================+=================================================================================================================================+ - | description | String | Specifies information about a security group. It must contain 0 to 255 characters. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group ID in UUID format. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Specifies the security group name. It must contain 0 to 255 characters. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | rules | Array of objects | Specifies security group rules. For details, see :ref:`Table 4 `. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | String | Specifies the tenant or project ID. | - +-------------+------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table34485122: - -.. table:: **Table 4** **security_group_rule** objects - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================================================================================================================================================================================================+ - | parent_group_id | String | Specifies the associated security group ID in UUID format. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | String | Specifies the protocol type or the IP protocol number. The value can be **icmp**, **tcp**, **udp**, or the IP protocol number. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Integer | Specifies the start port number. The value ranges from 1 to 65,535 and cannot be greater than **to_port**. | - | | | | - | | | When **ip_protocol** is **icmp**, this parameter indicates the ICMP type field with a length from 0 to 255 characters. | - | | | | - | | | .. note:: | - | | | | - | | | The ICMP message type is determined by the type field and code field in the packet. For details, see **Appendix** > **ICMP-Port Range Relationship Table** in *Virtual Private Cloud API Reference*. **port_range_min** indicates the ICMP type field, and **port_range_max** indicates the ICMP code field. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Integer | Specifies the stop port number. The value ranges from 1 to 65,535 and cannot be less than **from_port**. | - | | | | - | | | When **ip_protocol** is **icmp**, this parameter indicates the ICMP code field with a length from 0 to 255 characters. | - | | | | - | | | .. note:: | - | | | | - | | | The ICMP message type is determined by the type field and code field in the packet. For details, see **Appendix** > **ICMP-Port Range Relationship Table** in *Virtual Private Cloud API Reference*. **port_range_min** indicates the ICMP type, and **port_range_max** indicates the ICMP code. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_range | Object | Specifies the peer IP segment in CIDR format. For details, see :ref:`Table 5 `. | - | | | | - | | | Specify either **ip_range** or **group**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group | Object | Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see :ref:`Table 6 `. | - | | | | - | | | Specify either **ip_range** or **group**. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Specifies the security group rule ID in UUID format. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table4101480163218: - -.. table:: **Table 5** **ip_range** objects - - ========= ====== ============================================= - Parameter Type Description - ========= ====== ============================================= - cidr String Specifies the peer IP segment in CIDR format. - ========= ====== ============================================= - -.. _en-us_topic_0090187679__en-us_topic_0057973221_table9527961163416: - -.. table:: **Table 6** **group** objects - - +-----------+--------+------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+============================================================+ - | tenant_id | String | Specifies the ID of the tenant of the peer security group. | - +-----------+--------+------------------------------------------------------------+ - | name | String | Specifies the name of the peer security group. | - +-----------+--------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups - GET https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups - -Example Response ----------------- - -.. code-block:: - - { - "security_groups": [ - { - "rules": [ - { - "from_port": null, - "group": { - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "name": "default" - }, - "ip_protocol": null, - "to_port": null, - "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "ip_range": {}, - "id": "bb3cc988-e06a-49f6-b668-600e8bf193ee" - }, - { - "from_port": null, - "group": { - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "name": "default" - }, - "ip_protocol": null, - "to_port": null, - "parent_group_id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "ip_range": {}, - "id": "f9371051-d7e1-4be4-8748-77b1e0913730" - } - ], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "description": "default", - "id": "bc4ac1d1-dc77-4b7d-a97d-af86eb0dc450", - "name": "default" - }, - { - "rules": [ - { - "from_port": 200, - "group": {}, - "ip_protocol": "tcp", - "to_port": 400, - "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "ip_range": { - "cidr": "0.0.0.0/0" - }, - "id": "3330120d-bbd1-4a73-bda9-0196a84d5670" - }, - { - "from_port": 201, - "group": {}, - "ip_protocol": "tcp", - "to_port": 400, - "parent_group_id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "ip_range": { - "cidr": "0.0.0.0/0" - }, - "id": "b550c9a6-970a-462d-984e-265e88020818" - } - ], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "description": "desc-sg", - "id": "b3e4b615-a40f-4e1c-92af-2e0d382141d5", - "name": "test-sg" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/updating_a_security_group_discarded.rst b/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/updating_a_security_group_discarded.rst deleted file mode 100644 index b62033bb..00000000 --- a/ecs/api-ref/result/out-of-date_apis/security_group_management_openstack_nova_apis/updating_a_security_group_discarded.rst +++ /dev/null @@ -1,200 +0,0 @@ -:original_name: en-us_topic_0065817700.html - -.. _en-us_topic_0065817700: - -Updating a Security Group (Discarded) -===================================== - -Function --------- - -This API is used to update a security group. - -This API has been discarded. Use the API described in section "Security Group (OpenStack Neutron APIs) > Updating a Security Group" in *Virtual Private Network API Reference*. - -URI ---- - -PUT /v2/{project_id}/os-security-groups/{security_group_id} - -PUT /v2.1/{project_id}/os-security-groups/{security_group_id} - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table55945983: - -.. table:: **Table 1** Parameter description - - +-------------------+-----------+-----------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +===================+===========+=================================================================+ - | project_id | Yes | Specifies the project ID. | - +-------------------+-----------+-----------------------------------------------------------------+ - | security_group_id | Yes | Specifies the security group ID, which is specified in the URI. | - +-------------------+-----------+-----------------------------------------------------------------+ - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table52078514: - -.. table:: **Table 2** Request parameters - - +----------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+===================================================================================================================================================+ - | security_group | Yes | Object | Specifies the security group in the message body. For details, see :ref:`Table 3 `. | - +----------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table11041789: - -.. table:: **Table 3** Objects of request parameter **security_group** - - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | name | Yes | String | Specifies the security group name. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | description | Yes | String | Specifies information about a security group. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - -Response --------- - -:ref:`Table 4 ` describes the response parameters. - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table44133910: - -.. table:: **Table 4** Response parameters - - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+==============================================================================================================================+ - | security_group | Yes | Object | Specifies the security group. For details, see :ref:`Table 5 `. | - +----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table5938035: - -.. table:: **Table 5** Objects of response parameter **security_group** - - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+=========================================================================================================================================+ - | description | Yes | String | Specifies information about a security group. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the security group ID in UUID format. | - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Specifies the security group name. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | rules | Yes | Array of objects | Specifies the security group rule list. For details, see :ref:`Table 6 `. | - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | tenant_id | Yes | String | Specifies the tenant or project ID. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table64215808: - -.. table:: **Table 6** **security_group_rule** objects - - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+=========+=================================================================================================================================================================================================================================================================================+ - | parent_group_id | Yes | String | Specifies the associated security group ID in UUID format. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_protocol | Yes | String | Specifies the protocol type or the IP protocol number. The value can be **icmp**, **tcp**, **udp**, or the IP protocol number. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | from_port | Yes | Integer | Specifies the start port. The value ranges from 1 to 65,535 and cannot be greater than **to_port**. When **ip_protocol** is **icmp**, this parameter specifies a port type with a length from 0 to 255 characters. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | to_port | Yes | Integer | Specifies the end port. The value ranges from 1 to 65,535 and cannot be less than **from_port**. When **ip_protocol** is **icmp**, it specifies the code. The value ranges from 0 to 255. If both **from_port** and **to_port** are **-1**, any ICMP packet can be transmitted. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_range | Yes | Object | Specifies the peer IP segment in CIDR format. For details, see :ref:`Table 7 `. The value of **ip_range** or **group** must be empty. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | group | Yes | Object | Specifies the name of the peer security group and the ID of the tenant in the peer security group. For details, see :ref:`Table 8 `. The value of **ip_range** or **group** must be empty. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes | String | Specifies the security group rule ID in UUID format. | - +-----------------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table4101480163218: - -.. table:: **Table 7** **ip_range** objects - - +-----------------+-----------------+-----------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================+ - | cidr | Yes | String | Specifies the peer IP segment in CIDR format. | - | | | | | - | | | | The value cannot exceed 255 characters. | - +-----------------+-----------------+-----------------+-----------------------------------------------+ - -.. _en-us_topic_0065817700__en-us_topic_0057972664_table9527961163416: - -.. table:: **Table 8** **group** objects - - +-----------+-----------+--------+------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+============================================================+ - | tenant_id | Yes | String | Specifies the ID of the tenant of the peer security group. | - +-----------+-----------+--------+------------------------------------------------------------+ - | name | Yes | String | Specifies the name of the peer security group. | - +-----------+-----------+--------+------------------------------------------------------------+ - -Example Request ---------------- - -.. code-block:: - - PUT https://{endpoint}/v2/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/3d02312d-0764-49c9-8244-2368ddce0045 - PUT https://{endpoint}/v2.1/bb1118612ba64af3a6ea63a1bdcaa5ae/os-security-groups/3d02312d-0764-49c9-8244-2368ddce0045 - -.. code-block:: - - { - "security_group": { - "name": "test", - "description": "description" - } - } - -Example Response ----------------- - -.. code-block:: - - { - "security_group": { - "rules": [ - { - "from_port": null, - "group": { - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "name": "test" - }, - "ip_protocol": null, - "to_port": null, - "parent_group_id": "3d02312d-0764-49c9-8244-2368ddce0045", - "ip_range": {}, - "id": "00dec0b6-8e96-4906-aadf-46cfe54cf5ef" - } - ], - "tenant_id": "bb1118612ba64af3a6ea63a1bdcaa5ae", - "id": "3d02312d-0764-49c9-8244-2368ddce0045", - "name": "test", - "description": "description" - } - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. diff --git a/ecs/api-ref/result/out-of-date_apis/tag_management/adding_tags_to_an_ecs_in_a_batch_discarded.rst b/ecs/api-ref/result/out-of-date_apis/tag_management/adding_tags_to_an_ecs_in_a_batch_discarded.rst deleted file mode 100644 index 0f179df1..00000000 --- a/ecs/api-ref/result/out-of-date_apis/tag_management/adding_tags_to_an_ecs_in_a_batch_discarded.rst +++ /dev/null @@ -1,124 +0,0 @@ -:original_name: en-us_topic_0000001252143577.html - -.. _en-us_topic_0000001252143577: - -Adding Tags to an ECS in a Batch (Discarded) -============================================ - -Function --------- - -- This API is used to add tags to a specified ECS in a batch. -- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS. - -.. note:: - - This API has been discarded. Use the API described in :ref:`Adding Tags to an ECS in a Batch `. - -Constraints ------------ - -- An ECS allows a maximum of 10 tags. - -- This API is idempotent. - - During tag creation, if a tag exists (both the key and value are the same as those of an existing tag), the tag is successfully processed by default. - -- A new tag will overwrite the original one if their keys are the same and values are different. - -URI ---- - -POST /v1/{project_id}/servers/{server_id}/tags/action - -:ref:`Table 1 ` lists the parameters. - -.. _en-us_topic_0000001252143577__table19484740133714: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0000001252143577__table1349994618388: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+===========================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation (only lowercase letters are supported). For example, **create** indicates the creation operation. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **resource_tag** field description - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | - Cannot be left blank. | - | | | | - Must be unique for each resource. | - | | | | - Contains a maximum of 36 characters. | - | | | | - Contains only digits, letters, hyphens (-), and underscores (_). | - | | | | - Must be unique and cannot be left blank. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | value | Yes | String | Specifies the tag value. | - | | | | | - | | | | - Contains a maximum of 43 characters. | - | | | | - Contains only digits, letters, hyphens (-), and underscores (_). | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/servers/{server_id}/tags/action - -.. code-block:: - - { - "action": "create", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/tag_management/deleting_tags_from_an_ecs_in_a_batch_discarded.rst b/ecs/api-ref/result/out-of-date_apis/tag_management/deleting_tags_from_an_ecs_in_a_batch_discarded.rst deleted file mode 100644 index 77a5e3cd..00000000 --- a/ecs/api-ref/result/out-of-date_apis/tag_management/deleting_tags_from_an_ecs_in_a_batch_discarded.rst +++ /dev/null @@ -1,116 +0,0 @@ -:original_name: en-us_topic_0000001252263549.html - -.. _en-us_topic_0000001252263549: - -Deleting Tags from an ECS in a Batch (Discarded) -================================================ - -Function --------- - -- This API is used to delete tags from a specified ECS in a batch. -- The Tag Management Service (TMS) uses this API to batch manage the tags of an ECS. -- This API is idempotent. When you delete a tag but the tag does not exist, a successful result is returned. - -.. note:: - - This API has been discarded. Use the API described in :ref:`Deleting Tags from an ECS in a Batch `. - -Constraints ------------ - -An ECS allows a maximum of 10 tags. - -URI ---- - -POST /v1/{project_id}/servers/{server_id}/tags/action - -:ref:`Table 1 ` describes the parameters in the URI. - -.. _en-us_topic_0000001252263549__en-us_topic_0096282701_table19484740133714: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0000001252263549__table787034194212: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+===========================================================================================================================+ - | tags | Yes | Array of objects | Specifies tags. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - | action | Yes | String | Specifies the operation (only lowercase letters are supported). For example, **delete** indicates the deletion operation. | - +-----------+-----------+------------------+---------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **resource_tag** field description - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================+ - | key | Yes | String | Specifies the tag key. | - | | | | | - | | | | It contains a maximum of 127 Unicode characters and cannot be left blank. | - | | | | | - | | | | The tag key of an ECS must be unique. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | value | No | String | Specifies the tag value. | - | | | | | - | | | | The value can contain a maximum of 255 Unicode characters and can be left blank. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - -Response --------- - -None - -Example Request ---------------- - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/servers/{server_id}/tags/action - -.. code-block:: - - { - "action": "delete", - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Example Response ----------------- - -None - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/tag_management/index.rst b/ecs/api-ref/result/out-of-date_apis/tag_management/index.rst deleted file mode 100644 index 5b0842b4..00000000 --- a/ecs/api-ref/result/out-of-date_apis/tag_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0000001207303618: - -============== -Tag Management -============== - -.. toctree:: - :maxdepth: 1 - - adding_tags_to_an_ecs_in_a_batch_discarded - deleting_tags_from_an_ecs_in_a_batch_discarded - querying_project_tags_discarded - querying_tags_of_an_ecs_discarded diff --git a/ecs/api-ref/result/out-of-date_apis/tag_management/querying_project_tags_discarded.rst b/ecs/api-ref/result/out-of-date_apis/tag_management/querying_project_tags_discarded.rst deleted file mode 100644 index f58e256c..00000000 --- a/ecs/api-ref/result/out-of-date_apis/tag_management/querying_project_tags_discarded.rst +++ /dev/null @@ -1,113 +0,0 @@ -:original_name: en-us_topic_0000001207623588.html - -.. _en-us_topic_0000001207623588: - -Querying Project Tags (Discarded) -================================= - -Function --------- - -Projects are used to group and isolate OpenStack resources, which include computing, storage, and network resources. A project can be a department or a team. Multiple projects can be created under one account. - -This API is used to query all tags used by a user in a specified project. - -.. note:: - - This API has been discarded. Use the API described in :ref:`Querying Project Tags `. - -URI ---- - -GET /v1/{project_id}/servers/tags - -:ref:`Table 1 ` lists the parameter. - -.. _en-us_topic_0000001207623588__table144382516421: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameter. - -.. _en-us_topic_0000001207623588__table725495518449: - -.. table:: **Table 2** Response parameter - - ========= ================ =============== - Parameter Type Description - ========= ================ =============== - tags Array of objects Specifies tags. - ========= ================ =============== - -.. table:: **Table 3** **tag** field description - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | key | String | Specifies the tag key. | - | | | | - | | | - The key can contain a maximum of 36 Unicode characters. | - | | | - Contains only digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | values | Array of strings | Specifies the tag value. | - | | | | - | | | - Each value contains a maximum of 43 Unicode characters. | - | | | - This field can be left blank. | - | | | - Contains only digits, letters, hyphens (-), and underscores (_). | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -Examples --------- - -- Example Request - - .. code-block:: - - GET https://{endpoint}/v1/{project_id}/servers/tags - -- Example Response - - .. code-block:: - - { - "tags": [ - { - "key": "key1", - "values": [ - "value1", - "value2" - ] - }, - { - "key": "key2", - "values": [ - "value1", - "value2" - ] - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/out-of-date_apis/tag_management/querying_tags_of_an_ecs_discarded.rst b/ecs/api-ref/result/out-of-date_apis/tag_management/querying_tags_of_an_ecs_discarded.rst deleted file mode 100644 index 46e6d873..00000000 --- a/ecs/api-ref/result/out-of-date_apis/tag_management/querying_tags_of_an_ecs_discarded.rst +++ /dev/null @@ -1,98 +0,0 @@ -:original_name: en-us_topic_0000001207783562.html - -.. _en-us_topic_0000001207783562: - -Querying Tags of an ECS (Discarded) -=================================== - -Function --------- - -- This API is used to query the tags of a specified ECS. -- The Tag Management Service (TMS) uses this API to query all tags of an ECS. - -.. note:: - - This API has been discarded. Use the API described in :ref:`Querying Tags of an ECS `. - -URI ---- - -GET /v1/{project_id}/servers/{server_id}/tags - -:ref:`Table 1 ` lists the parameters. - -.. _en-us_topic_0000001207783562__table431622145919: - -.. table:: **Table 1** Parameter description - - ========== ========= ========================= - Parameter Mandatory Description - ========== ========= ========================= - project_id Yes Specifies the project ID. - server_id Yes Specifies the ECS ID. - ========== ========= ========================= - -Request -------- - -None - -Response --------- - -:ref:`Table 2 ` describes the response parameter. - -.. _en-us_topic_0000001207783562__table725495518449: - -.. table:: **Table 2** Response parameter - - ========= ================ =============== - Parameter Type Description - ========= ================ =============== - tags Array of objects Specifies tags. - ========= ================ =============== - -.. table:: **Table 3** **resource_tag** field description - - ========= ====== ======================== - Parameter Type Description - ========= ====== ======================== - key String Specifies the tag key. - value String Specifies the tag value. - ========= ====== ======================== - -Example Request ---------------- - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/servers/{server_id}/tags - -Example Response ----------------- - -.. code-block:: - - { - "tags": [ - { - "key": "key1", - "value": "value1" - }, - { - "key": "key2", - "value": "value3" - } - ] - } - -Returned Values ---------------- - -See :ref:`Returned Values for General Requests `. - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/az_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/az_management.rst deleted file mode 100644 index 176ba321..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/az_management.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: en-us_topic_0103071519.html - -.. _en-us_topic_0103071519: - -AZ Management -============= - -+-------------------------------------+---------------------------------------------+----------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+=====================================+=============================================+============================+======================+ -| Querying AZs (Native OpenStack API) | GET /v2/{project_id}/os-availability-zone | ecs:availabilityZones:list | - | -| | | | | -| | GET /v2.1/{project_id}/os-availability-zone | | | -+-------------------------------------+---------------------------------------------+----------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/batch_operations.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/batch_operations.rst deleted file mode 100644 index 8c6ccb16..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/batch_operations.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: en-us_topic_0184167662.html - -.. _en-us_topic_0184167662: - -Batch Operations -================ - -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+===================================================================+=============================================================+=====================================+======================+ -| Stopping ECSs in a Batch | POST /v1/{project_id}/cloudservers/action | ecs:cloudServers:stop | N/A | -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ -| Restarting ECSs in a Batch | POST /v1/{project_id}/cloudservers/action | ecs:cloudServers:reboot | N/A | -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ -| Starting ECSs in a Batch | POST /v1/{project_id}/cloudservers/action | ecs:cloudServers:start | N/A | -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ -| Modifying ECSs in a Batch | PUT /v1/{project_id}/cloudservers/server-name | ecs:cloudServers:put | N/A | -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ -| Attaching a Specified Shared EVS Disk to Multiple ECSs in a Batch | POST /v1/{project_id}/batchaction/attachvolumes/{volume_id} | ecs:cloudServers:attachSharedVolume | evs:volumes:use | -+-------------------------------------------------------------------+-------------------------------------------------------------+-------------------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/disk_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/disk_management.rst deleted file mode 100644 index 2203f9dd..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/disk_management.rst +++ /dev/null @@ -1,66 +0,0 @@ -:original_name: en-us_topic_0103071514.html - -.. _en-us_topic_0103071514: - -Disk Management -=============== - -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Permission | API | Action | Dependent Permission | -+================================================================================+=================================================================================+====================================+=======================+ -| Detaching a Disk from a Specified ECS | DELETE /v1/{project_id}/cloudservers/{server_id}/detachvolume/{attachment_id} | ecs:cloudServers:detachVolume | N/A | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Attaching a Disk to an ECS | POST /v1/{project_id}/cloudservers/{server_id}/attachvolume | ecs:cloudServers:attach | evs:volumes:use | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Attaching a Disk from an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/os-volume_attachments | ecs:serverVolumeAttachments:create | ecs:serverVolumes:use | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/os-volume_attachments | | evs:volumes:list | -| | | | | -| | | | evs:volumes:get | -| | | | | -| | | | evs:volumes:update | -| | | | | -| | | | evs:volumes:attach | -| | | | | -| | | | evs:volumes:manage | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Detaching a Disk from an ECS (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} | ecs:serverVolumeAttachments:delete | ecs:serverVolumes:use | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} | | evs:volumes:list | -| | | | | -| | | | evs:volumes:get | -| | | | | -| | | | evs:volumes:update | -| | | | | -| | | | evs:volumes:detach | -| | | | | -| | | | evs:volumes:manage | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Querying Information About the Disks Attached to an ECS (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/os-volume_attachments | ecs:serverVolumeAttachments:list | ecs:serverVolumes:use | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments | | ecs:servers:get | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Querying Information About a Disk Attached to an ECS (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} | ecs:serverVolumeAttachments:get | ecs:serverVolumes:use | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-volume_attachments/{volume_id} | | | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Creating a Disk (Native OpenStack API) | POST /v2/{project_id}/os-volumes | ecs:serverVolumes:use | evs:volumes:create | -| | | | | -| | POST /v2.1/{project_id}/os-volumes | | | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Deleting a Disk (Native OpenStack API) | DELETE /v2/{project_id}/os-volumes/{volume_id} | ecs:serverVolumes:use | evs:volumes:get | -| | | | | -| | DELETE /v2.1/{project_id}/os-volumes/{volume_id} | | evs:volumes:delete | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Querying a Disk (Native OpenStack API) | GET /v2/{project_id}/os-volumes/{volume_id} | ecs:serverVolumes:use | evs:volumes:get | -| | | | | -| | GET /v2.1/{project_id}/os-volumes/{volume_id} | | | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Querying Disks (Native OpenStack API) | GET /v2/{project_id}/os-volumes | ecs:serverVolumes:use | evs:volumes:get | -| | | | | -| | GET /v2.1/{project_id}/os-volumes | | evs:volumes:list | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ -| Querying Detailed Disk Information (Native OpenStack API) | GET /v2/{project_id}/os-volumes/detail | ecs:serverVolumes:use | evs:volumes:get | -| | | | | -| | GET /v2.1/{project_id}/os-volumes/detail | | evs:volumes:list | -+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------+------------------------------------+-----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_group_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_group_management.rst deleted file mode 100644 index e0edc9ff..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_group_management.rst +++ /dev/null @@ -1,38 +0,0 @@ -:original_name: en-us_topic_0103071520.html - -.. _en-us_topic_0103071520: - -ECS Group Management -==================== - -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+============================================================+==============================================================================+=========================+======================+ -| Deleting an ECS Group | DELETE /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} | ecs:cloudServers:delete | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Creating an ECS Group | POST /v1{project_id}/cloudservers/os-server-groups | ecs:cloudServers:create | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Adding an ECS to an ECS Group | POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action | ecs:cloudServers:create | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Removing an ECS from an ECS Group | POST /v1/{project_id}/cloudservers/os-server-groups/{server_group_id}/action | ecs:cloudServers:delete | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Querying ECS Groups | GET /v1/{project_id}/cloudservers/os-server-groups | ecs:cloudServers:list | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Querying Details About an ECS Group | GET /v1/{project_id}/cloudservers/os-server-groups/{server_group_id} | ecs:cloudServers:get | N/A | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Creating an ECS Group (Native OpenStack API) | POST /v2/{project_id}/os-server-groups | ecs:serverGroups:manage | N/A | -| | | | | -| | POST /v2.1/{project_id}/os-server-groups | | | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Querying ECS Groups (Native OpenStack API) | GET /v2/{project_id}/os-server-groups | ecs:serverGroups:manage | N/A | -| | | | | -| | GET /v2.1/{project_id}/os-server-groups | | | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Querying Details About an ECS Group (Native OpenStack API) | GET /v2/{project_id}/os-server-groups/{server_group_id} | ecs:serverGroups:manage | N/A | -| | | | | -| | GET /v2.1/{project_id}/os-server-groups/{server_group_id} | | | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ -| Deleting an ECS Group (Native OpenStack API) | DELETE /v2/{project_id}/os-server-groups/{server_group_id} | ecs:serverGroups:manage | N/A | -| | | | | -| | DELETE /v2.1/{project_id}/os-server-groups/{server_group_id} | | | -+------------------------------------------------------------+------------------------------------------------------------------------------+-------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_management_through_console.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_management_through_console.rst deleted file mode 100644 index 1e8555c3..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_management_through_console.rst +++ /dev/null @@ -1,12 +0,0 @@ -:original_name: en-us_topic_0184192952.html - -.. _en-us_topic_0184192952: - -ECS Management Through Console -============================== - -+---------------------------------------------------------------+-------------------------------------------------------------+---------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+===============================================================+=============================================================+===========================+======================+ -| Obtaining the Address for Logging In to the Console Using VNC | POST /v2.1/{project_id}/servers/{server_id}/remote-consoles | ecs:servers:createConsole | ecs:servers:get | -+---------------------------------------------------------------+-------------------------------------------------------------+---------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_status_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_status_management.rst deleted file mode 100644 index 32a98a96..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/ecs_status_management.rst +++ /dev/null @@ -1,66 +0,0 @@ -:original_name: en-us_topic_0103071511.html - -.. _en-us_topic_0103071511: - -ECS Status Management -===================== - -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+===============================================================+============================================================+===========================+======================+ -| Changing an ECS OS | POST /v2/{project_id}/cloudservers/{server_id}/changeos | ecs:cloudServers:changeOS | N/A | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Reinstalling an ECS OS | POST /v2/{project_id}/cloudservers/{server_id}/reinstallos | ecs:cloudServers:rebuild | N/A | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Modifying the Specifications of an ECS | POST /v1/{project_id}/cloudservers/{server_id}/resize | ecs:cloudServers:resize | N/A | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Cold Migrating an ECS | POST /v1/{project_id}/cloudservers/{server_id}/migrate | ecs:cloudServers:migrate | N/A | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Stopping an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:stop | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Restarting an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:reboot | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Modifying the Specifications of an ECS (Native OpenStack API) | POST /v2.1/{project_id}/servers/{server_id}/action | ecs:servers:resize | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | evs:volumes:list | -| | | | | -| | | | evs:volumes:create | -| | | | | -| | | | evs:volumes:get | -| | | | | -| | | | evs:volumes:attach | -| | | | | -| | | | evs:volumes:detach | -| | | | | -| | | | evs:volumes:manage | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:ports:update | -| | | | | -| | | | vpc:ports:create | -| | | | | -| | | | vpc:ports:delete | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Rebuilding an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:rebuild | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | ecs:servers:update | -| | | | | -| | | | ims:images:get | -| | | | | -| | | | ims:images:list | -| | | | | -| | | | ims:images:update | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Locking an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:lock | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ -| Unlocking an ECS (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:unlock | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | | -+---------------------------------------------------------------+------------------------------------------------------------+---------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/floating_ip_address_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/floating_ip_address_management.rst deleted file mode 100644 index 5dae844a..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/floating_ip_address_management.rst +++ /dev/null @@ -1,34 +0,0 @@ -:original_name: en-us_topic_0103072349.html - -.. _en-us_topic_0103072349: - -Floating IP Address Management -============================== - -+---------------------------------------------------------------------+------------------------------------------------------------+---------------------------+------------------------+ -| Permission | API | Action | Dependent Permission | -+=====================================================================+============================================================+===========================+========================+ -| Allocating a Floating IP Address (Native OpenStack API) | POST /v2/{project_id}/os-floating-ips | ecs:serverFloatingIps:use | vpc:floatingIps:get | -| | | | | -| | POST /v2.1/{project_id}/os-floating-ips | | vpc:floatingIps:create | -| | | | | -| | | | vpc:floatingIps:update | -| | | | | -| | | | vpc:ports:get | -+---------------------------------------------------------------------+------------------------------------------------------------+---------------------------+------------------------+ -| Querying Floating IP Addresses (Native OpenStack API) | GET /v2/{project_id}/os-floating-ips | ecs:serverFloatingIps:use | vpc:floatingIps:get | -| | | | | -| | GET /v2.1/{project_id}/os-floating-ips | | vpc:ports:get | -+---------------------------------------------------------------------+------------------------------------------------------------+---------------------------+------------------------+ -| Querying Details About Floating IP Addresses (Native OpenStack API) | GET /v2/{project_id}/os-floating-ips/{floating_ip_id} | ecs:serverFloatingIps:use | vpc:floatingIps:get | -| | | | | -| | GET /v2.1/{project_id}/os-floating-ips/{floating_ip_id} | | vpc:ports:get | -+---------------------------------------------------------------------+------------------------------------------------------------+---------------------------+------------------------+ -| Releasing a Floating IP Address (Native OpenStack API) | DELETE /v2/{project_id}/os-floating-ips/{floating_ip_id} | ecs:serverFloatingIps:use | vpc:floatingIps:get | -| | | | | -| | DELETE /v2.1/{project_id}/os-floating-ips/{floating_ip_id} | | vpc:floatingIps:delete | -| | | | | -| | | | vpc:floatingIps:update | -| | | | | -| | | | vpc:ports:get | -+---------------------------------------------------------------------+------------------------------------------------------------+---------------------------+------------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/fpga_logical_file_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/fpga_logical_file_management.rst deleted file mode 100644 index 30f05407..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/fpga_logical_file_management.rst +++ /dev/null @@ -1,22 +0,0 @@ -:original_name: en-us_topic_0132778339.html - -.. _en-us_topic_0132778339: - -FPGA Logical File Management -============================ - -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+==============================================================+==============================================================================================+========================================+======================+ -| Querying Associations Between an FPGA Image and an ECS Image | GET /v1/{project_id}/cloudservers/fpga_image/associations{?image_id,fpga_image_id,page,size} | ecs:cloudServerFpgaImages:getRelations | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Disassociating an FPGA Image from an ECS Image | DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association | ecs:cloudServerFpgaImags:unrelate | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Viewing Details of FPGA Images | GET /v1/{project_id}/cloudservers/fpga_image/detail | ecs:cloudServerFpgaImages:list | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Deleting an FPGA Image | DELETE /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id} | ecs:cloudServerFpgaImages:delete | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Associating an FPGA Image with an ECS Image | POST /v1/{project_id}/cloudservers/fpga_image/{fpga_image_id}/association | ecs:cloudServerFpgaImages:relate | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ -| Registering an FPGA Image | POST /v1/{project_id}/cloudservers/fpga_image | ecs:cloudServerFpgaImages:register | N/A | -+--------------------------------------------------------------+----------------------------------------------------------------------------------------------+----------------------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/image_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/image_management.rst deleted file mode 100644 index 28a9c551..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/image_management.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: en-us_topic_0103072348.html - -.. _en-us_topic_0103072348: - -Image Management -================ - -+------------------------------------------+----------------------------------------------------+-------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+==========================================+====================================================+=========================+======================+ -| Creating an Image (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:servers:createImage | evs:volumes:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | evs:snapshots:create | -| | | | | -| | | | ims:images:create | -| | | | | -| | | | ims:images:get | -| | | | | -| | | | ims:images:list | -| | | | | -| | | | ims:images:update | -| | | | | -| | | | ims:images:delete | -+------------------------------------------+----------------------------------------------------+-------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/index.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/index.rst deleted file mode 100644 index 3edb9891..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _en-us_topic_0103071509: - -========================================== -Permissions Policies and Supported Actions -========================================== - -.. toctree:: - :maxdepth: 1 - - lifecycle_management - ecs_status_management - batch_operations - network_management - image_management - security_group_management - specifications_query - nic_management - disk_management - metadata_management - tenant_quota_management - ssh_key_management - password_management - floating_ip_address_management - ecs_group_management - ecs_management_through_console - az_management - tag_management - fpga_logical_file_management diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/lifecycle_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/lifecycle_management.rst deleted file mode 100644 index 30f5925c..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/lifecycle_management.rst +++ /dev/null @@ -1,124 +0,0 @@ -:original_name: en-us_topic_0103071510.html - -.. _en-us_topic_0103071510: - -Lifecycle Management -==================== - -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Permission | API | Action | Dependent Permission | -+======================================================+===============================================+============================+============================+ -| Creating an ECS | POST /v1/{project_id}/cloudservers | - Assigning a New EIP | - Assigning a New EIP | -| | | | | -| | | ecs:cloudServers:create | vpc:publicIps:create | -| | | | | -| | | - Using an Existing EIP | - Using an Existing EIP | -| | | | | -| | | ecs:cloudServers:create | vpc:publicIps:update | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Deleting ECSs | POST /v1/{project_id}/cloudservers/delete | ecs:cloudServers:delete | N/A | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Querying Details About ECSs (Native OpenStack API) | GET /v2/{project_id}/servers/detail | ecs:servers:list | ecs:servers:get | -| | | | | -| | GET /v2.1/{project_id}/servers/detail | | ecs:serverVolumes:use | -| | | | | -| | | | ecs:diskConfigs:use | -| | | | | -| | | | ecs:securityGroups:use | -| | | | | -| | | | ecs:serverKeypairs:get | -| | | | | -| | | | vpc:securityGroups:get | -| | | | | -| | | | vpc:securityGroupRules:get | -| | | | | -| | | | vpc:networks:get | -| | | | | -| | | | vpc:subnets:get | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:routers:get | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Querying ECSs (Native OpenStack API) | GET /v2/{project_id}/servers | ecs:servers:list | N/A | -| | | | | -| | GET /v2.1/{project_id}/servers | | | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Querying Details About an ECS (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id} | ecs:servers:get | ecs:serverVolumes:use | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id} | | ecs:diskConfigs:use | -| | | | | -| | | | ecs:securityGroups:use | -| | | | | -| | | | ecs:serverKeypairs:get | -| | | | | -| | | | vpc:securityGroups:get | -| | | | | -| | | | vpc:securityGroupRules:get | -| | | | | -| | | | vpc:networks:get | -| | | | | -| | | | vpc:subnets:get | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:routers:get | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Creating an ECS (Native OpenStack API) | POST /v2/{project_id}/servers | ecs:servers:create | ecs:servers:get | -| | | | | -| | POST /v2/{project_id}/os-volumes_boot | | ecs:serverInterfaces:use | -| | | | | -| | POST /v2.1/{project_id}/servers | | ecs:serverInterfaces:get | -| | | | | -| | POST /v2.1/{project_id}/os-volumes_boot | | ecs:flavors:get | -| | | | | -| | | | ecs:securityGroups:use | -| | | | | -| | | | evs:volumes:list | -| | | | | -| | | | evs:volumes:get | -| | | | | -| | | | evs:volumes:create | -| | | | | -| | | | evs:volumes:attach | -| | | | | -| | | | evs:volumes:manage | -| | | | | -| | | | vpc:securityGroups:get | -| | | | | -| | | | vpc:networks:get | -| | | | | -| | | | vpc:networks:update | -| | | | | -| | | | vpc:subnets:get | -| | | | | -| | | | vpc:subnets:update | -| | | | | -| | | | vpc:ports:create | -| | | | | -| | | | vpc:ports:update | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:ports:delete | -| | | | | -| | | | vpc:networks:create | -| | | | | -| | | | vpc:subnets:create | -| | | | | -| | | | vpc:routers:get | -| | | | | -| | | | vpc:routers:update | -| | | | | -| | | | ims:images:list | -| | | | | -| | | | ims:images:get | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Deleting an ECS (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id} | ecs:servers:delete | N/A | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id} | | | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ -| Modifying an ECS (Native OpenStack API) | PUT /v2/{project_id}/servers/{server_id} | ecs:servers:update | ecs:servers:get | -| | | | | -| | PUT /v2.1/{project_id}/servers/{server_id} | | | -+------------------------------------------------------+-----------------------------------------------+----------------------------+----------------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/metadata_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/metadata_management.rst deleted file mode 100644 index 85177ba5..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/metadata_management.rst +++ /dev/null @@ -1,38 +0,0 @@ -:original_name: en-us_topic_0103071516.html - -.. _en-us_topic_0103071516: - -Metadata Management -=================== - -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+======================================================================+==============================================================+==================================+======================+ -| Querying ECS Metadata (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/metadata | ecs:servers:listMetadata | N/A | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/metadata | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Querying Metadata of an ECS Key (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/metadata/{key} | ecs:servers:getMetadata | N/A | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/metadata/{key} | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Deleting Specified ECS Metadata (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id}/metadata/{key} | ecs:servers:setMetadata | N/A | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/metadata/{key} | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Modifying the Key Value in Metadata of an ECS (Native OpenStack API) | PUT /v2/{project_id}/servers/{server_id}/metadata/{key} | ecs:servers:setMetadata | N/A | -| | | | | -| | PUT /v2.1/{project_id}/servers/{server_id}/metadata/{key} | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Updating ECS Metadata (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/metadata | ecs:servers:setMetadata | N/A | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/metadata | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Configuring ECS Metadata (Native OpenStack API) | PUT /v2/{project_id}/servers/{server_id}/metadata | ecs:servers:setMetadata | ecs:servers:get | -| | | | | -| | PUT /v2.1/{project_id}/servers/{server_id}/metadata | | | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Managing Automatic Recovery of an ECS | PUT /v1/{project_id}/cloudservers/{server_id}/autorecovery | ecs:cloudServers:setAutoRecovery | N/A | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ -| Querying Automatic Recovery of an ECS | GET /v1/{project_id}/cloudservers/{server_id}/autorecovery | ecs:cloudServers:getAutoRecovery | N/A | -+----------------------------------------------------------------------+--------------------------------------------------------------+----------------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/network_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/network_management.rst deleted file mode 100644 index e8fa8e9e..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/network_management.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: en-us_topic_0103072350.html - -.. _en-us_topic_0103072350: - -Network Management -================== - -+------------------------------------------+------------------------------------+-------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+==========================================+====================================+===================+======================+ -| Querying Networks (Native OpenStack API) | GET /v2/{project_id}/os-networks | ecs:networks:list | vpc:networks:get | -| | | | | -| | GET /v2.1/{project_id}/os-networks | | | -+------------------------------------------+------------------------------------+-------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/nic_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/nic_management.rst deleted file mode 100644 index 717a0217..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/nic_management.rst +++ /dev/null @@ -1,72 +0,0 @@ -:original_name: en-us_topic_0103071513.html - -.. _en-us_topic_0103071513: - -NIC Management -============== - -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Permission | API | Action | Dependent Permission | -+==============================================================+=================================================================+============================+==========================+ -| Deleting NICs from an ECS in a Batch | POST /v1/{project_id}/cloudservers/{server_id}/nics/delete | ecs:cloudServerNics:delete | N/A | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Adding NICs to an ECS in a Batch | POST /v1/{project_id}/cloudservers/{server_id}/nics | ecs:cloudServers:addNics | N/A | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Adding an ECS NIC (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/os-interface | ecs:serverInterfaces:use | ecs:serverInterfaces:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/os-interface | | vpc:networks:get | -| | | | | -| | | | vpc:networks:update | -| | | | | -| | | | vpc:subnets:get | -| | | | | -| | | | vpc:subnets:update | -| | | | | -| | | | vpc:ports:create | -| | | | | -| | | | vpc:ports:update | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:networks:create | -| | | | | -| | | | vpc:subnets:create | -| | | | | -| | | | vpc:routers:get | -| | | | | -| | | | vpc:routers:update | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Deleting an ECS NIC (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id}/os-interface/{id} | ecs:serverInterfaces:use | ecs:serverInterfaces:get | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/os-interface/{id} | | ecs:servers:get | -| | | | | -| | | | vpc:networks:create | -| | | | | -| | | | vpc:subnets:create | -| | | | | -| | | | vpc:networks:get | -| | | | | -| | | | vpc:networks:update | -| | | | | -| | | | vpc:subnets:get | -| | | | | -| | | | vpc:subnets:update | -| | | | | -| | | | vpc:ports:delete | -| | | | | -| | | | vpc:ports:update | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:routers:get | -| | | | | -| | | | vpc:routers:update | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Querying ECS NICs (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/os-interface | ecs:serverInterfaces:get | vpc:ports:get | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-interface | | | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ -| Querying NIC Information About an ECS (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/os-interface/{id} | ecs:serverInterfaces:get | vpc:ports:get | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-interface/{id} | | | -+--------------------------------------------------------------+-----------------------------------------------------------------+----------------------------+--------------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/password_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/password_management.rst deleted file mode 100644 index 5f2ae8bd..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/password_management.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: en-us_topic_0161341998.html - -.. _en-us_topic_0161341998: - -Password Management -=================== - -+---------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+===========================================================================+==================================================================+============================+======================+ -| Obtaining the Password for Logging In to a Windows ECS (Native OpenStack) | GET /v2/{project_id}/servers/{server_id}/os-server-password | ecs:serverPasswords:manage | N/A | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-server-password | | | -+---------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------+----------------------+ -| Deleting the Password for Logging In to a Windows ECS (Native OpenStack) | DELETE /v2/{project_id}/servers/{server_id}/os-server-password | ecs:serverPasswords:manage | N/A | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/os-server-password | | | -+---------------------------------------------------------------------------+------------------------------------------------------------------+----------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/security_group_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/security_group_management.rst deleted file mode 100644 index 27b2249a..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/security_group_management.rst +++ /dev/null @@ -1,78 +0,0 @@ -:original_name: en-us_topic_0103072347.html - -.. _en-us_topic_0103072347: - -Security Group Management -========================= - -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Permission | API | Action | Dependent Permission | -+=========================================================================+============================================================================+========================+===============================+ -| Creating a Security Group (Native OpenStack API) | POST /v2/{project_id}/os-security-groups | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | POST /v2.1/{project_id}/os-security-groups | | vpc:securityGroups:create | -| | | | | -| | | | vpc:securityGroups:update | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Deleting a Security Group (Native OpenStack API) | DELETE /v2/{project_id}/os-security-groups/{security_group_id} | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | DELETE /v2.1/{project_id}/os-security-groups/{security_group_id} | | vpc:securityGroups:delete | -| | | | | -| | | | vpc:securityGroups:update | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Querying Details About a Security Group (Native OpenStack API) | GET /v2/{project_id}/os-security-groups/{security_group_id} | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | GET /v2.1/{project_id}/os-security-groups/{security_group_id} | | | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Querying Security Groups (Native OpenStack API) | GET /v2/{project_id}/os-security-groups | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | GET /v2.1/{project_id}/os-security-groups | | | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Creating a Security Group Rule (Native OpenStack API) | POST /v2/{project_id}/os-security-group-rules | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | POST /v2.1/{project_id}/os-security-group-rules | | vpc:securityGroups:update | -| | | | | -| | | | vpc:securityGroupRules:get | -| | | | | -| | | | vpc:securityGroupRules:create | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Deleting a Security Group Rule (Native OpenStack API) | DELETE /v2/{project_id}/os-security-group-rules/{security_group_rule_id} | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | DELETE /v2.1/{project_id}/os-security-group-rules/{security_group_rule_id} | | vpc:securityGroups:update | -| | | | | -| | | | vpc:securityGroupRules:get | -| | | | | -| | | | vpc:securityGroupRules:delete | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Updating Information About a Security Group (Native OpenStack API) | PUT /v2/{project_id}/os-security-groups/{security_group_id} | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | PUT /v2.1/{project_id}/os-security-groups/{security_group_id} | | vpc:securityGroups:update | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Querying Security Groups to Which an ECS Belongs (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/os-security-groups | ecs:securityGroups:use | vpc:securityGroups:get | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/os-security-groups | | | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Adding a Security Group (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:securityGroups:use | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | vpc:securityGroups:get | -| | | | | -| | | | vpc:securityGroups:create | -| | | | | -| | | | vpc:securityGroups:update | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:ports:update | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ -| Removing a Security Group (Native OpenStack API) | POST /v2/{project_id}/servers/{server_id}/action | ecs:securityGroups:use | ecs:servers:get | -| | | | | -| | POST /v2.1/{project_id}/servers/{server_id}/action | | vpc:securityGroups:get | -| | | | | -| | | | vpc:securityGroups:delete | -| | | | | -| | | | vpc:securityGroups:update | -| | | | | -| | | | vpc:ports:get | -| | | | | -| | | | vpc:ports:update | -+-------------------------------------------------------------------------+----------------------------------------------------------------------------+------------------------+-------------------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/specifications_query.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/specifications_query.rst deleted file mode 100644 index de25bc5c..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/specifications_query.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0103071522.html - -.. _en-us_topic_0103071522: - -Specifications Query -==================== - -+-------------------------------------------------------------------------+------------------------------------------------------------+----------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+=========================================================================+============================================================+============================+======================+ -| Querying Specifications and Expansion Details About ECSs | GET /v1/{project_id}/cloudservers/flavors | ecs:cloudServerFlavors:get | N/A | -+-------------------------------------------------------------------------+------------------------------------------------------------+----------------------------+----------------------+ -| Querying Details About **extra_specs** of an ECS (Native OpenStack API) | GET /v2/{project_id}/flavors/{flavors_id}/os-extra_specs | ecs:flavors:get | N/A | -| | | | | -| | GET /v2.1/{project_id}/flavors/{flavors_id}/os-extra_specs | | | -+-------------------------------------------------------------------------+------------------------------------------------------------+----------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/ssh_key_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/ssh_key_management.rst deleted file mode 100644 index 1ce9b9d3..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/ssh_key_management.rst +++ /dev/null @@ -1,26 +0,0 @@ -:original_name: en-us_topic_0103071515.html - -.. _en-us_topic_0103071515: - -SSH Key Management -================== - -+---------------------------------------------------------------+------------------------------------------------------+---------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+===============================================================+======================================================+===========================+======================+ -| Creating and Importing an SSH Key Pair (Native OpenStack API) | POST /v2/{project_id}/os-keypairs | ecs:serverKeypairs:create | N/A | -| | | | | -| | POST /v2.1/{project_id}/os-keypairs | | | -+---------------------------------------------------------------+------------------------------------------------------+---------------------------+----------------------+ -| Querying an SSH Key Pair (Native OpenStack API) | GET /v2/{project_id}/os-keypairs/{keypair_name} | ecs:serverKeypairs:get | N/A | -| | | | | -| | GET /v2.1/{project_id}/os-keypairs/{keypair_name} | | | -+---------------------------------------------------------------+------------------------------------------------------+---------------------------+----------------------+ -| Querying SSH Key Pairs (Native OpenStack API) | GET /v2/{project_id}/os-keypairs | ecs:serverKeypairs:list | N/A | -| | | | | -| | GET /v2.1/{project_id}/os-keypairs | | | -+---------------------------------------------------------------+------------------------------------------------------+---------------------------+----------------------+ -| Deleting an SSH Key Pair (Native OpenStack API) | DELETE /v2/{project_id}/os-keypairs/{keypair_name} | ecs:serverKeypairs:delete | N/A | -| | | | | -| | DELETE /v2.1/{project_id}/os-keypairs/{keypair_name} | | | -+---------------------------------------------------------------+------------------------------------------------------+---------------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/tag_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/tag_management.rst deleted file mode 100644 index 9366f293..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/tag_management.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0103071521.html - -.. _en-us_topic_0103071521: - -Tag Management -============== - -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+=============================================================+============================================================+=======================+======================+ -| Adding or Deleting Tags to or from an ECS in a Batch | POST /v1/{project_id}/cloudservers/{server_id}/tags/action | ecs:cloudServers:put | N/A | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying Project Tags | GET /v1/{project_id}/cloudservers/tags | ecs:cloudServers:list | N/A | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Adding Tags in a Batch | POST /v1/{project_id}/servers/{server_id}/tags/action | ecs:servers:setTags | N/A | -| | | | | -| Deleting Tags in a Batch | | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying ECSs by Tag | POST /v1/{project_id}/servers/resource_instances/action | ecs:servers:getTags | N/A | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying Project Tags | GET /v1/{project_id}/servers/tags | ecs:servers:getTags | N/A | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying Tags of an ECS | GET /v1/{project_id}/servers/{server_id}/tags | ecs:servers:getTags | N/A | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying Tags of a Specified ECS (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/tags | ecs:servers:getTags | ecs:servers:get | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/tags | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Adding a Tag to an ECS (Native OpenStack API) | PUT /v2/{project_id}/servers/{server_id}/tags/{tag} | ecs:servers:setTags | ecs:servers:get | -| | | | | -| | PUT /v2.1/{project_id}/servers/{server_id}/tags/{tag} | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Creating an ECS Tag (Native OpenStack API) | PUT /v2/{project_id}/servers/{server_id}/tags | ecs:servers:setTags | ecs:servers:get | -| | | | | -| | PUT /v2.1/{project_id}/servers/{server_id}/tags | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Deleting a Specified Tag from an ECS (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id}/tags/{tag} | ecs:servers:setTags | ecs:servers:get | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/tags/{tag} | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Querying an ECS Tag (Native OpenStack API) | GET /v2/{project_id}/servers/{server_id}/tags/{tag} | ecs:servers:getTags | ecs:servers:get | -| | | | | -| | GET /v2.1/{project_id}/servers/{server_id}/tags/{tag} | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ -| Deleting All ECS Tags (Native OpenStack API) | DELETE /v2/{project_id}/servers/{server_id}/tags | ecs:servers:setTags | ecs:servers:get | -| | | | | -| | DELETE /v2.1/{project_id}/servers/{server_id}/tags | | | -+-------------------------------------------------------------+------------------------------------------------------------+-----------------------+----------------------+ diff --git a/ecs/api-ref/result/permissions_policies_and_supported_actions/tenant_quota_management.rst b/ecs/api-ref/result/permissions_policies_and_supported_actions/tenant_quota_management.rst deleted file mode 100644 index 80994ffb..00000000 --- a/ecs/api-ref/result/permissions_policies_and_supported_actions/tenant_quota_management.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: en-us_topic_0103071517.html - -.. _en-us_topic_0103071517: - -Tenant Quota Management -======================= - -+----------------------------------------------------+---------------------------------------------------------------------+---------------------------+----------------------+ -| Permission | API | Action | Dependent Permission | -+====================================================+=====================================================================+===========================+======================+ -| Querying the Tenant Quota | GET /v1/{project_id}/cloudservers/limits | ecs:cloudServerQuotas:get | - | -+----------------------------------------------------+---------------------------------------------------------------------+---------------------------+----------------------+ -| Querying Quotas of a Tenant (Native OpenStack API) | GET /v2/{project_id}/os-quota-sets/{project_id}?user_id={user_id} | ecs:quotas:get | - | -| | | | | -| | GET /v2.1/{project_id}/os-quota-sets/{project_id}?user_id={user_id} | | | -+----------------------------------------------------+---------------------------------------------------------------------+---------------------------+----------------------+ -| Querying Default Quotas (Native OpenStack API) | GET /v2/{project_id}/os-quota-sets/{project_id}/defaults | ecs:quotas:get | - | -| | | | | -| | GET /v2.1/{project_id}/os-quota-sets/{project_id}/defaults | | | -+----------------------------------------------------+---------------------------------------------------------------------+---------------------------+----------------------+ diff --git a/ecs/dev/result/attaching_a_disk_to_an_ecs.rst b/ecs/dev/result/attaching_a_disk_to_an_ecs.rst deleted file mode 100644 index 7df60060..00000000 --- a/ecs/dev/result/attaching_a_disk_to_an_ecs.rst +++ /dev/null @@ -1,173 +0,0 @@ -:original_name: en-us_topic_0134192996.html - -.. _en-us_topic_0134192996: - -Attaching a Disk to an ECS -========================== - -Scenarios ---------- - -If the existing disks of an ECS fail to meet service requirements, for example, due to insufficient disk space or poor disk performance, you can attach more available disks to the ECS, or call the EVS disk creation API to create disks and attach them to the ECS. To attach an EVS disk to an ECS, you need to call the required API. - -.. note:: - - You can attach a data disk by setting the **data_volumes** parameter during ECS creation or attach a data disk after the ECS is created. This section describes how to attach a disk to a created ECS. - -Involved APIs -------------- - -Attaching a disk involves the following APIs: - -- API for creating an EVS disk -- API for attaching a disk to an ECS -- API for viewing disks attached to an ECS - -Procedure ---------- - -#. Create an EVS disk. - - a. Create an EVS disk. - - - API - - URI format: POST /v2/{tenant_id}/volumes - - For details, see section "Creating an EVS Disk (Native OpenStack API v2)" in *Elastic Cloud Server API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/volumes - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "volume": { - "name": "openapi_vol02", - "availability_zone": "eu-de-01", - "description": "create for api test", - "volume_type": "SATA", - "size": 40 - } - } - - - Response example - - .. code-block:: - - { - "volume": { - "status": "creating", - "user_id": "f79791beca3c48159ac2553fff22e166", - "attachments": [], - "links": [ - { - "href": "https://xxx/v2/74610f3a5ad941998e91f076297ecf27/volumes/51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "rel": "self" - }, - { - "href": "https://xxx/74610f3a5ad941998e91f076297ecf27/volumes/51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "rel": "bookmark" - } - ], - "availability_zone": "eu-de-01", - "bootable": "false", - "encrypted": false, - "created_at": "2018-05-16T11:19:33.992984", - "description": "create for api test", - "updated_at": null, - "volume_type": "SATA", - "name": "openapi_vol02", - "replication_status": "disabled", - "consistencygroup_id": null, - "source_volid": null, - "snapshot_id": null, - "shareable": false, - "multiattach": false, - "metadata": { - "__system__volume_name": "openapi_vol02" - }, - "id": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "size": 40 - } - } - - b. Record the **volume** ID in the response. - -#. Attach the disk to the ECS. - - - API - - URI format: POST /v2/{tenant_id}/servers/{server_id}/os-volume_attachments - - For details, see section "Attaching a Disk to an ECS" in *Elastic Cloud Server API Reference*. - - - Request example - - https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-volume_attachments - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "volumeAttachment": { - "volumeId": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "device": "/dev/sdb" - } - } - - - Response example - - .. code-block:: - - { - "volumeAttachment": { - "id": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "volumeId": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "serverId": "9f4d9281-95e7-4915-a126-1ee597101e2e", - "device": "/dev/sdb" - } - } - -#. Verify the disk attachment. - - - API - - URI format: GET /v2/{tenant_id}/servers/{server_id}/os-volume_attachments - - For details, see section "Querying Disks Attached to an ECS" in *Elastic Cloud Server API Reference*. - - - Request example - - https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-volume_attachments - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "volumeAttachments": [ - { - "volumeId": "4fc0b4cc-9d6c-431c-be70-3dfeec2ff6e0", - "id": "4fc0b4cc-9d6c-431c-be70-3dfeec2ff6e0", - "device": "/dev/sda", - "serverId": "9f4d9281-95e7-4915-a126-1ee597101e2e" - }, - { - "volumeId": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "id": "51f45e08-1d4f-44c6-a4a9-84a488e0e8d3", - "device": "/dev/sdb", - "serverId": "9f4d9281-95e7-4915-a126-1ee597101e2e" - } - ] - } diff --git a/ecs/dev/result/binding_a_nic_to_an_ecs.rst b/ecs/dev/result/binding_a_nic_to_an_ecs.rst deleted file mode 100644 index f056bf49..00000000 --- a/ecs/dev/result/binding_a_nic_to_an_ecs.rst +++ /dev/null @@ -1,309 +0,0 @@ -:original_name: en-us_topic_0134192997.html - -.. _en-us_topic_0134192997: - -Binding a NIC to an ECS -======================= - -Scenarios ---------- - -If an ECS requires multiple NICs, you can call the API for creating NICs and bind them to the ECS. - -.. note:: - - You can bind a NIC by setting the **nics** parameter during ECS creation or bind a NIC after the ECS is created. This section describes how to bind a NIC to a created ECS. - -Involved APIs -------------- - -Binding a NIC involves the following APIs: - -- API for creating a network -- API for creating a subnet -- API for creating a port -- API for binding a NIC to an ECS -- API for viewing ECS NICs - -Procedure ---------- - -#. Create a NIC. - - a. Create a network. - - - API - - URI format: POST /v2.0/networks - - For details, see section "Creating a Network" in *Virtual Private Cloud API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2.0/networks - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "network": { - "shared": false, - "name": "demo-net", - "admin_state_up": true, - "tenant_id": "74610f3a5ad941998e91f076297ecf27" - } - } - - - Response example - - .. code-block:: - - { - "network": { - "id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "name": "demo-net", - "status": "ACTIVE", - "shared": false, - "subnets": [], - "availability_zone_hints": [], - "availability_zones": [ - "eu-de-01", - "eu-de-02" - ], - "admin_state_up": true, - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "provider:network_type": "vxlan", - "router:external": false - } - } - - b. Record the **network** ID in the response. - c. Create a subnet. - - - API - - URI format: POST /v2.0/subnets - - For details, see section "Creating a Subnet" in *Virtual Private Cloud API Reference*. - - - Request example - - POST: https://{endpoint}/v2.0/subnets - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "subnet": { - "name": "testsubnet", - "enable_dhcp": true, - "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "dns_nameservers": [ - "8.8.8.8", - "8.8.8.7" - ], - "allocation_pools": [ - { - "start": "10.0.10.2", - "end": "10.0.10.254" - } - ], - "host_routes": [], - "ip_version": 4, - "gateway_ip": "10.0.10.1", - "cidr": "10.0.10.0/24" - } - } - - - Response example - - .. code-block:: - - { - "subnet": { - "name": "testsubnet", - "cidr": "10.0.10.0/24", - "id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", - "enable_dhcp": true, - "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "dns_nameservers": [ - "8.8.8.8", - "8.8.8.7" - ], - "allocation_pools": [ - { - "start": "10.0.10.2", - "end": "10.0.10.254" - } - ], - "host_routes": [], - "ip_version": 4, - "gateway_ip": "10.0.10.1" - } - } - - d. Record the **subnet** ID in the response. - e. Create a port. - - - API - - URI format: POST /v2.0/ports - - For details, see section "Creating a Port" in *Virtual Private Cloud API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2.0/ports - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "port": { - "admin_state_up": true, - - "fixed_ips": [ - { - "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5" - } - ], - "name": "test", - "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "tenant_id": "74610f3a5ad941998e91f076297ecf27" - } - } - - - Response example - - .. code-block:: - - { - "port": { - "id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4", - "name": "test", - "status": "DOWN", - "admin_state_up": true, - "fixed_ips": [ - { - "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", - "ip_address": "10.0.10.233" - } - ], - "mac_address": "fa:16:3e:db:91:f6", - "network_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "device_id": "", - "device_owner": "", - "security_groups": [ - "93031677-2895-4b83-855a-637e309aa9e6" - ], - "extra_dhcp_opts": [], - "allowed_address_pairs": [], - "binding:vnic_type": "normal", - "binding:vif_details": {}, - "binding:profile": {} - } - } - - f. Record the **port** ID in the response. - -#. Bind the NIC to the ECS. - - - API - - URI format: POST /v2/{tenant_id}/servers/{server_id}/os-interface - - For details, see section "Adding a NIC to an ECS" in *Elastic Cloud Server API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-interface - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "interfaceAttachment": { - "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4" - } - } - - - Response example - - .. code-block:: - - { - "interfaceAttachment": { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", - "ip_address": "10.0.10.233" - } - ], - "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4", - "net_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "mac_addr": "fa:16:3e:db:91:f6" - } - } - -#. Verify the NIC binding. - - - API - - URI format: GET /v2/{tenant_id}/servers/{server_id}/os-interface - - For details, see section "Querying ECS NICs" in *Elastic Cloud Server API Reference*. - - - Request example - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/9f4d9281-95e7-4915-a126-1ee597101e2e/os-interface - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "interfaceAttachments": [ - { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "46712fe4-25bd-4eae-874b-a528abfb76be", - "ip_address": "192.168.0.50" - } - ], - "port_id": "dd706739-b696-40be-a9f4-477ce478cb18", - "net_id": "17251a8f-a671-4d7c-85d9-af5415962994", - "mac_addr": "fa:16:3e:a5:e0:3c" - }, - { - "port_state": "ACTIVE", - "fixed_ips": [ - { - "subnet_id": "877b5567-e8c6-4a0d-aabf-0f13da225fe5", - "ip_address": "10.0.10.233" - } - ], - "port_id": "7bf1c36f-e7f8-478a-be3d-674b486abbc4", - "net_id": "c4a3019d-1ac0-4cfb-a838-2342eb992e6b", - "mac_addr": "fa:16:3e:db:91:f6" - } - ] - } diff --git a/ecs/dev/result/change_history.rst b/ecs/dev/result/change_history.rst deleted file mode 100644 index 9d0f069b..00000000 --- a/ecs/dev/result/change_history.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0134883593.html - -.. _en-us_topic_0134883593: - -Change History -============== - -+-----------------------------------+---------------------------------------------------------------------+ -| Release Date | What's New | -+===================================+=====================================================================+ -| 2021-10-20 | This issue is the second official release. | -| | | -| | Optimized descriptions in :ref:`Overview `. | -+-----------------------------------+---------------------------------------------------------------------+ -| 2018-11-08 | This issue is the first official release. | -+-----------------------------------+---------------------------------------------------------------------+ diff --git a/ecs/dev/result/creating_an_ecs.rst b/ecs/dev/result/creating_an_ecs.rst deleted file mode 100644 index 2d5f4fc2..00000000 --- a/ecs/dev/result/creating_an_ecs.rst +++ /dev/null @@ -1,440 +0,0 @@ -:original_name: en-us_topic_0134192987.html - -.. _en-us_topic_0134192987: - -Creating an ECS -=============== - -Scenarios ---------- - -An ECS with EVS disks is required. - -An ECS can be created using a disk or image. This section uses an image as an example to describe how to create an ECS. - -Involved APIs -------------- - -Creating an ECS involves viewing flavors and AZs as well as creating EVS disks. The following APIs are required: - -- API for viewing details about ECS flavors -- API for viewing details about images -- API for viewing networks -- API for creating and importing an SSH key pair -- API for creating an ECS -- API for viewing details about an ECS - -Procedure ---------- - -#. Determine the ECS flavor. - - a. View ECS flavors. - - - API - - URI format: GET /v2/{tenant_id}/flavors/detail{?minDisk,minRam,is_public,sort_key,sort_dir} - - The fields following the question mark (?) are optional for viewing flavors. For details, see section `Querying Details About ECS Flavors `__. - - - Request example - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/flavors/detail - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "flavors": [ - { - "name": "c1.2xlarge", - "links": [ - { - "href": "https://xxx/v2/74610f3a5ad941998e91f076297ecf27/flavors/c1.2xlarge", - "rel": "self" - }, - { - "href": "https://xxx/74610f3a5ad941998e91f076297ecf27/flavors/c1.2xlarge", - "rel": "bookmark" - } - ], - "ram": 8192, - "OS-FLV-DISABLED:disabled": false, - "vcpus": 8, - "swap": "", - "os-flavor-access:is_public": true, - "rxtx_factor": 1, - "OS-FLV-EXT-DATA:ephemeral": 0, - "disk": 0, - "id": "c1.2xlarge" - } - ] - } - - b. Select a flavor based on site requirements and record the flavor ID. - -#. Determine the image. - - a. View images. - - - API - - URI format: GET /v2/{tenant_id}/images/detail - - For details, see section "Querying Image Details" in *Elastic Cloud Server API Reference*. - - - Request example - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/images/detail - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "images": [ - { - "OS-EXT-IMG-SIZE:size": 0, - "metadata": { - "__os_type": "Linux", - "hw_vif_multiqueue_enabled": "true", - "__imagetype": "gold", - "__quick_start": "true", - "virtual_env_type": "FusionCompute", - "__support_xen": "true", - "__support_kvm": "true", - "__image_source_type": "uds", - "__platform": "EulerOS", - "__os_version": "EulerOS 2.2 64bit", - "__os_bit": "64", - "__isregistered": "false" - }, - "created": "2018-05-14T06:13:50Z", - "minRam": 0, - "name": "DBS-MySQL-Image_2.1.3.3", - "progress": 100, - "links": [ - { - "rel": "self", - "href": "https://None/v2/74610f3a5ad941998e91f076297ecf27/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4" - }, - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4" - }, - { - "rel": "alternate", - "href": "https://None/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4", - "type": "application/vnd.openstack.image" - } - ], - "id": "11e8f727-d439-4ed1-b3b8-33f46c0379c4", - "updated": "2018-05-14T06:13:52Z", - "minDisk": 40, - "status": "ACTIVE" - } - ] - } - - b. Select an image based on site requirements and record the image ID. - -#. Determine the network configuration. - - a. View networks. - - - API - - URI format: GET /v2/{tenant_id}/os-networks - - For details, see section "Querying Networks" in *Elastic Cloud Server API Reference*. - - - Request example - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/os-networks - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "networks": [ - { - "id": "07a9557d-4256-48ae-847c-415a9c8f7ff6", - "label": "b_tt3_td1b", - "broadcast": null, - "cidr": null, - "dns1": null, - "dns2": null, - "gateway": null, - "netmask": null, - "cidr_v6": null, - "gateway_v6": null, - "netmask_v6": null - } - ] - } - - b. Select a network based on site requirements and record the network ID. - -#. Set the login mode to key pair. - - a. Create a key pair. - - - API - - URI format: POST /v2/{tenant_id}/os-keypairs - - For details, see section "Creating and Importing an SSH Key Pair" in *Elastic Cloud Server API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/os-keypairs - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "keypair": { - "type": "ssh", - "name": "demo1", - "user_id": "fake" - } - } - - - Response example - - .. code-block:: - - { - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCrR5Gcwlh5ih7JOvzIUuQxS5qzWWPMYHeDXkDKSQ9W5pumOV05SiO3WCswnaQ5xMdOl31mNiHtwlwq9dJi7X6jJBB2shTD+00G5WuwkBbFU4CLvt1B44u0NUiaTJ35NAvW2/4XvpXm9OwiQ3B5ge6ZY7Esi38Unh+pkbhPkYxNBCK8yoOlojQhWs75abdxZBi811/8RwLcNiFiocA2RGxtRjBdpEScj+1TU+OcfZdQnr0AFbO11z7yxfIygwwzVTgUuJNbMbKHStQqRbklfMlHY4RBPQgb7RN/YaXKTQSXT84k+D9xlDNo7Wj4fwOJTOz/s/PvbIOqjRHt9D6Y4IKd Generated-by-Nova\n", - "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAq0eRnMJYeYoeyTr8yFLkMUuas1ljzGB3g15AykkPVuabpjld\nOUojt1grMJ2kOcTHTpd9ZjYh7cJcKvXSYu1+oyQQdrIUw/tNBuVrsJAWxVOAi77d\nQeOLtDVImkyd+TQL1tv+F76V5vTsIkNweYHumWOxLIt/FJ4fqZG4T5GMTQQivMqD\npaI0IVrO+Wm3cWQYvNdf/EcC3DYhYqHANkRsbUYwXaREnI/tU1PjnH2XUJ69ABWz\ntdc+8sXyMoMMM1U4FLiTWzGyh0rUKkW5JXzJR2OEQT0IG+0Tf2Glyk0El0/OJPg/\ncZQzaO1o+H8DiUzs/7Pz72yDqo0R7fQ+mOCCnQIDAQABAoIBAA6/c9dGmK2mae4z\nyQ5KrOFdvC1TNhej+sZx+CwyzEJUSvSuHcvQCXFBAz8FY92hhvPKcX66jINXZ+4/\nCmWAQ5YyhcRiow0Y91HvsS0bywoknX3q6kxBFodmyyCWFkgd5iMTADb1Lx0a27Y7\njlS4Dl5gyiGmxUN2Ng24wWEAjE8ZNuI0lrtr5IZKp+s5IAi/rb5AG/mL7EzicE8c\nmGP+QAa+nzwhAwNhFwVID230xen/ZcoL1d77hxeARNqJUxoR25gwJd6Ebg2y9pDW\nVu6cbbzgdGUCfQYlMEoAamAkCswOsDpVDBXwQnt2A537n6Wq2bgYIKusHr9thtxP\n/5ubQLUCgYEA4zYuBG2vtLHnvce26P8o2j1xcJS9K0ozkah9JFl3hqFN0sAqLlz7\n/Fm1jA4kzHJS3d0UqP3AMDxY3HkIqCn4Be7lqeAAe2AfqkOZpt9MDNv4VwKe9sPb\nViW1qjL3FxziLC/YWTRNSlpwRjqJJGhA+UQt8rOia1k/zXmrEs7bXLcCgYEAwPsu\nK3j5QoAiziYVMYf5iCzWwAM9Ljpf9gw23lefTdIzhhfFtJplVRSyxRGU0UZ84GMI\nTd5zmcIF/1KUfhqmeiQzz6NIPEYEReahjpQ/sOH/Gk5Rwr3QwYPrwAu5x+kk/SRi\nKPkqw7APTR0sMQBcUq+ZYwGYLGPMdd1zUdLfb0sCgYBkuz11iydtxb3G/obSD2WO\nM9VaIycmzRPFzNwGRH/gOR0mhTluKp0wyJjbSd34oeqpH/2r2ivddrOysxoqa8jg\n4IQDZyLvj7MaKjQxrieqP89+y9Or9TMFo1xB46x2G8EN8/xHuA9YGnZSPFtWv72m\nhRqV0hv82amWsA0vHnRUSwKBgDsKHXvrTMbNkNhkykMXCH5iyWiBFSyZa1ZJMlgf\nknsqfdzeVPwF6E55QKAN2uuTlwzG/3ljPxahR1hvmUJjQN9JSBiUKbtW6GPCRVbr\nf/jLi1Iu99COZdluVKeybqn8Z/aSNP24DR9FM8kxzZ1IMPaTBmhFypp6BclhcLBt\nxTG1AoGAfcrkVbV1SOy7fECUtMpUECcw0yU4GWj3sR2RbII63C500RVYQlUpUaRR\naANbASHTVR4myOKtGSxEUhAQHlxFDwsDL7W3gzAqTFbEDp1xAAUyT/nkOAhQjEm4\nORFdDETeXLQG1KMUj+8AdnhfYp3JTdft6rmPpZEBUFiCAUMAvb0=\n-----END RSA PRIVATE KEY-----\n", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "demo1", - "fingerprint": "57:a7:a2:ed:5f:aa:e7:54:62:2e:bb:e7:92:22:cb:40" - } - } - - b. Import the key pair. - - - API - - URI format: POST /v2/{tenant_id}/os-keypairs - - For details, see section "Creating and Importing an SSH Key Pair" in *Elastic Cloud Server API Reference*. - - - Request example - - POST: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/os-keypairs - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY8wMTdBYiJgi62o6eShoOlSKx3CZ3cE6PHisDblfK3Y0Bg7EHV7iV9c74pqsrIhK0xuGUuO1NxDQWbkwLTPN4F9Iy5CIYohLuMIpbln6LDtfRPpdhEh3lxL8MM61gyfpKzeKkwkEpSFj27Rgh6zCyJgBpkA2A0HTP737UlitahL4faCWDIS+Vj6mbcfkWiMhuMCzTZgSKAZ4PfoG4B5HJhR52C6A4XLiQFT9heh9gnIsIG+uTogTKUbcJKuN7M6AraJpul6eHhV9YI4433sDmuiBF/njvreVPWwAHlAkgT9I8q1T/cfEFiwzXpdGbkK5O8NC7K+qNbbdKihlahONt Generated-by-Nova\n", - "type": "ssh", - "name": "demo2", - "user_id": "fake" - } - } - - - Response example - - .. code-block:: - - { - "keypair": { - "public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDY8wMTdBYiJgi62o6eShoOlSKx3CZ3cE6PHisDblfK3Y0Bg7EHV7iV9c74pqsrIhK0xuGUuO1NxDQWbkwLTPN4F9Iy5CIYohLuMIpbln6LDtfRPpdhEh3lxL8MM61gyfpKzeKkwkEpSFj27Rgh6zCyJgBpkA2A0HTP737UlitahL4faCWDIS+Vj6mbcfkWiMhuMCzTZgSKAZ4PfoG4B5HJhR52C6A4XLiQFT9heh9gnIsIG+uTogTKUbcJKuN7M6AraJpul6eHhV9YI4433sDmuiBF/njvreVPWwAHlAkgT9I8q1T/cfEFiwzXpdGbkK5O8NC7K+qNbbdKihlahONt Generated-by-Nova\n", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "demo2", - "fingerprint": "dd:44:45:49:d9:f6:4f:c0:24:2d:81:aa:c4:4b:83:c2" - } - } - - c. Record the name in the response body, for example, **demo2**. - -#. Create an ECS authenticated using the key pair. - - - API - - URI format: POST /v2/{tenant_id}/servers - - For details about API constraints and request parameters, see section "Creating an ECS" in *Elastic Cloud Server API Reference*. - - .. note:: - - In this example, the ECS is created using a specified image. Therefore, - - - In **block_device_mapping_v2**, set **source_type** to **image**, **uuid** to the image ID, **destination_type** to **volume**, and **boot_index** to **0**. - - The **volume_size** must be greater than or equal to the minimum value specified in the image metadata. - - - Request example - - POST: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers - - Obtain the endpoint from `Regions and Endpoints `__. - - Body - - .. code-block:: - - { - "server": { - "flavorRef": "c1.large", - "name": "zttestvm1", - "block_device_mapping_v2": [{ - "source_type": "image", - "destination_type": "volume", - "volume_type": "SATA", - "volume_size": "40", - "delete_on_termination": "true", - "uuid": "11e8f727-d439-4ed1-b3b8-33f46c0379c4", - "boot_index": "0" - }], - "networks": [{ - "uuid": "fb68519f-a7c0-476e-98d4-2e4cf6de6def" - }], - "key_name": "demo2", - "availability_zone": "eu-de-01" - } - } - - - Response example - - .. code-block:: - - { - "server": { - "security_groups": [ - { - "name": "default" - } - ], - "OS-DCF:diskConfig": "MANUAL", - "links": [ - { - "rel": "self", - "href": "https://None/v2/74610f3a5ad941998e91f076297ecf27/servers/6d311127-bce1-48db-bf0f-cac9f8f7f077" - }, - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/6d311127-bce1-48db-bf0f-cac9f8f7f077" - } - ], - "id": "6d311127-bce1-48db-bf0f-cac9f8f7f077", - "adminPass": "WcC4QoVZPXpV" - } - } - -#. Verify the ECS creation. - - - API - - URI format: GET /v2/{tenant_id}/servers/{server_id} - - For details, see section "Querying Details About an ECS" in *Elastic Cloud Server API Reference*. - - - Request example - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6 - - Where, - - **0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6** is the UUID of the created ECS. - - Obtain the endpoint from `Regions and Endpoints `__. - - - Response example - - .. code-block:: - - { - "server": { - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "addresses": { - "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68": [ - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:88:01:1b", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.2.192", - "version": 4 - } - ] - }, - "metadata": {}, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-01", - "links": [ - { - "rel": "self", - "href": "https://None/v2/74610f3a5ad941998e91f076297ecf27/servers/0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6" - }, - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "0c71c0da-8852-4c56-a1d1-3a9b9bcb6da6", - "os-extended-volumes:volumes_attached": [ - { - "id": "b551445a-e749-4d53-932a-638a455cb6c3" - } - ], - "OS-EXT-SRV-ATTR:host": "pod1a.eude1", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/11e8f727-d439-4ed1-b3b8-33f46c0379c4" - } - ], - "id": "11e8f727-d439-4ed1-b3b8-33f46c0379c4" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2018-05-25T01:47:11Z", - "hostId": "b2792bef989888d2df1f51bff81de5ac58a4117f4e9ec3059c1a0410", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova001@36", - "key_name": null, - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/flavors/c1.large" - } - ], - "id": "c1.large" - }, - "security_groups": [ - { - "name": "default" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-001883cd", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "zttestvm1", - "progress": 0, - "OS-SRV-USG:launched_at": "2018-05-25T01:47:55.755922", - "updated": "2018-05-25T01:47:55Z", - "status": "ACTIVE" - } - } diff --git a/ecs/dev/result/index.rst b/ecs/dev/result/index.rst deleted file mode 100644 index d75400a1..00000000 --- a/ecs/dev/result/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -========== -Main Index -========== - -.. toctree:: - :maxdepth: 1 - - overview - notes - request_format/index - creating_an_ecs - modifying_ecs_specifications - attaching_a_disk_to_an_ecs - binding_a_nic_to_an_ecs - change_history diff --git a/ecs/dev/result/modifying_ecs_specifications.rst b/ecs/dev/result/modifying_ecs_specifications.rst deleted file mode 100644 index 721ed2dc..00000000 --- a/ecs/dev/result/modifying_ecs_specifications.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0134192993.html - -.. _en-us_topic_0134192993: - -Modifying ECS Specifications -============================ - -Scenarios ---------- - -When ECS specifications fail to meet service requirements, they can be modified, for example, by upgrading the vCPUs and memory. Certain ECSs also support changing ECS types. - -Constraints ------------ - -- You can modify the ECS specifications only when the ECS is stopped. -- The EVS disk capacity of the ECS cannot be reduced during the specifications modification. -- ECS specifications (vCPU or memory) reduction degrades the ECS performance. -- Certain ECSs do not support specifications modification. For details about available ECS types as well as their functions and usage on the public cloud, see section "Notes" in `Instances and Application Scenarios `__. - -Involved APIs -------------- - -Modifying ECS specifications involves the following APIs: - -- API for modifying the specifications of an ECS -- API for confirming ECS specifications modification -- API for rolling back ECS specifications modification - -Procedure ---------- - -#. Modify the ECS specifications. - - - API - - URI format: POST /v2/{tenant_id}/servers/{server_id}/action - - For details, see section "Modifying the Specifications of an ECS" in *Elastic Cloud Server API Reference*. - - - Request example - - .. code-block:: - - { - "resize": { - "flavorRef": "4" - } - } - - - Response example - - N/A - -#. Confirm the specifications modification. - - The ECS must be in **resized** state. That is, the **OS-EXT-STS:vm_state** value of the ECS must be **resized**. - - - API - - URI format: POST /v2/{tenant_id}/servers/{server_id}/action - - For details, see section "Confirming ECS Specifications Modification" in *Elastic Cloud Server API Reference*. - - - Request example - - .. code-block:: - - { - "confirmResize": null - } - - - Response example - - N/A - -#. (Optional) Roll back the specifications modification. - - Fallback notice: - - The ECS must be in **resized** state. That is, the **OS-EXT-STS:vm_state** value of the ECS must be **resized**. - - The data modified during specifications modification will be lost after the rollback. - - - API - - URI format: POST /v2/{tenant_id}/servers/{server_id}/action - - For details, see section "Rolling Back ECS Specifications Modification" in *Elastic Cloud Server API Reference*. - - - Request example - - .. code-block:: - - { - "revertResize": null - } - - - Response example - - N/A diff --git a/ecs/dev/result/notes.rst b/ecs/dev/result/notes.rst deleted file mode 100644 index 27b9f2b4..00000000 --- a/ecs/dev/result/notes.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0134327704.html - -.. _en-us_topic_0134327704: - -Notes -===== - -Before using ECS through APIs, learn how to call ECS APIs. For details about how to call REST APIs, see section `API Usage Guidelines `__. diff --git a/ecs/dev/result/overview.rst b/ecs/dev/result/overview.rst deleted file mode 100644 index f51d06f6..00000000 --- a/ecs/dev/result/overview.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0134192990.html - -.. _en-us_topic_0134192990: - -Overview -======== - -This document describes how to call the APIs of Elastic Cloud Server (ECS) to use ECS functions. The concepts related to ECS help you quickly learn this service. - -ECS ---- - -An ECS is a cloud server that allows on-demand allocation and elastic scaling to create an efficient, reliable, and secure computing environment. This ensures stable and uninterrupted operation of services. - -Basic Concepts --------------- - -- Region - - A region is a geographic area where resources used by ECSs are located. - -- Availability zone (AZ) - - An AZ is a physical location where power and networks are physically isolated within a region. Each AZ provides cost-effective and low-latency network connections that are unaffected by faults that may occur in other AZs. Each region contains one or more AZs. AZs are physically isolated but interconnected through an internal network. - -- Project - - A project groups and isolates OpenStack resources, such as computing, storage, and network resources. A project can be either a department or a project team. - - A tenant can create multiple projects. - -- Flavor - - Specifies hardware resources required for running an ECS, including the vCPUs, memory, and storage capacities. - -- Elastic Volume Service (EVS) - - Provides persistent block storage for computing services, such as ECS and Bare Metal Server (BMS). With advanced data redundancy and cache acceleration capabilities, EVS offers high availability and durability with a low latency. Users can format an EVS disk, create a file system on it, and store data persistently. - -- Image - - An image is an ECS template that contains an OS and may also contain application software (such as database software) and software configuration. - - Images can be public or private. Public images are provided by the system by default, and private images are manually created by users. Users can use any type of image to create an ECS. They can also create a private image using an existing ECS or external image. This provides users with a simple way to create ECSs that comply with their service requirements. - -- Virtual Private Cloud (VPC) - - VPC allows users to create private, isolated virtual networks. Users can define IP address segments, subnets, and security groups, assign EIPs, and allocate bandwidth in a VPC. diff --git a/ecs/dev/result/request_format/index.rst b/ecs/dev/result/request_format/index.rst deleted file mode 100644 index 4436d8bb..00000000 --- a/ecs/dev/result/request_format/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0134193004: - -============== -Request Format -============== - -.. toctree:: - :maxdepth: 1 - - versions - microversions - request_example diff --git a/ecs/dev/result/request_format/microversions.rst b/ecs/dev/result/request_format/microversions.rst deleted file mode 100644 index 5edec284..00000000 --- a/ecs/dev/result/request_format/microversions.rst +++ /dev/null @@ -1,289 +0,0 @@ -:original_name: en-us_topic_0134193006.html - -.. _en-us_topic_0134193006: - -Microversions -============= - -v2.1 APIs support microversions for small/medium API changes or document changes. - -Users can use a microversion to obtain the latest API microversion supported by a cloud service. A cloud service that has been upgraded to the latest microversion is compatible with the original microversions. Users can also use a microversion to obtain new cloud service properties. - -The version API returns the minimum and maximum microversions. The client uses the two values to specify the microversion range supported by an API. - -Microversion Response Example ------------------------------ - -If the values of **version** and **min_version** are null, the endpoint does not support microversions. - -- **version**: indicates the maximum microversion. -- **min_version**: indicates the minimum microversion. - -A microversion on the client must be within the range specified by **version** and **min_version** to access the endpoint. The client uses the following HTTP header to specify a microversion: - -X-OpenStack-Nova-API-Version: 2.4 - -Since microversion 2.27, the client can also use the following header to specify a microversion: - -Openstack-API-Version: compute 2.27 - -In the following response example, the maximum microversion is 2.14 and the minimum one is 2.1: - -.. code-block:: - - { - "versions": [ - { - "id": "v2.0", - "links": [ - { - "href": "http://openstack.example.com/v2/", - "rel": "self" - } - ], - "status": "SUPPORTED", - "version": "", - "min_version": "", - "updated": "2011-01-21T11:33:21Z" - }, - { - "id": "v2.1", - "links": [ - { - "href": "http://openstack.example.com/v2.1/", - "rel": "self" - } - ], - "status": "CURRENT", - "version": "2.14", - "min_version": "2.1", - "updated": "2013-07-23T11:33:21Z" - } - ] - } - -Microversion Request Example ----------------------------- - -For example, you are required to use the API for details about an ECS to view the **OS-EXT-SRV-ATTR:hostname** field. - -- **Using a v2 API without a microversion** - - - GET: https://*{endpoint}*/v2/74610f3a5ad941998e91f076297ecf27/servers/detail - - Obtain the endpoint from `Regions and Endpoints `__. - - - Headers - - ============ ================ - Content-Type application/json - X-Auth-Token ${token} - ============ ================ - - - Response body - - .. code-block:: - - { - "servers": [ - { - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "addresses": { - "05d4fb93-84e5-4964-853b-32992ffef627": [ - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.0.228", - "version": 4 - }, - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", - "OS-EXT-IPS:type": "floating", - "addr": "192.168.51.61", - "version": 4 - } - ] - }, - "metadata": {}, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-01", - "links": [ - { - "rel": "self", - "href": "https://None/v2.1/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" - }, - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "89c312bb-285a-4026-a237-d441908c2f9e", - "os-extended-volumes:volumes_attached": [ - { - "id": "c70c4b8e-33bd-4d1f-ab16-14a5a38cdeaf" - } - ], - "OS-EXT-SRV-ATTR:host": "pod05.eude01", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/1189efbf-d48b-46ad-a823-94b942e2a000" - } - ], - "id": "1189efbf-d48b-46ad-a823-94b942e2a000" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2018-05-11T03:21:56Z", - "hostId": "fc7a8ff86bac050f0d9454b1b078dcc97060e819acbf06f04c3e338f", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova012@7", - "key_name": "id_rsa", - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/flavors/s3.small.1" - } - ], - "id": "s3.small.1" - }, - "security_groups": [ - { - "name": "default" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-0016c624", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "zt-test", - "progress": 0, - "OS-SRV-USG:launched_at": "2018-05-11T03:22:16.701600", - "updated": "2018-05-11T03:22:51Z", - "status": "ACTIVE" - } - ] - } - - - Conclusion: The response body does not contain the **OS-EXT-SRV-ATTR:hostname** field. - -- **Using a v2.1 API with a microversion** - - - GET: https://*{endpoint}*/v2.1/74610f3a5ad941998e91f076297ecf27/servers/detail - - Obtain the endpoint from `Regions and Endpoints `__. - - - Headers - - ============================ ================ - Content-Type application/json - X-Auth-Token ${token} - X-OpenStack-Nova-API-Version 2.26 - ============================ ================ - - - Response body - - .. code-block:: - - { - "servers": [ - { - "tenant_id": "74610f3a5ad941998e91f076297ecf27", - "addresses": { - "05d4fb93-84e5-4964-853b-32992ffef627": [ - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.0.228", - "version": 4 - }, - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:20:17:95", - "OS-EXT-IPS:type": "floating", - "addr": "192.168.51.61", - "version": 4 - } - ] - }, - "metadata": {}, - "OS-EXT-STS:task_state": null, - "description": "zt-test", - "OS-EXT-SRV-ATTR:hostname": "zt-test", - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-01", - "links": [ - { - "rel": "self", - "href": "https://None/v2.1/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" - }, - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/servers/89c312bb-285a-4026-a237-d441908c2f9e" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "89c312bb-285a-4026-a237-d441908c2f9e", - "os-extended-volumes:volumes_attached": [ - { - "delete_on_termination": true, - "id": "c70c4b8e-33bd-4d1f-ab16-14a5a38cdeaf" - } - ], - "locked": false, - "OS-EXT-SRV-ATTR:kernel_id": "", - "OS-EXT-SRV-ATTR:host": "pod05.eude01", - "OS-EXT-SRV-ATTR:ramdisk_id": "", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/images/1189efbf-d48b-46ad-a823-94b942e2a000" - } - ], - "id": "1189efbf-d48b-46ad-a823-94b942e2a000" - }, - "accessIPv4": "", - "OS-SRV-USG:terminated_at": null, - "accessIPv6": "", - "OS-EXT-SRV-ATTR:launch_index": 0, - "created": "2018-05-11T03:21:56Z", - "OS-EXT-SRV-ATTR:user_data": null, - "hostId": "fc7a8ff86bac050f0d9454b1b078dcc97060e819acbf06f04c3e338f", - "OS-EXT-SRV-ATTR:reservation_id": "r-pbqmaxer", - "OS-EXT-SRV-ATTR:root_device_name": "/dev/vda", - "host_status": "UP", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova012@7", - "tags": [], - "key_name": "id_rsa", - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://None/74610f3a5ad941998e91f076297ecf27/flavors/s3.small.1" - } - ], - "id": "s3.small.1" - }, - "security_groups": [ - { - "name": "default" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-0016c624", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "zt-test", - "progress": 0, - "OS-SRV-USG:launched_at": "2018-05-11T03:22:16.701600", - "updated": "2018-05-11T03:22:51Z", - "status": "ACTIVE" - } - ] - } - - - Conclusion: The response body contains the **OS-EXT-SRV-ATTR:hostname** field. diff --git a/ecs/dev/result/request_format/request_example.rst b/ecs/dev/result/request_format/request_example.rst deleted file mode 100644 index 8a16e9f0..00000000 --- a/ecs/dev/result/request_format/request_example.rst +++ /dev/null @@ -1,246 +0,0 @@ -:original_name: en-us_topic_0134192984.html - -.. _en-us_topic_0134192984: - -Request Example -=============== - -#. .. _en-us_topic_0134192984__li1785204217617: - - Obtain a token. - - - POST: https://*{endpoint}*/v3/auth/tokens - - - Headers - - .. table:: **Table 1** Parameter description - - ============ ================ - Parameter Value - ============ ================ - Content-Type application/json - ============ ================ - - - Body - - .. code-block:: - - { - "auth":{ - "identity":{ - "password":{ - "user":{ - "name":"testuser", - "domain":{ - "id":"2aa29cbca17a4822abd096610e378ffa" - }, - "password":"Test@123" - } - }, - "methods":[ - "password" - ] - }, - "scope":{ - "project":{ - "id":"fb770eb43f934b5a8bda955642b954b9" - } - } - } - } - - Obtain the token (**x-subject-token**) in **Headers** - - .. _en-us_topic_0134192984__fig71433122328: - - .. figure:: /_static/images/en-us_image_0173496405.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Obtaining the token - -#. Initiate a request and access the API for viewing details about an ECS. - - - GET: https://*{endpoint}*/v2/fb770eb43f934b5a8bda955642b954b9/servers/detail - - - URI format: GET /v2/{tenant_id}/servers/detail{?changes-since,image,flavor,name,status,limit,marker,not-tags,reservation_id,all_tenants} - - tenant_id: fb770eb43f934b5a8bda955642b954b9 - - The fields, **changes-since,image,flavor,name,status,limit,marker,not-tags,reservation_id,all_tenants**, following the question mark (?) are optional for viewing an ECS. - - - Headers - - +--------------+----------------------------------------------------------------+ - | Content-Type | application/json | - +--------------+----------------------------------------------------------------+ - | X-Auth-Token | Obtained in :ref:`1 ` | - +--------------+----------------------------------------------------------------+ - - - Response body: JSON data in UTF-8 code format - - .. code-block:: - - { - "servers": [ - { - "tenant_id": "fb770eb43f934b5a8bda955642b954b9", - "addresses": { - "196b63ba-4201-4b55-b5aa-62ab6085d884": [ - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:82:2b:a0", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.1.10", - "version": 4 - }, - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:82:2b:a0", - "OS-EXT-IPS:type": "floating", - "addr": "192.168.213.134", - "version": 4 - } - ] - }, - "metadata": {}, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-02", - "links": [ - { - "rel": "self", - "href": "https://xxx/v2/fb770eb43f934b5a8bda955642b954b9/servers/0e56e372-31d4-40b6-8c85-d82a3cfeb05c" - }, - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/servers/0e56e372-31d4-40b6-8c85-d82a3cfeb05c" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "0e56e372-31d4-40b6-8c85-d82a3cfeb05c", - "os-extended-volumes:volumes_attached": [ - { - "id": "3e3fd674-a816-4602-8175-d9b2e20a65d5" - } - ], - "OS-EXT-SRV-ATTR:host": "pod01.eu-de-02", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/images/f3966520-45ce-45d3-b099-0123d1cd0043" - } - ], - "id": "f3966520-45ce-45d3-b099-0123d1cd0043" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2018-05-10T09:13:29Z", - "hostId": "1ee40e90e4774fc712d7e881d62ac5be9b05c9006504a69b9ab15aa0", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova005@7", - "key_name": null, - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/flavors/s2.small.1" - } - ], - "id": "s2.small.1" - }, - "security_groups": [ - { - "name": "default" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-0009d9c4", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "ecs-65a7", - "progress": 0, - "OS-SRV-USG:launched_at": "2018-05-10T12:11:10.803603", - "updated": "2018-05-10T12:11:10Z", - "status": "ACTIVE" - }, - { - "tenant_id": "fb770eb43f934b5a8bda955642b954b9", - "addresses": { - "21bcff3b-3a71-4304-ab62-dad0b305890e": [ - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:e8:ab:b2", - "OS-EXT-IPS:type": "fixed", - "addr": "192.168.0.79", - "version": 4 - }, - { - "OS-EXT-IPS-MAC:mac_addr": "fa:16:3e:e8:ab:b2", - "OS-EXT-IPS:type": "floating", - "addr": "192.168.218.86", - "version": 4 - } - ] - }, - "metadata": {}, - "OS-EXT-STS:task_state": null, - "OS-DCF:diskConfig": "MANUAL", - "OS-EXT-AZ:availability_zone": "eu-de-02", - "links": [ - { - "rel": "self", - "href": "https://xxx/v2/fb770eb43f934b5a8bda955642b954b9/servers/3e6388ea-3467-436e-b11f-4dddbc3dd810" - }, - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/servers/3e6388ea-3467-436e-b11f-4dddbc3dd810" - } - ], - "OS-EXT-STS:power_state": 1, - "id": "3e6388ea-3467-436e-b11f-4dddbc3dd810", - "os-extended-volumes:volumes_attached": [ - { - "id": "1bb5c0f6-300d-45c9-81f0-ad41736716de" - } - ], - "OS-EXT-SRV-ATTR:host": "pod01.eu-de-02", - "image": { - "links": [ - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/images/f1d75ee7-83bc-4e43-81fb-b69b4625fdea" - } - ], - "id": "f1d75ee7-83bc-4e43-81fb-b69b4625fdea" - }, - "OS-SRV-USG:terminated_at": null, - "accessIPv4": "", - "accessIPv6": "", - "created": "2018-01-27T10:01:35Z", - "hostId": "1ee40e90e4774fc712d7e881d62ac5be9b05c9006504a69b9ab15aa0", - "OS-EXT-SRV-ATTR:hypervisor_hostname": "nova005@7", - "key_name": null, - "flavor": { - "links": [ - { - "rel": "bookmark", - "href": "https://xxx/fb770eb43f934b5a8bda955642b954b9/flavors/s2.small.1" - } - ], - "id": "s2.small.1" - }, - "security_groups": [ - { - "name": "default" - } - ], - "config_drive": "", - "OS-EXT-STS:vm_state": "active", - "OS-EXT-SRV-ATTR:instance_name": "instance-00070c07", - "user_id": "f79791beca3c48159ac2553fff22e166", - "name": "ecs-terraformCLI", - "progress": 0, - "OS-SRV-USG:launched_at": "2018-05-10T10:19:04.709851", - "updated": "2018-05-10T10:19:04Z", - "status": "ACTIVE" - } - ] - } diff --git a/ecs/dev/result/request_format/versions.rst b/ecs/dev/result/request_format/versions.rst deleted file mode 100644 index d7d51000..00000000 --- a/ecs/dev/result/request_format/versions.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0134193005.html - -.. _en-us_topic_0134193005: - -Versions -======== - -OpenStack APIs are of version v2 or v2.1. The two versions use the same set of main code, and v2.1 supports microversions. diff --git a/ecs/umn/result/cbr/backing_up_ecs_data.rst b/ecs/umn/result/cbr/backing_up_ecs_data.rst deleted file mode 100644 index 0c8eb160..00000000 --- a/ecs/umn/result/cbr/backing_up_ecs_data.rst +++ /dev/null @@ -1,82 +0,0 @@ -:original_name: en-us_topic_0000001128604648.html - -.. _en-us_topic_0000001128604648: - -Backing Up ECS Data -=================== - -Scenarios ---------- - -CBR enhances data integrity and service continuity. For example, if an ECS or a EVS disk is faulty or a misoperation causes data loss, you can use data backups to quickly restore data. This section describes how to back up ECSs and EVS disks. - -For more information, :ref:`CBR Architecture `, :ref:`Backup Mechanism `, and :ref:`Backup Options `. - -You can back up ECS data using the Cloud Server Backup or Cloud Disk Backup function. - -- Cloud Server Backup (recommended): Use this backup function if you want to back up the data of all EVS disks (system and data disks) on an ECS. This prevents data inconsistency caused by time difference in creating a backup. -- Cloud Disk Backup: Use this backup function if you want to back up the data of one or more EVS disks (system or data disk) on an ECS. This minimizes backup costs on the basis of data security. - -ECS Backup Procedure --------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Locate the row that contains the target ECS. Click **More** in the **Operation** column and select **Manage Image/Disk > Create Backup**. - - - If the ECS has been associated with a vault, configure the backup information as prompted. - - - **Server List**: The ECS to be backed up is selected by default. - - **Name**: Customize your backup name. - - **Description**: Supplementary information about the backup. - - **Full Backup**: If this option is selected, the system will perform full backup for the ECS to be associated. The storage capacity used by the backup increases accordingly. - - - If the ECS is not associated with a vault, buy a vault first and then configure the backup information as prompted. - - For details, see *Cloud Backup and Recovery User Guide*. - -#. Click **OK**. The system automatically creates a backup for the ECS. - - On the **Backups** tab page, if the status of the backup is **Available**, the backup task is successful. - - The ECS can be restarted if the backup progress of an ECS exceeds 10%. However, to ensure data integrity, restart it after the backup is complete. - -EVS Disk Backup Procedure -------------------------- - -#. Log in to the management console. - -#. Click |image2| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Locate the row that contains the target ECS. Click **More** in the **Operation** column and select **Create Backup**. - - - If the ECS has been associated with a vault, configure the backup information as prompted. - - - **Server List**: The ECS to be backed up is selected by default. Click |image3| to view the disks attached to the ECSs. Select the disks to be backed up. - - **Name**: Customize your backup name. - - **Description**: Supplementary information about the backup. - - **Full Backup**: If this option is selected, the system will perform full backup for the disks to be associated. The storage capacity used by the backup increases accordingly. - - - If the ECS is not associated with a vault, buy a vault first and then configure the backup information as prompted. - - For details, see *Cloud Backup and Recovery User Guide*. - -#. Click **OK**. The system automatically creates a backup for the disk. - - On the **Backups** tab page, if the status of the backup is **Available**, the backup task is successful. - - If some files are deleted from the disk during the backup, the deleted files may fail to be backed up. Therefore, to ensure data integrity, delete the target data after the backup is complete. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0210779229.png - -.. |image3| image:: /_static/images/en-us_image_0000001128656892.png - :class: imgResize - diff --git a/ecs/umn/result/cbr/index.rst b/ecs/umn/result/cbr/index.rst deleted file mode 100644 index 8f3efc2c..00000000 --- a/ecs/umn/result/cbr/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0096304614: - -=== -CBR -=== - -.. toctree:: - :maxdepth: 1 - - overview - backing_up_ecs_data diff --git a/ecs/umn/result/cbr/overview.rst b/ecs/umn/result/cbr/overview.rst deleted file mode 100644 index f100d0a7..00000000 --- a/ecs/umn/result/cbr/overview.rst +++ /dev/null @@ -1,158 +0,0 @@ -:original_name: en-us_topic_0000001128445638.html - -.. _en-us_topic_0000001128445638: - -Overview -======== - -What Is CBR? ------------- - -Cloud Backup and Recovery (CBR) enables you to back up cloud servers and disks with ease. In case of a virus attack, accidental deletion, or software or hardware fault, you can restore data to any point in the past when the data was backed up. - -CBR protects your services by ensuring the security and consistency of your data. - -What Are the Differences Between Backup, Snapshot, and Image? -------------------------------------------------------------- - -You can use the cloud server backup function to create ECSs and the cloud disk backup function to create EVS disks. - -An image can be a system disk image, data disk image, or full-ECS image. - -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Backup Type | Backup Object | Application Scenario | Differences and Advantages | -+=====================+====================================================+================================================================================================================================================================================================================================================================================================+========================================================================================================================================================================================================================+ -| Cloud server backup | All disks (system and data disks) on an ECS | - **Hacker attacks and viruses** | All disks on an ECS are backed up at the same time, ensuring data consistency. | -| | | | | -| | | You can use cloud server backup to restore data to the latest backup point at which the ECS has not been affected by hacker attacks and viruses. | In addition, you can configure backup policies for automatic backup. | -| | | | | -| | | - **Accidental data deletion** | | -| | | | | -| | | You can use cloud server backup to restore data to the backup point prior to the accidental deletion. | | -| | | | | -| | | - **Application update errors** | | -| | | | | -| | | You can use cloud server backup to restore data to the backup point prior to the application update. | | -| | | | | -| | | - **System breakdown** | | -| | | | | -| | | You can use cloud server backup to restore an ECS to the backup point in time prior to system breakdown. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cloud disk backup | One or more specified disks (system or data disks) | - **Only data disks need to be backed up, because the system disk does not contain users' application data.** | Backup data is stored in OBS, instead of disks. This ensures data restoration upon disk data loss or corruption. | -| | | | | -| | | You can use cloud disk backup to back up and restore data if an EVS disk is faulty or encounters a logical error, for example, accidental deletion, hacker attacks, and virus infection. | Backup cost is reduced without compromising data security. | -| | | | | -| | | - **Use backups as baseline data.** | | -| | | | | -| | | After a backup policy has been set, the EVS disk data can be automatically backed up based on the policy. You can use the backups created on a timely basis as the baseline data to create new EVS disks or to restore the backup data to EVS disks. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Snapshot | One or more specified disks (system or data disks) | - **Routine data backup** | - The snapshot data is stored with the disk data to facilitate rapid data back up and restoration. | -| | | | - You can create snapshots to rapidly save disk data as it was at specified points in time. You can also use snapshots to create new disks so that the created disks will contain the snapshot data in the beginning. | -| | | You can create snapshots for disks on a timely basis and use snapshots to recover your data in case that data loss or data inconsistency occurred due to misoperations, viruses, or attacks. | | -| | | | | -| | | - **Rapid data restoration** | | -| | | | | -| | | You can create a snapshot or multiple snapshots before an application software upgrade or a service data migration. If an exception occurs during the upgrade or migration, service data can be rapidly restored to the time point when the snapshot was created. | | -| | | | | -| | | For example, if ECS A cannot be started due to a fault occurred in system disk A, you can create disk B using an existing snapshot of system disk A and attach disk B to a properly running ECS, for example ECS B. In this case, ECS B can read the data of system disk A from the disk B. | | -| | | | | -| | | - **Rapid deployment of multiple services** | | -| | | | | -| | | You can use a snapshot to create multiple EVS disks containing the same initial data, and these disks can be used as data resources for various services, | | -| | | | | -| | | for example data mining, report query, and development and testing. This method protects the initial data and creates disks rapidly, meeting the diversified service data requirements. | | -| | | | | -| | | .. note:: | | -| | | | | -| | | - A snapshot can be rolled back only to its source disk. Rollback to another disk is not possible. | | -| | | - If you have reinstalled or changed the ECS OS, snapshots of the system disk are automatically deleted. Snapshots of the data disks can be used as usual. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| System disk image | System disk | - **Rapid system recovery** | A system disk image can help an ECS with OS damaged to quickly change its OS. | -| | | | | -| | | You can create a system disk image for the system disk of an ECS before OS change, application software upgrade, or service data migration. If an exception occurs during the migration, you can use the system disk image to change ECS OS or create a new ECS. | | -| | | | | -| | | - **Rapid deployment of multiple services** | | -| | | | | -| | | You can use a system disk image to quickly create multiple ECSs with the same OS, thereby quickly deploying services these ECSs. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Data disk image | Specific data disk | **Rapid data replication** | A data disk image can replicate all data on a disk and create new EVS disks. The EVS disks can be attached to other ECSs for data replication and sharing. | -| | | | | -| | | You can use a data disk image to create multiple EVS disks containing the same initial data, and then attach these disks to ECSs to provide data resources for multiple services. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Full-ECS image | All disks (system and data disks) on an ECS | - **Rapid system recovery** | A full-ECS image facilitates service migration. | -| | | | | -| | | You can create a full-ECS image for the system disk and data disks of an ECS before OS change, application software upgrade, or service data migration. If an exception occurs during the migration, you can use the full-ECS image to change ECS OS or create a new ECS. | | -| | | | | -| | | - **Rapid deployment of multiple services** | | -| | | | | -| | | You can use a full-ECS image to quickly create multiple ECSs with the same OS and data, thereby quickly deploying services these ECSs. | | -+---------------------+----------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0000001128445638__section10399144613501: - -CBR Architecture ----------------- - -CBR consists of backups, vaults, and policies. - -- **Backup** - - A backup is a copy of a particular chunk of data and is usually stored elsewhere so that it may be used to restore the original data in the event of data loss. CBR supports the following backup types: - - - Cloud server backup: This type of backup uses the consistency snapshot technology for disks to protect data of ECSs and BMSs. The backups of servers without deployed databases are common server backups, and those of servers with deployed databases are application-consistent backups. - - Cloud disk backup: This type of backup provides snapshot-based data protection for EVS disks. - -- **Vault** - - CBR uses vaults to store backups. Before creating a backup, you need to create at least one vault and associate the resource you want to back up with the vault. Then the backup of the resource is stored in the associated vault. - - Vaults can be classified into two types: backup vaults and replication vaults. Backup vaults store backups, whereas replication vaults store replicas of backups. - - The backups of different types of resources must be stored in different types of vaults. - -- **Policy** - - Policies are divided into backup policies and replication policies. - - - Backup policies: To perform automatic backups, configure a backup policy by setting the execution times of backup tasks, the backup cycle, and retention rules, and then apply the policy to a vault. - - Replication policies: To automatically replicate backups or vaults, configure a replication policy by setting the execution times of replication tasks, the replication cycle, and retention rules, and then apply the policy to a vault. Replicas of backups must be stored in replication vaults. - -.. _en-us_topic_0000001128445638__section696712594578: - -Backup Mechanism ----------------- - -A full backup is performed only for the first backup and backs up all used data blocks. - -For example, if the size of a disk is 100 GB and the used space is 40 GB, the 40 GB of data is backed up. - -An incremental backup backs up only the data changed since the last backup, which is storage- and time-efficient. - -When a backup is deleted, only the data blocks that are not depended on by other backups are deleted, so that other backups can still be used for restoration. Both a full backup and an incremental backup can restore data to the state at a given backup point in time. - -When creating a backup of a disk, CBR also creates a snapshot for it. Every time a new disk backup is created, CBR deletes the old snapshot and keeps only the latest snapshot. - -CBR stores backup data in OBS, enhancing backup data security. - -.. _en-us_topic_0000001128445638__section533362013: - -Backup Options --------------- - -CBR supports one-off backup and periodic backup. A one-off backup task is manually created by users and is executed only once. Periodic backup tasks are automatically executed based on a user-defined backup policy. - -.. table:: **Table 1** One-off backup and periodic backup - - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Item | One-Off Backup | Periodic Backup | - +========================+========================================================================================================================================================================================================+=============================================================================================================================================+ - | Backup policy | Not required | Required | - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Number of backup tasks | One manual backup task | Periodic tasks driven by a backup policy | - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Backup name | User-defined backup name, which is **manualbk\_**\ *xxxx* by default | System-assigned backup name, which is **autobk\_**\ *xxxx* by default | - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Backup mode | Full backup for the first time and incremental backup subsequently, by default | Full backup for the first time and incremental backup subsequently, by default | - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Application scenario | Executed before patching or upgrading the OS or upgrading an application on a resource. A one-off backup can be used to restore the resource to the original state if the patching or upgrading fails. | Executed for routine maintenance of a resource. The latest backup can be used for restoration if an unexpected failure or data loss occurs. | - +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/change_history.rst b/ecs/umn/result/change_history.rst deleted file mode 100644 index fc91586c..00000000 --- a/ecs/umn/result/change_history.rst +++ /dev/null @@ -1,580 +0,0 @@ -:original_name: en-us_topic_0041169567.html - -.. _en-us_topic_0041169567: - -Change History -============== - -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Released On | Description | -+===================================+======================================================================================================================================================================================================================================================================================+ -| 2022-01-10 | Modified the following content: | -| | | -| | Added "Maximum NICs" in the following sections: | -| | | -| | - :ref:`General-Purpose ECSs ` | -| | - :ref:`Dedicated General-Purpose ECSs ` | -| | - :ref:`Memory-optimized ECSs ` | -| | - :ref:`GPU-accelerated ECSs ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-12-30 | Modified the following content: | -| | | -| | - Deleted the description that the Windows Server OS supports BYOL in :ref:`License Type `. | -| | - Added a note for the ECS name :ref:`Step 3: Configure Advanced Settings `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-11-20 | Added the following content: | -| | | -| | :ref:`Can ECSs Automatically Recover After the Physical Host Accommodating the ECSs Becomes Faulty? ` | -| | | -| | Modified the following content: | -| | | -| | - Added image encryption and system disk encryption in :ref:`User Encryption `. | -| | - Added description that ECSs can be created from encrypted images in :ref:`ECS and Other Services `. | -| | - Added description that the system disk can be encrypted during ECS creation in :ref:`Step 1: Configure Basic Settings `. | -| | - Added description that the system disk can be encrypted during OS reinstallation in :ref:`Reinstalling the OS `. | -| | - Added description that the system disk can be encrypted during OS change in :ref:`Changing the OS `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-10-20 | Optimized descriptions in :ref:`Step 1: Configure Basic Settings `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-09-10 | - Modified the following content: | -| | | -| | - Deleted description about Xen ECSs. | -| | | -| | - Deleted the following sections: | -| | | -| | - Changing a General-Purpose ECS to an H1 ECS | -| | - Changing a Xen ECS to a KVM ECS (Windows) | -| | - Automatically Changing a Xen ECS to a KVM ECS (Linux) | -| | - Manually Changing a Xen ECS to a KVM ECS (Linux) | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-08-09 | Modified the following content: | -| | | -| | - Added P2s ECSs in :ref:`GPU-accelerated ECSs `. | -| | - Added the URL for downloading the CUDA toolkit for P2s ECSs in :ref:`Obtaining a Tesla Driver and CUDA Toolkit `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-08-02 | Modified the following content: | -| | | -| | Deleted descriptions about Marketplace images from :ref:`Images ` and :ref:`Step 1: Configure Basic Settings `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2021-04-23 | Added the following content: | -| | | -| | Added :ref:`How Do I Configure atop and kdump on Linux ECSs for Performance Analysis? `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-11-12 | Modified the following content: | -| | | -| | - Changed CSBS to CBR in :ref:`ECS and Other Services `. | -| | - Added CBR to back up ECS data in :ref:`Step 3: Configure Advanced Settings `. | -| | - Added CBR to back up ECS data in :ref:`CBR `. | -| | - Added description in notes in :ref:`Migrating an ECS `, indicating that CBR backups are not affected by cold migrations. | -| | - Added a solution of using CBR in :ref:`Why Does It Take Longer to Create ECSs When I Use a Full-ECS Image? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-10-09 | Added the following content: | -| | | -| | Added the Windows Server 2019 Standard 64bit and Oracle Linux 7.6 64bit OSs supported by P2v ECSs in :ref:`GPU-accelerated ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-09-08 | Added the following content: | -| | | -| | - Added PI2 ECSs in :ref:`GPU-accelerated ECSs `. | -| | | -| | Modified the following content: | -| | | -| | - Added CPU information for KVM ECSs in :ref:`ECS Specifications `. | -| | - Terminated Windows OSs from the OSs supported by E1 and E2 ECSs in :ref:`Large-Memory ECSs `. | -| | - Modified :ref:`Basic ECS Metrics ` because the monitoring metric **System Status Check Failed** has been terminated. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-06-08 | Modified the following content: | -| | | -| | Added the procedure for changing the OS keyboard language in :ref:`What Should I Do If I Cannot Use the German Keyboard to Enter Characters When I Log In to a Linux ECS Using VNC? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-04-22 | Modified the following content: | -| | | -| | - Added m2.4xlarge.8 in :ref:`Memory-optimized ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2020-03-30 | Added the following content: | -| | | -| | - Added :ref:`GPU Driver ` to describe GRID and Tesla drivers. | -| | | -| | Modified the following content: | -| | | -| | - Optimized the operations for installing a Tesla driver and CUDA toolkit in :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. | -| | - Terminated the sections of installing a NVIDIA GPU driver and CUDA toolkit on P1, P2, and P2v ECSs and added :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS ` for installation. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-12-26 | Added the following content: | -| | | -| | - Added C4 series in :ref:`Dedicated General-Purpose ECSs `. | -| | - Added M4 series in :ref:`Memory-optimized ECSs `. | -| | - Added newly released E3 ECSs in :ref:`Large-Memory ECSs `. | -| | - Added G6 ECSs in :ref:`GPU-accelerated ECSs `. | -| | - Added P2v ECSs in :ref:`GPU-accelerated ECSs `. | -| | - Added :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. | -| | | -| | Modified the following content: | -| | | -| | - Changing a Xen ECS to a KVM ECS (Windows) | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-13 | Modified the following content: | -| | | -| | - Deleted E3 ECSs in :ref:`Large-Memory ECSs ` because they have been terminated. | -| | - Deleted "FPGA-accelerated ECSs" because such ECSs have been terminated. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-06 | Modified the following content: | -| | | -| | - Deleted metadata types that are not supported in :ref:`Obtaining Metadata `. | -| | - Added use restrictions in :ref:`Passing User Data to ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-05 | Deleted the following content: | -| | | -| | - Deleted FAQ "Why Are Certain Flavor Quotas Separately Displayed on the Quota Page?" | -| | - Deleted description of separately displayed quotas in :ref:`Quota Adjustment `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-03-04 | Modified the following content: | -| | | -| | - Modified the figure for ECS login modes in :ref:`Logging In to an ECS `. | -| | - Modified the flowchart in sections "Changing a Xen ECS to a KVM ECS (Windows)" and "Automatically Changing a Xen ECS to a KVM ECS (Linux)". | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-25 | Modified the following content: | -| | | -| | - Adjusted the format of information display for the step "(Optional) Select the check box to confirm the ECS configuration" in :ref:`General Operations for Modifying Specifications `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-22 | Modified the following content: | -| | | -| | - Added operation limitations after the ECS state changes from **Creating** to **Running** in :ref:`Creating an ECS `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-18 | Added the following content: | -| | | -| | - :ref:`How Can I Attach a Snapshot-based System Disk to an ECS as Its Data Disk? ` | -| | | -| | Modified the following content: | -| | | -| | - Why Are Certain Flavor Quotas Separately Displayed on the Quota Page? | -| | - Changed the ECS types that support changing from Xen to KVM in "Changing a Xen ECS to a KVM ECS (Windows)". | -| | - Changed the ECS types that support changing from Xen to KVM and the command for downloading the driver installation script in "Automatically Changing a Xen ECS to a KVM ECS (Linux)". | -| | - Added description about the impact on ECS backups and IDs after a cold migration in :ref:`Migrating an ECS `. | -| | - Added the information that OTC Tools has been installed for public images in :ref:`Basic ECS Metrics `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-13 | Modified the following content: | -| | | -| | Added EulerOS and SUSE 11 to the OSs that support automatic script operations in "Automatically Changing a Xen ECS to a KVM ECS (Linux)". | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-12 | Modified the following content: | -| | | -| | - Changed the URL for downloading the PV driver and UVP VMTools in "Changing a Xen ECS to a KVM ECS (Windows)". | -| | - Changed the URL for downloading the script in "Automatically Changing a Xen ECS to a KVM ECS (Linux)". | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-02-03 | Modified the following content: | -| | | -| | - Moved C3 ECSs to :ref:`Dedicated General-Purpose ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2019-01-30 | Added the following content: | -| | | -| | - Added the FPGA-accelerated ECS type. | -| | - Added :ref:`Migrating an ECS `. | -| | | -| | Modified the following content: | -| | | -| | - Changed monitoring metric names in :ref:`Basic ECS Metrics `. | -| | | -| | Deleted the following content: | -| | | -| | - Terminated T series of general computing-basic ECSs. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-30 | Added the following content: | -| | | -| | - Added newly released T series of general computing-basic ECSs. | -| | | -| | Modified the following content: | -| | | -| | - Added newly released E3 ECSs in :ref:`Large-Memory ECSs `. | -| | - Modified description in "Confirm Order" of :ref:`Creating an ECS `. | -| | - Modified the **Agency** description in :ref:`Creating an ECS `. | -| | - Modified order confirmation operations in :ref:`Creating an ECS `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-22 | Modified the following content: | -| | | -| | - Added DeH parameter description in :ref:`Creating an ECS `. | -| | - Modified the flowchart and follow-up operations in "Changing a Xen ECS to a KVM ECS (Windows)". | -| | - Modified the flowchart and follow-up operations in "Automatically Changing a Xen ECS to a KVM ECS (Linux)". | -| | - Added UVP in :ref:`Glossary `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-12 | Modified the following content: | -| | | -| | - Added description in :ref:`GPU-accelerated ECSs ` because P1 and P2 ECSs do not support automatic recovery. | -| | - :ref:`(Optional) Configuring Mapping Between Hostnames and IP Addresses ` | -| | - Installing a NVIDIA GPU Driver and CUDA Toolkit on a P1 ECS | -| | - Installing a NVIDIA GPU Driver and CUDA Toolkit on a P2 ECS | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-12-10 | Added the following content: | -| | | -| | - Changing a Xen ECS to a KVM ECS (Windows) | -| | - Automatically Changing a Xen ECS to a KVM ECS (Linux) | -| | | -| | Modified the following content: | -| | | -| | - Adjusted the structure of the document. | -| | - Modified the procedure for creating an ECS in :ref:`Getting Started `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-11-22 | KVM ECSs support automatic recovery. | -| | | -| | Added the following content: | -| | | -| | - Automatically Recovering ECSs | -| | | -| | Modified the following content: | -| | | -| | - :ref:`Creating an ECS ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-10-29 | Added the following content: | -| | | -| | - Why Are Certain Flavor Quotas Separately Displayed on the Quota Page? | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-30 | Modified the following content: | -| | | -| | - Updated supported images in :ref:`Enabling NIC Multi-Queue `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-09-22 | Modified the following content: | -| | | -| | - Optimized descriptions in :ref:`Can I Attach Multiple Disks to an ECS? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-31 | Accepted in OTC 3.2. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-08-17 | Added the following content: | -| | | -| | - :ref:`Quota Adjustment ` | -| | | -| | Modified the following content: | -| | | -| | - Added newly released E3 ECSs in :ref:`ECS Types ` and :ref:`Large-Memory ECSs `. | -| | - Modified description in :ref:`Can I Attach Multiple Disks to an ECS? `, allowing an ECS to have up to 60 attached disks. | -| | - Added the procedure for restarting the ECS in :ref:`How Can I Enable Virtual Memory on a Windows ECS? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-31 | Added the following content: | -| | | -| | - :ref:`Changing the Login Password on an ECS ` | -| | - :ref:`Enabling Advanced Disk ` | -| | - :ref:`What Should I Do If Cloud-Init Does Not Work After Python Is Upgraded? ` | -| | - :ref:`Why Does the System Display Error Code 0x112f When I Log In to a Windows ECS? ` | -| | - :ref:`How Can I Enable Virtual Memory on a Windows ECS? ` | -| | | -| | Modified the following content: | -| | | -| | - Modified description in :ref:`Large-Memory ECSs `, :ref:`Disk-intensive ECSs `, and :ref:`Can I Attach Multiple Disks to an ECS? `, allowing an ECS to have up to 60 attached disks. | -| | - Modified description in :ref:`Overview `, allowing the tags added during ECS creation to be automatically added to the created EIP and EVS disks. | -| | - Modified description in :ref:`CBR ` and :ref:`Why Does It Take Longer to Create ECSs When I Use a Full-ECS Image? ` to support full-ECS images. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-03 | Modified the following content: | -| | | -| | - Added the rules for the device names of the disks mounted to a disk-intensive ECS in :ref:`Attaching an EVS Disk to an ECS `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-07-01 | Added the following content: | -| | | -| | - :ref:`CTS ` | -| | - :ref:`How Can I Test Network Performance? ` | -| | - :ref:`Why Does an Authentication Failure Occurs After I Attempt to Remotely Log In to a Windows ECS? ` | -| | | -| | Modified the following content: | -| | | -| | - Allowed to export certain ECSs in :ref:`Exporting ECS Information `. | -| | - Modified prerequisites in :ref:`Changing the OS `, allowing you to change the OS of an ECS on which reinstalling the OS failed. | -| | - Modified description in :ref:`Changing a Security Group `, allowing you to change the security group in the **Operation** column. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-30 | Accepted in OTC 3.1. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-29 | Modified the following content: | -| | | -| | - Terminated the full-ECS image function. | -| | - Terminated FPGA-accelerated ECSs. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-22 | Modified *Elastic Cloud Server User Guide 38* according to review comments. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-14 | Added the following content: | -| | | -| | - Allowed to create ECSs using full-ECS images. | -| | | -| | Modified the following content: | -| | | -| | - Added description in :ref:`Disk-intensive ECSs ` because D2 ECSs do not support automatic recovery. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-06-01 | Modified the following content: | -| | | -| | - Modified FPGA-accelerated ECS specifications. | -| | - Deleted the DSS information. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-05-23 | Modified the following content: | -| | | -| | - Modified the specifications and functions of FPGA-accelerated ECSs. | -| | - Modified the overview, specifications, and functions of D2 ECSs as well as notes on using them in :ref:`Disk-intensive ECSs `. | -| | - Modified the description of automatic recovery. | -| | - Added the description of viewing details about failed tasks in :ref:`Viewing Failures `. | -| | - Added the FPGA, HDK, SDK, AEI, and DPDK terms in :ref:`Glossary `. | -| | - Modified the functions of and notes on using P2 ECSs in :ref:`GPU-accelerated ECSs `. | -| | - Added the OSs supported by P2 ECSs in installing a NVIDIA GPU driver and CUDA toolkit on the P2 ECSs. | -| | - Replaced screenshots in :ref:`How Do I Obtain My Disk Name in the ECS OS Using the Device Identifier Provided on the Console? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-04-28 | Added the following content: | -| | | -| | - Added newly released FPGA-accelerated ECSs. | -| | - Installing a NVIDIA GPU Driver and CUDA Toolkit on a P2 ECS | -| | - :ref:`Viewing Failures ` | -| | | -| | Modified the following content: | -| | | -| | - Added newly released D2 ECSs in :ref:`Disk-intensive ECSs `. | -| | - Added newly released P2 ECSs in :ref:`GPU-accelerated ECSs `. | -| | - Modified description in :ref:`General Operations for Modifying Specifications `, allowing you to check whether specifications have been modified. | -| | - Added description in "Automatically Recovering ECSs", allowing KVM ECSs to support automatic recovery. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-03-30 | Added the following content: | -| | | -| | - Added the mapping between device names and disks in :ref:`How Do I Obtain My Disk Name in the ECS OS Using the Device Identifier Provided on the Console? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-07 | Accepted in OTC 3.0. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-02-03 | Added the following content: | -| | | -| | - 6.7.2-Changing a General-Purpose ECS to an H1 ECS | -| | - Installing a NVIDIA GPU Driver and CUDA Toolkit on a P1 ECS | -| | - :ref:`What Can I Do If Switching from a Non-root User to User root Times Out? ` | -| | - :ref:`Why Is the Memory of an ECS Obtained by Running the free Command Inconsistent with the Actual Memory? ` | -| | | -| | Modified the following content: | -| | | -| | - Modified the document structure. | -| | - Allowed to modify specifications between general-purpose (S1, C1, C2, or M1) ECSs and H1 ECSs in :ref:`General Operations for Modifying Specifications `. | -| | - Updated the description and screenshots for selecting ECS types during ECS creation because the GUI has been modified. | -| | - Modified description in :ref:`Can I Attach Multiple Disks to an ECS? `, allowing you to attach up to 60 EVS disks to an ECS. | -| | - Modified default configurations during ECS creation in :ref:`Overview `. Specifically, no built-in tags will be created for an ECS by default. | -| | - Added "Follow-up Procedure" in :ref:`General Operations for Modifying Specifications `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-01-26 | Modified the following content: | -| | | -| | - Updated certain screenshots in this document. | -| | - Added notes on using M3 ECSs. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2018-01-19 | Modified the following content: | -| | | -| | - :ref:`Why Does the System Display a Question Mark When I Attempt to Obtain Console Logs? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-12-30 | Added the following content: | -| | | -| | - :ref:`How Can I Rectify the Fault That May Occur on a Linux ECS with an NVMe SSD Disk Attached? ` | -| | - :ref:`Why Does the System Display a Question Mark When I Attempt to Obtain Console Logs? ` | -| | | -| | Modified the following content: | -| | | -| | - Modified notes in :ref:`Enabling NIC Multi-Queue `. | -| | - Added C3, M3, and P1 ECSs in :ref:`ECS Types `. | -| | - Added the function of creating a disk using DSS resources. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-10-27 | Modified the following content: | -| | | -| | - Added computing I, computing II, and memory-optimized first-generation ECS types into the general-purpose ECS type in :ref:`ECS Types `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-10-18 | Modified the following content: | -| | | -| | - Changed the OSs supported by H2 and HL1 ECSs in :ref:`High-Performance Computing ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-10-06 | Modified the following content: | -| | | -| | - Added constraints on detaching an EVS disk from a running Windows ECS in :ref:`Detaching an EVS Disk from a Running ECS `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-30 | Added the following content: | -| | | -| | - :ref:`(Optional) Configuring Mapping Between Hostnames and IP Addresses ` | -| | - :ref:`How Can I Adjust System Disk Partitions? ` | -| | - :ref:`How Can I Add the Empty Partition of an Expanded System Disk to the End Root Partition Online? ` | -| | - :ref:`How Can I Add the Empty Partition of an Expanded System Disk to the Non-end Root Partition Online? ` | -| | - :ref:`Which ECSs Can Be Attached with SCSI EVS Disks? ` | -| | | -| | Modified the following content: | -| | | -| | - Added S2 ECSs in :ref:`General-Purpose ECSs `. | -| | - Added EVS disk device types in :ref:`EVS Disks `. | -| | - Modified description in :ref:`Reinstalling the OS ` and :ref:`Changing the OS `, allowing you to inject user data during ECS OS reinstallation or change. | -| | - Modified the description of managing virtual IP addresses in :ref:`General Operations for Modifying Specifications `. | -| | - Allowed attaching up to 24 EVS disks to an ECS in :ref:`Can I Attach Multiple Disks to an ECS? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-18 | Modified the following content: | -| | | -| | - Modified the overview, functions, and notes on using HL1 ECSs in :ref:`High-Performance Computing ECSs `. | -| | - Modified notes in "Automatically Recovering ECSs". | -| | - Added notes on using tools, such as ibstat in :ref:`How Can I Check Whether the Network Communication Is Normal Between Two ECSs Equipped with an InfiniBand NIC Driver? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-09-06 | Modified the following content: | -| | | -| | - Modified key description and added an image for the encryption process in :ref:`User Encryption `. | -| | - Added the official website for downloading TightVNC in :ref:`Login Overview `. | -| | - Added examples for configuring routing policies in :ref:`Can I Bind Multiple EIPs to an ECS? ` | -| | - Added description in :ref:`Will NICs Added to an ECS Start Automatically? `, indicating that only the NICs added to an ECS running the CentOS 7.0 OS requires manual activation. | -| | - :ref:`What Should I Do If I Cannot Use the German Keyboard to Enter Characters When I Log In to a Linux ECS Using VNC? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-08-22 | Added the following content: | -| | | -| | - Added automatic recovery. | -| | | -| | Modified the following content: | -| | | -| | - Modified description, indicating that SCSI EVS disks cannot be added during ECS creation. | -| | | -| | - Deleted the description of exporting the ECS list. | -| | - Changed the KVM ECS types to H2, M2, and HL1. | -| | - Confirmed and modified all issues in this document. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-08-11 | Added the following content: | -| | | -| | - Supported the multi-project function in :ref:`Project `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-07 | Modified the following content: | -| | | -| | - Modified notes on using H2 ECSs in :ref:`High-Performance Computing ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-06-05 | Modified the following content: | -| | | -| | - Added the description of built-in tags in :ref:`General Operations for Modifying Specifications `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-05-30 | Modified the following content: | -| | | -| | - Changed the OSs supported by large-memory ECSs in :ref:`Large-Memory ECSs `. | -| | - Changed the OSs supported by disk-intensive ECSs in :ref:`Disk-intensive ECSs `. | -| | - Added the **InfiniBand NIC status** metric in :ref:`Basic ECS Metrics `. | -| | - Added the description of adding, viewing, modifying, and deleting tags in :ref:`General Operations for Modifying Specifications `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-05-19 | Modified the following content: | -| | | -| | - Added **Marketplace image** to **Image** in :ref:`Step 1: Configure Basic Settings `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-05-08 | Added the following content: | -| | | -| | - :ref:`Obtaining ECS Console Logs ` | -| | - :ref:`Enabling NIC Multi-Queue ` | -| | - :ref:`How Can I Check Whether the Network Communication Is Normal Between Two ECSs Equipped with an InfiniBand NIC Driver? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-04-07 | Added the following content: | -| | | -| | - :ref:`How Can a Changed Static Hostname Take Effect Permanently? ` | -| | | -| | Modified the following content: | -| | | -| | - Added G2, M2, and H2 ECSs in :ref:`ECS Types `. | -| | | -| | - Modified H1 ECS specifications in :ref:`High-Performance Computing ECSs `. | -| | | -| | - Modified large-memory ECS specifications in :ref:`Large-Memory ECSs `. | -| | | -| | - Added the **System Status Check Failed** metric in :ref:`Basic ECS Metrics `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-03-09 | Modified the following content: | -| | | -| | - Changed the maximum number of tags that can be added to an ECS to 11, where 1 is automatically added by the system and the other 10 must be manually added. | -| | - Changed one tag-related screenshot due to GUI optimization. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-02-03 | Added the following content: | -| | | -| | - :ref:`Why Does a Key Pair Created Using puttygen.exe Fail to Be Imported on the Management Console? ` | -| | | -| | Modified the following content: | -| | | -| | - Modified the method of using **puttygen.exe** to generate key pairs in :ref:`Creating a Key Pair `. | -| | - Added description in :ref:`License Type `, indicating that the system does not support dynamic license type changing. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-01-27 | Modified the following content: | -| | | -| | - Deleted Ubuntu from the OSs supporting BYOL in :ref:`License Type `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-01-26 | Modified the following content: | -| | | -| | - Added full names of acronyms in :ref:`User Encryption `. | -| | - Changed the OSs supporting BYOL in :ref:`License Type ` and :ref:`Changing the OS `. | -| | | -| | - Added Red Hat Enterprise Linux. | -| | - Added the scope of Windows OSs for using BYOL. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-01-20 | Added the following content: | -| | | -| | - :ref:`License Type ` | -| | - :ref:`User Encryption ` | -| | - :ref:`Can All Users Use the Encryption Feature? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2017-01-16 | Modified the following content: | -| | | -| | - Added Marketplace image in :ref:`Images ` and :ref:`Step 1: Configure Basic Settings `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-10-09 | Added the following content: | -| | | -| | - :ref:`Managing ECS Groups ` | -| | - :ref:`Viewing ECS Creation Statuses ` | -| | - :ref:`Why Does the Failures Area Show an ECS Creation Failure But the ECS List Displays the Created ECS? ` | -| | | -| | Modified the following content: | -| | | -| | - Added information for remotely logging in to ECSs in :ref:`Login Using VNC `, :ref:`Login Using an SSH Key `, :ref:`Login Using an SSH Password `, and :ref:`Login Using MSTSC `. | -| | - Added document links to the default keyboard types of the ECSs created using public images in :ref:`Login Using VNC `. | -| | - Added notes on keyboard language settings for VNC-based ECS logins and the mapping between four types of keyboards in :ref:`Login Using VNC `. Provided configuration examples and links to related FAQs. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-30 | Modified the following content: | -| | | -| | - Added constraints in :ref:`Managing ECS Groups ` because ECS groups apply only to HANA ECSs and large-memory ECSs. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-28 | Added the following content: | -| | | -| | - :ref:`Can I Change the OS of an ECS? ` | -| | | -| | Modified the following content: | -| | | -| | - Deleted the FAQ that is not required any more because the preset Linux ECS username has been changed after Cloud-Init is supported. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-27 | Added the following content: | -| | | -| | - :ref:`Can I Attach Multiple Disks to an ECS? ` | -| | | -| | Modified the following content: | -| | | -| | - Modified the instructions to configure keyboard languages in VNC logins in :ref:`Login Using VNC `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-26 | Modified the following content: | -| | | -| | - Added the instructions to configure keyboard languages in VNC logins in :ref:`Login Using VNC `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-23 | Added the following content: | -| | | -| | - :ref:`Large-Memory ECSs ` | -| | - :ref:`Why Is the NIC Not Working? ` | -| | | -| | Modified the following content: | -| | | -| | - Added encryption algorithms and the method of using PuTTYgen to generate key pairs in :ref:`Creating a Key Pair `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-09-18 | Added the following content: | -| | | -| | - :ref:`Expanding the Local Disks of a Disk-intensive ECS ` | -| | - :ref:`What Is the cloudbase-init Account in Windows ECSs Used for? ` | -| | | -| | Modified the following content: | -| | | -| | - Added the description of interactive password reset scripts in :ref:`Resetting the Password for Logging In to a Linux ECS ` | -| | - Added notes on using various ECSs in :ref:`Memory-optimized ECSs `, :ref:`Disk-intensive ECSs `, and :ref:`High-Performance Computing ECSs `. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-08-25 | Added the following content: | -| | | -| | - :ref:`GPU-accelerated ECSs ` | -| | - :ref:`Disk-intensive ECSs ` | -| | - :ref:`Why Is the NIC Not Working? ` | -| | - :ref:`High-Performance Computing ECSs ` | -| | - :ref:`Detaching an EVS Disk from a Running ECS ` | -| | - :ref:`What Browser Version Is Required to Remotely Log In to an ECS? ` | -| | - :ref:`Why Does the Login to My Linux ECS Using a Key File Fail? ` | -| | - :ref:`Why Does the System Display a Message Indicating that the Password for Logging In to a Windows ECS Cannot Be Viewed? ` | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-07-15 | Added the following content: | -| | | -| | - Cloud-Init | -| | - Forcible ECS shutdown | -| | - Forcible ECS restarting | -| | - OS changing | -| | | -| | Modified the following content: | -| | | -| | - ECS login modes | -| | - OS reinstallation | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 2016-03-14 | This issue is the first official release. | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/cts/index.rst b/ecs/umn/result/cts/index.rst deleted file mode 100644 index a5a28df0..00000000 --- a/ecs/umn/result/cts/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0116266206: - -=== -CTS -=== - -.. toctree:: - :maxdepth: 1 - - viewing_tracing_logs diff --git a/ecs/umn/result/cts/viewing_tracing_logs.rst b/ecs/umn/result/cts/viewing_tracing_logs.rst deleted file mode 100644 index 2ee820d0..00000000 --- a/ecs/umn/result/cts/viewing_tracing_logs.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: en-us_topic_0116266207.html - -.. _en-us_topic_0116266207: - -Viewing Tracing Logs -==================== - -Scenarios ---------- - -CTS starts to record ECS operations after it is provisioned. You can view the operation records of the last seven days on the management console. - -This section describes how to view the operation records. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Click **Service List**. Under **Management & Deployment**, click **Cloud Trace Service**. - -#. In the navigation pane on the left, choose **Trace List**. - -#. Click **Filter** and specify filter criteria as needed. The following four filter criteria are available: - - - **Trace Source**, **Resource Type**, and **Search By** - - Select a filter criterion from the drop-down list. - - If you select **Trace name** for **Search By**, you need to select a specific trace name. - - If you select **Resource ID** for **Search By**, you need to select or enter a specific resource ID. - - When you select **Resource name** for **Search By**, you need to select or enter a specific resource name. - - - **Operator**: Select a specific operator (which is a user rather than the tenant). - - - **Trace Status**: Available options include **All trace statuses**, **normal**, **warning**, and **incident**. You can only select one of them. - - - **Time Range**: You can view traces generated during any time range of the last seven days. - -#. Expand the trace for details. - - .. _en-us_topic_0116266207__fig16725521195316: - - .. figure:: /_static/images/en-us_image_0116270059.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Expanding trace details - -#. Click **View Trace**. A dialog box is displayed, in which the trace structure details are displayed. - - For more information about CTS, see *Cloud Trace Service User Guide*. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/eips/binding_an_eip.rst b/ecs/umn/result/eips/binding_an_eip.rst deleted file mode 100644 index d100ca58..00000000 --- a/ecs/umn/result/eips/binding_an_eip.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: en-us_topic_0174917535.html - -.. _en-us_topic_0174917535: - -Binding an EIP -============== - -Scenarios ---------- - -You can assign an EIP and bind it to an ECS to enable the ECS to access the Internet. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **EIPs** tab and then **Bind EIP**. - -#. Select an EIP and click **OK**. - - .. note:: - - If no EIP is available in the current region, the EIP list is empty. In such a case, allocate an EIP and then bind it. - -#. View the bound EIP on the **EIPs** tab. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/eips/changing_an_eip_bandwidth.rst b/ecs/umn/result/eips/changing_an_eip_bandwidth.rst deleted file mode 100644 index e23f2acc..00000000 --- a/ecs/umn/result/eips/changing_an_eip_bandwidth.rst +++ /dev/null @@ -1,23 +0,0 @@ -:original_name: en-us_topic_0093492521.html - -.. _en-us_topic_0093492521: - -Changing an EIP Bandwidth -========================= - -Scenarios ---------- - -If an EIP has been bound to the ECS, the ECS can access the Internet using the bandwidth associated with the EIP. This section describes how to adjust the bandwidth of an ECS. - -Procedure ---------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select your region and project. -#. Under **Computing**, click **Elastic Cloud Server**. -#. Locate the row containing the target ECS. Click **More** in the **Operation** column and select **Manage Network** > **Modify Bandwidth**. -#. Change the bandwidth name, billing mode, or bandwidth size as prompted. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/eips/enabling_internet_connectivity_for_an_ecs_without_an_eip.rst b/ecs/umn/result/eips/enabling_internet_connectivity_for_an_ecs_without_an_eip.rst deleted file mode 100644 index 5344c753..00000000 --- a/ecs/umn/result/eips/enabling_internet_connectivity_for_an_ecs_without_an_eip.rst +++ /dev/null @@ -1,165 +0,0 @@ -:original_name: en-us_topic_0027157850.html - -.. _en-us_topic_0027157850: - -Enabling Internet Connectivity for an ECS Without an EIP -======================================================== - -Scenarios ---------- - -To ensure platform security and conserve EIPs, EIPs are assigned only to specified ECSs. ECSs without EIPs cannot access the Internet directly. If these ECSs need to access the Internet (for example, to perform a software upgrade or install a patch), you can select an ECS with an EIP bound to function as a proxy ECS, providing an access channel for these ECS. - -.. note:: - - NAT Gateway is recommended, which provides both the SNAT and DNAT functions for your ECSs in a VPC and allows the ECSs to access or provide services accessible from the Internet. - -Prerequisites -------------- - -- A proxy ECS with an EIP bound is available. -- The IP address of the proxy ECS is in the same network and same security group as the ECSs that need to access the Internet. - -Linux Proxy ECS ---------------- - -In this example, the proxy ECS runs CentOS 6.5. - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the search box above the upper right corner of the ECS list, enter the proxy ECS name for search. - -#. Click the name of the proxy ECS. The page providing details about the ECS is displayed. - -#. Click the **Network Interfaces** tab and then |image2|. Then, disable **Source/Destination Check**. - - By default, the source/destination check function is enabled. When this function is enabled, the system checks whether source IP addresses contained in the packets sent by ECSs are correct. If the IP addresses are incorrect, the system does not allow the ECSs to send the packets. This mechanism prevents packet spoofing, thereby improving system security. However, this mechanism prevents the packet sender from receiving returned packets. Therefore, disable the source/destination check. - -#. Log in to the proxy ECS. - - For more details, see :ref:`Login Overview `. - -#. Run the following command to check whether the proxy ECS can access the Internet: - - **ping www.google.com** - - The proxy ECS can access the Internet if information similar to the following is displayed: - - .. code-block:: - - 64 bytes from 220.181.111.148: icmp_seq=1 ttl=51 time=9.34 ms - 64 bytes from 220.181.111.148: icmp_seq=2 ttl=51 time=9.11 ms - 64 bytes from 220.181.111.148: icmp_seq=3 ttl=51 time=8.99 ms - -#. Run the following command to check whether IP forwarding is enabled on the proxy ECS: - - **cat /proc/sys/net/ipv4/ip_forward** - - - If **0** (disabled) is displayed, go to :ref:`10 `. - - If **1** (enabled), go to :ref:`16 `. - -#. .. _en-us_topic_0027157850__li51820417113959: - - Run the following command to open the IP forwarding configuration file in the vi editor: - - **vi /etc/sysctl.conf** - -#. Press **i** to enter editing mode. - -#. Set the **net.ipv4.ip_forward** value to **1**. - - Set the **net.ipv4.ip_forward** value to **1**. - - .. note:: - - If the **sysctl.conf** file does not contain the **net.ipv4.ip_forward** parameter, run the following command to add it: - - **echo net.ipv4.ip_forward=1 >> /etc/sysctl.conf** - -#. Press **Esc**, type **:wq**, and press **Enter**. - - The system saves the configurations and exits the vi editor. - -#. Run the following command to make the modification take effect: - - **sysctl -p /etc/sysctl.conf** - -#. Run the following commands to configure default **iptables** rules: - - **iptables -P INPUT ACCEPT** - - **iptables -P OUTPUT ACCEPT** - - **iptables -P FORWARD ACCEPT** - - .. caution:: - - Running **iptables -P INPUT ACCEPT** will set default INPUT policy to ACCEPT, which poses security risks. You are advised to set security group rules to restrict inbound access. - -#. .. _en-us_topic_0027157850__li49419571113959: - - Run the following command to configure source network address translation (SNAT) to enable ECSs in the same network segment to access the Internet through the proxy ECS: - - **iptables -t nat -A POSTROUTING -o eth0 -s** *subnet/netmask-bits* **-j SNAT --to** *nat-instance-ip* - - For example, if the proxy ECS is in network 192.168.125.0, the subnet mask has 24 bits, and the private IP address is 192.168.125.4, run the following command: - - **iptables -t nat -A POSTROUTING -o eth0 -s** *192.168.125.0/24* **-j SNAT --to 192.168.125.4** - - .. note:: - - To retain the preceding configuration even after the ECS is restarted, run the **vi /etc/rc.local** command to edit the **rc.local** file. Specifically, copy the rule described in step :ref:`16 ` into **rc.local**, press **Esc** to exit the editing mode, and enter **:wq** to save and exit the file. - -#. Run the following commands to save the iptables configuration and make it start up automatically upon ECS startup: - - **service iptables save** - - **chkconfig iptables on** - -#. Run the following command to check whether SNAT has been configured: - - **iptables -t nat --list** - - SNAT has been configured if information similar to :ref:`Figure 1 ` is displayed. - - .. _en-us_topic_0027157850__fig27598108113959: - - .. figure:: /_static/images/en-us_image_0027174005.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Successful SNAT configuration - -#. Add a route. - - a. Log in to the management console. - b. Click |image3| in the upper left corner and select your region and project. - c. Under **Network**, click **Virtual Private Cloud**. - d. Select a VPC to which a route is to be added and click **Route Tables**. On the **Route Tables** page, click **Add Route**. - e. Set route information on the displayed page. - - - **Destination**: indicates the destination network segment. The default value is **0.0.0.0/0**. - - - **Next Hop**: indicates the private IP address of the SNAT ECS. - - You can obtain the private IP address of the ECS on the **Elastic Cloud Server** page. - -#. To delete the added iptables rules, run the following command: - - **iptables -t nat -D POSTROUTING -o eth0 -s** *subnet/netmask-bits* **-j SNAT --to** *nat-instance-ip* - - For example, if the proxy ECS is in network segment 192.168.125.0, the subnet mask has 24 bits, and the private IP address is 192.168.125.4, run the following command: - - **iptables -t nat -D POSTROUTING -o eth0 -s 192.168.125.0/24 -j SNAT --to 192.168.125.4** - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0128851717.png - -.. |image3| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/eips/index.rst b/ecs/umn/result/eips/index.rst deleted file mode 100644 index 7fa950ef..00000000 --- a/ecs/umn/result/eips/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0140313883: - -==== -EIPs -==== - -.. toctree:: - :maxdepth: 1 - - binding_an_eip - changing_an_eip_bandwidth - enabling_internet_connectivity_for_an_ecs_without_an_eip diff --git a/ecs/umn/result/evs_disks/attaching_an_evs_disk_to_an_ecs.rst b/ecs/umn/result/evs_disks/attaching_an_evs_disk_to_an_ecs.rst deleted file mode 100644 index 1922c1f7..00000000 --- a/ecs/umn/result/evs_disks/attaching_an_evs_disk_to_an_ecs.rst +++ /dev/null @@ -1,81 +0,0 @@ -:original_name: en-us_topic_0096293655.html - -.. _en-us_topic_0096293655: - -Attaching an EVS Disk to an ECS -=============================== - -Scenarios ---------- - -If the existing disks of an ECS fail to meet service requirements, for example, due to insufficient disk space or poor disk performance, you can attach more available EVS disks to the ECS, or create more disks (**Storage** > **Elastic Volume Service**) and attach them to the ECS. - -Prerequisites -------------- - -- EVS disks are available. - - For instructions about how to create an EVS disk, see "Creating an EVS Disk" in *Elastic Volume Service User Guide*. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name, IP address, or ID for search. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Disks** tab. Then, click **Attach Disk**. - - The **Attach Disk** dialog box is displayed. - - .. _en-us_topic_0096293655__fig1332144315348: - - .. figure:: /_static/images/en-us_image_0096298046.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Attach Disk - -#. Select the target disk, specify the disk as the system disk or data disk. - - .. note:: - - - If no EVS disks are available, click **Create Disk** in the lower part of the list. - - For details about restrictions on attaching a disk, see :ref:`What Are the Requirements for Attaching an EVS Disk to an ECS? ` - - The device names for the local disks and EVS disks mounted to a disk-intensive ECS comply with the following rules: - - - System disk: Use sda or vda. - - Local disk: Use the device name following sda or vda in alphabetical order. - - EVS disk: Use the device name added in alphabetical order following those used by local disks. - -#. Click **OK**. - - After the disk is attached, you can view the information about it on the **Disks** tab. - - .. _en-us_topic_0096293655__fig18788918132718: - - .. figure:: /_static/images/en-us_image_0096298123.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Viewing the newly attached disk - -Follow-up Procedure -------------------- - -If the attached disk is newly created, the disk can be used only after it is initialized. - -For instructions about how to initialize a data disk, see :ref:`Scenarios and Disk Partitions `. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/evs_disks/detaching_an_evs_disk_from_a_running_ecs.rst b/ecs/umn/result/evs_disks/detaching_an_evs_disk_from_a_running_ecs.rst deleted file mode 100644 index c7582b31..00000000 --- a/ecs/umn/result/evs_disks/detaching_an_evs_disk_from_a_running_ecs.rst +++ /dev/null @@ -1,136 +0,0 @@ -:original_name: en-us_topic_0036046828.html - -.. _en-us_topic_0036046828: - -Detaching an EVS Disk from a Running ECS -======================================== - -Scenarios ---------- - -An EVS disk attached to an ECS can function as a system disk or data disk. - -- EVS disks mounted to **/dev/sda** or **/dev/vda** function as system disks. You can only detach system disks offline. Before detaching a system disk from an ECS, you must stop the ECS. -- EVS disks mounted to other locations function as data disks. In addition to offline detachment, data disks can be detached online if the OS running on the ECS supports this feature. - -This section describes how to detach a disk from a running ECS. - -Constraints ------------ - -- The EVS disk to be detached must be mounted at a location other than **/dev/sda** or **/dev/vda**. - - EVS disks mounted to **/dev/sda** or **/dev/vda** are system disks and cannot be detached from running ECSs. - -- Before detaching an EVS disk from a running Windows ECS, make sure that OTC Tools have been installed on the ECS and that the tools are running properly. - -- Before detaching an EVS disk from a running Windows ECS, ensure that no program is reading data from or writing data to the disk. Otherwise, data will be lost. - -- SCSI EVS disks cannot be detached from running Windows ECSs. - -- Before detaching an EVS disk from a running Linux ECS, you must log in to the ECS and run the **umount** command to cancel the association between the disk and the file system. In addition, ensure that no program is reading data from or writing data to the disk. Otherwise, detaching the disk will fail. - -Notes ------ - -- On a Windows ECS, if the disk is in non-offline state, the system forcibly detaches the EVS disk. If this occurs, the system may generate a xenvbd alarm. You can ignore this alarm. - - .. note:: - - To view the status of an EVS disk, perform the following operations: - - #. Click **Start** in the task bar. In the displayed **Start** menu, right-click **Computer** and choose **Manage** from the shortcut menu. - - The **Server Manager** page is displayed. - - #. In the navigation pane on the left, choose **Storage** > **Disk Management**. - - The EVS disk list is displayed in the right pane. - - #. View the status of each EVS disk. - -- Do not detach an EVS disk from an ECS that is being started, stopped, or restarted. -- Do not detach an EVS disk from a running ECS whose OS does not support this feature. OSs supporting EVS disk detachment from a running ECS are listed in :ref:`OSs Supporting EVS Disk Detachment from a Running ECS `. -- For a running Linux ECS, the drive letter may be changed after an EVS disk is detached from it and then attached to it again. This is a normal case due to the drive letter allocation mechanism of the Linux system. -- For a running Linux ECS, the drive letter may be changed after an EVS disk is detached from it and the ECS is restarted. This is a normal case due to the drive letter allocation mechanism of the Linux system. - -.. _en-us_topic_0036046828__section21417196143518: - -OSs Supporting EVS Disk Detachment from a Running ECS ------------------------------------------------------ - -OSs supporting EVS disk detachment from a running ECS include two parts: - -- For the first part, see `Formats and OSs Supported for External Image Files `__. - -- :ref:`Table 1 ` lists the second part of supported OSs. - - .. _en-us_topic_0036046828__table9271324195455: - - .. table:: **Table 1** OSs supporting EVS disk detachment from a running ECS - - +-----------------------------------------------------------------+-------------------------------------------+ - | OS | Version | - +=================================================================+===========================================+ - | CentOS | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 7.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.7 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Debian | 8.6.0 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 8.5.0 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Fedora | 25 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 24 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | SUSE | SUSE Linux Enterprise Server 12 SP2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 12 SP1 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 11 SP4 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | SUSE Linux Enterprise Server 12 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | OpenSUSE | 42.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 42.1 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Oracle Linux Server release | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 7.2 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.7 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Ubuntu Server | 16.04 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 14.04 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 14.04.4 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Windows (SCSI EVS disks cannot be detached from a running ECS.) | Windows Server 2008 R2 Enterprise 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | Windows Server 2012 R2 Standard 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | Windows Server 2016 R2 Standard 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | Red Hat Linux Enterprise | 7.3 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - | | 6.8 64bit | - +-----------------------------------------------------------------+-------------------------------------------+ - -.. note:: - - Online detachment is not supported by the ECSs running OSs not listed in the preceding table. For such ECSs, stop the ECSs before detaching disks from them to prevent any possible problems from occurring. - -Procedure ---------- - -#. On the **Elastic Cloud Server** page, click the name of the ECS from which the EVS disk is to be detached. The page providing details about the ECS is displayed. -#. Click the **Disks** tab. Locate the row containing the EVS disk to be detached and click **Detach**. diff --git a/ecs/umn/result/evs_disks/enabling_advanced_disk.rst b/ecs/umn/result/evs_disks/enabling_advanced_disk.rst deleted file mode 100644 index 9ae49bae..00000000 --- a/ecs/umn/result/evs_disks/enabling_advanced_disk.rst +++ /dev/null @@ -1,45 +0,0 @@ -:original_name: en-us_topic_0122307169.html - -.. _en-us_topic_0122307169: - -Enabling Advanced Disk -====================== - -Scenarios ---------- - -- Disk functions have been upgraded on the platform. Newly created ECSs can have up to 60 attached disks. However, an existing ECS can still have a maximum of 24 attached disks (40 for certain ECSs). To allow such ECSs to have up to 60 attached disks, enable advanced disk. -- After advanced disk is enabled, you can view the mapping between device names and disks. For details, see :ref:`How Do I Obtain My Disk Name in the ECS OS Using the Device Identifier Provided on the Console? ` - -This section describes how to enable advanced disk on an ECS. - -Procedure ---------- - -#. Log in to management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the name of the target ECS. The page providing details about the ECS is displayed. - -#. Click the **Disks** tab. - -#. View the current number of disks that can be attached to the ECS and enable advanced disk as prompted. - - The **Enable Advanced Disk** dialog box is displayed. - -#. Click **OK**. - -#. Stop and then start the target ECS. - - This operation allows advanced disk to take effect. - -#. Switch to the page providing details about the ECS again, click the **Disks** tab, and check whether the number of disks that can be attached to the ECS has been changed. - - - If yes, advanced disk has been enabled. - - If no, enabling advanced disk failed. In such a case, try again later or contact customer service. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/evs_disks/expanding_the_capacity_of_an_evs_disk.rst b/ecs/umn/result/evs_disks/expanding_the_capacity_of_an_evs_disk.rst deleted file mode 100644 index a91a8d9d..00000000 --- a/ecs/umn/result/evs_disks/expanding_the_capacity_of_an_evs_disk.rst +++ /dev/null @@ -1,29 +0,0 @@ -:original_name: en-us_topic_0093492522.html - -.. _en-us_topic_0093492522: - -Expanding the Capacity of an EVS Disk -===================================== - -Scenarios ---------- - -When your disk capacity is insufficient, you can handle the insufficiency by expanding the disk capacity. - -Procedure ---------- - -The capacity of an EVS disk can be expanded in either of the following ways: - -- Create an EVS disk and attach it to an ECS. - -- Expand the capacity of an existing EVS disk. The capacities of both system disks and data disks can be expanded. - - You can expand the disk capacities when the EVS disks are in the **In-use** or **Available** state. - - - Expanding an **In-use** EVS disk means that the to-be-expanded EVS disk has been attached to an ECS. Only certain ECS OSs support the expansion of **In-use** EVS disks. For details, see "Expanding an In-use EVS Disk" in *Elastic Volume Service User Guide*. - - Expanding an **Available** EVS disk means that the to-be-expanded EVS disk has not been attached to an ECS. For details, see "Expanding an Available EVS Disk" in *Elastic Volume Service User Guide*. - -.. note:: - - After the capacity is expanded through the management console, only the storage capacity of the EVS disk is expanded. To use the expanded capacity, you also need to log in to the ECS and expand the partition and file system. diff --git a/ecs/umn/result/evs_disks/expanding_the_local_disks_of_a_disk-intensive_ecs.rst b/ecs/umn/result/evs_disks/expanding_the_local_disks_of_a_disk-intensive_ecs.rst deleted file mode 100644 index 1c0a289b..00000000 --- a/ecs/umn/result/evs_disks/expanding_the_local_disks_of_a_disk-intensive_ecs.rst +++ /dev/null @@ -1,50 +0,0 @@ -:original_name: en-us_topic_0037470901.html - -.. _en-us_topic_0037470901: - -Expanding the Local Disks of a Disk-intensive ECS -================================================= - -Scenarios ---------- - -Disk-intensive ECSs can use both local disks and EVS disks to store data. Local disks are generally used to store service data and feature higher throughput than EVS disks. - -Disk-intensive ECSs do not support modifying specifications. Therefore, when the idle capacity of the local disks of such an ECS is insufficient, you must create a new disk-intensive ECS with higher specifications for capacity expansion. In such a case, the data stored in the original ECS can be migrated to the new ECS through an EVS disk. - -Procedure ---------- - -#. `Create an EVS disk `__ according to the volume of data to be migrated. - -#. Attach the EVS disk to the disk-intensive ECS. - -#. Back up the data stored in the local disks to the EVS disk that is newly attached to the disk-intensive ECS. - -#. .. _en-us_topic_0037470901__li19170660143341: - - Detach the EVS disk from the ECS. - - a. On the **Elastic Cloud Server** page, select this disk-intensive ECS and ensure that it is **Stopped**. - - If the ECS is in the **Running** state, choose **More** > **Stop** to stop it. - - b. Click the name of the disk-intensive ECS. The page providing details about the ECS is displayed. - - c. Click the **Disks** tab. Locate the row containing the EVS data disk and click **Detach** to detach the disk from the ECS. - -#. .. _en-us_topic_0037470901__li5892076615240: - - Ensure that a new disk-intensive ECS with higher specifications than the original one is available. - - The idle local disk capacity of the new ECS must meet service requirements. - -#. Attach the EVS disk to the new disk-intensive ECS. - - On the **Elastic Cloud Server** page, click the name of the ECS described in step :ref:`5 `. The page providing details about the ECS is displayed. - -#. Click the **Disks** tab. Then, click **Attach Disk**. - - In the displayed dialog box, select the EVS disk detached in step :ref:`4 ` and the device name. - -#. Migrate the data from the EVS disk to the local disks of the new disk-intensive ECS. diff --git a/ecs/umn/result/evs_disks/index.rst b/ecs/umn/result/evs_disks/index.rst deleted file mode 100644 index d68aa292..00000000 --- a/ecs/umn/result/evs_disks/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0092499770: - -========= -EVS Disks -========= - -.. toctree:: - :maxdepth: 1 - - attaching_an_evs_disk_to_an_ecs - detaching_an_evs_disk_from_a_running_ecs - expanding_the_capacity_of_an_evs_disk - expanding_the_local_disks_of_a_disk-intensive_ecs - enabling_advanced_disk diff --git a/ecs/umn/result/faqs/creation_and_deletion/can_i_forcibly_restart_or_stop_an_ecs.rst b/ecs/umn/result/faqs/creation_and_deletion/can_i_forcibly_restart_or_stop_an_ecs.rst deleted file mode 100644 index 9ed9b898..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/can_i_forcibly_restart_or_stop_an_ecs.rst +++ /dev/null @@ -1,25 +0,0 @@ -:original_name: en-us_topic_0029792884.html - -.. _en-us_topic_0029792884: - -Can I Forcibly Restart or Stop an ECS? -====================================== - -Yes. If an ECS remains in the **Restarting** or **Stopping** state for over 30 minutes after it is restarted, you can forcibly restart or stop the ECS as follows: - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Select the target ECS and click **Restart** or **Stop**. - - A dialog box is displayed to confirm whether you want to restart or stop the ECS. - -#. Select **Forcibly restart the preceding ECSs** or **Forcibly stop the preceding ECSs**. - -#. Click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/faqs/creation_and_deletion/can_i_provision_an_ecs_i_deleted.rst b/ecs/umn/result/faqs/creation_and_deletion/can_i_provision_an_ecs_i_deleted.rst deleted file mode 100644 index 30a23da7..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/can_i_provision_an_ecs_i_deleted.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0018073221.html - -.. _en-us_topic_0018073221: - -Can I Provision an ECS I Deleted? -================================= - -No. ECSs in the **Deleted** state cannot provide services and are soon removed from the system. - -A deleted ECS is retained in the ECS list on the management console only for a short period of time before it is permanently removed from the system. You can create a new ECS with the same specifications again. diff --git a/ecs/umn/result/faqs/creation_and_deletion/how_quickly_can_i_obtain_an_ecs.rst b/ecs/umn/result/faqs/creation_and_deletion/how_quickly_can_i_obtain_an_ecs.rst deleted file mode 100644 index 58231447..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/how_quickly_can_i_obtain_an_ecs.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: en-us_topic_0018073212.html - -.. _en-us_topic_0018073212: - -How Quickly Can I Obtain an ECS? -================================ - -Obtaining an ECS can take as little as a few minutes. - -The time it takes to obtain an ECS depends on ECS specifications, available resources (such as EVS disks and EIPs), and system load. - -.. note:: - - If it takes a long time to obtain your ECS, contact customer service. diff --git a/ecs/umn/result/faqs/creation_and_deletion/index.rst b/ecs/umn/result/faqs/creation_and_deletion/index.rst deleted file mode 100644 index 1781ebc7..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0018073208: - -===================== -Creation and Deletion -===================== - -.. toctree:: - :maxdepth: 1 - - why_does_the_failures_area_show_an_ecs_creation_failure_but_the_ecs_list_displays_the_created_ecs - why_does_it_take_longer_to_create_ecss_when_i_use_a_full-ecs_image - how_quickly_can_i_obtain_an_ecs - what_happens_after_i_click_the_delete_button - can_i_provision_an_ecs_i_deleted - can_i_forcibly_restart_or_stop_an_ecs diff --git a/ecs/umn/result/faqs/creation_and_deletion/what_happens_after_i_click_the_delete_button.rst b/ecs/umn/result/faqs/creation_and_deletion/what_happens_after_i_click_the_delete_button.rst deleted file mode 100644 index 846c3e5a..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/what_happens_after_i_click_the_delete_button.rst +++ /dev/null @@ -1,15 +0,0 @@ -:original_name: en-us_topic_0018073218.html - -.. _en-us_topic_0018073218: - -What Happens After I Click the **Delete** Button? -================================================= - -After you click **Delete**, the selected ECS is deleted. You can also choose to delete the EVS disk and EIP of the ECS. If you do not delete them, they will be retained. If necessary, you can manually delete them later. - -To delete an ECS, perform the following operations: - -#. Log in to the management console. -#. Under **Computing**, click **Elastic Cloud Server**. -#. Select the ECS to be deleted. -#. In the upper part of the ECS list, click **Delete**. diff --git a/ecs/umn/result/faqs/creation_and_deletion/why_does_it_take_longer_to_create_ecss_when_i_use_a_full-ecs_image.rst b/ecs/umn/result/faqs/creation_and_deletion/why_does_it_take_longer_to_create_ecss_when_i_use_a_full-ecs_image.rst deleted file mode 100644 index cf3aed54..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/why_does_it_take_longer_to_create_ecss_when_i_use_a_full-ecs_image.rst +++ /dev/null @@ -1,73 +0,0 @@ -:original_name: en-us_topic_0102391480.html - -.. _en-us_topic_0102391480: - -Why Does It Take Longer to Create ECSs When I Use a Full-ECS Image? -=================================================================== - -Symptom -------- - -When you use a full-ECS image that was created using a CSBS backup to create ECSs, the process is time-consuming or the system displays a message indicating that the image cannot be used to rapidly create ECSs. - -Cause Analysis --------------- - -If your full-ECS image is in the old backup format provided by CSBS, this issue occurs. - -.. note:: - - - CSBS has a new backup format. You can rapidly create ECSs if the full-ECS image is in this format - - This issue does not occur if a full-ECS image is created using a CBR backup. - -Solution Using CBR ------------------- - -If you want to use a full-ECS image to rapidly create ECSs, ensure that the full-ECS image is created using a CSBS backup in the new format. The procedure is as follows: - -- Scenario 1: The ECS based on which the target CSBS backup is created is available. - - In such a case, use the ECS to create a CBR backup and use this backup to create a full-ECS image. You can use this full-ECS image to rapidly create ECSs. - - - For instructions about how to back up an ECS, see *Cloud Backup and Recovery User Guide*. - - For instructions about how create a full-ECS image, see *Image Management Service User Guide*. - -- Scenario 2: The ECS based on which the target CSBS backup is created is unavailable. - - #. Use the full-ECS image to create a new ECS. - - #. Use an ECS to create a CBR backup. - - For details, see *Cloud Backup and Recovery User Guide*. - - #. Use the CBR backup to create a full-ECS image. - - For details, see *Image Management Service User Guide*. - - You can use the full-ECS image to rapidly create ECSs. - -Solution( Using CSBS) ---------------------- - -If you want to use a full-ECS image to rapidly create ECSs, ensure that the full-ECS image is created using a CSBS backup in the new format. The procedure is as follows: - -- Scenario 1: The ECS based on which the target CSBS backup is created is available. - - Back up the original ECS on the **Cloud Server Backup Service** page and use the new format to create a full-ECS image. You can use this full-ECS image to rapidly create ECSs. - - - For instructions about how to back up an ECS, see *Cloud Server Backup Service User Guide*. - - For instructions about how create a full-ECS image, see *Image Management Service User Guide*. - -- Scenario 2: The ECS based on which the target CSBS backup is created is unavailable. - - #. Use the full-ECS image to create a new ECS. - - #. Back up the ECS. - - For details, see *Cloud Server Backup Service User Guide*. - - #. Use the CSBS backup to create a full-ECS image. - - For details, see *Image Management Service User Guide*. - - You can use the full-ECS image to rapidly create ECSs. diff --git a/ecs/umn/result/faqs/creation_and_deletion/why_does_the_failures_area_show_an_ecs_creation_failure_but_the_ecs_list_displays_the_created_ecs.rst b/ecs/umn/result/faqs/creation_and_deletion/why_does_the_failures_area_show_an_ecs_creation_failure_but_the_ecs_list_displays_the_created_ecs.rst deleted file mode 100644 index 5da488d6..00000000 --- a/ecs/umn/result/faqs/creation_and_deletion/why_does_the_failures_area_show_an_ecs_creation_failure_but_the_ecs_list_displays_the_created_ecs.rst +++ /dev/null @@ -1,19 +0,0 @@ -:original_name: en-us_topic_0039524582.html - -.. _en-us_topic_0039524582: - -Why Does the Failures Area Show an ECS Creation Failure But the ECS List Displays the Created ECS? -================================================================================================== - -Symptom -------- - -After you created an ECS bound with an EIP on the management console, the ECS creation was successful but binding the EIP failed due to insufficient EIPs. Although the **Failures** area showed that the ECS creation failed, the ECS was displayed in the ECS list. The results of the ECS creation task were inconsistent. - -Root Cause ----------- - -- The ECS list displays created ECSs. -- The **Failures** area shows the ECS creation status, including the statuses of subtasks, such as creating ECS resources and binding an EIP. Only when all subtasks are successful, the ECS is created. - -If the ECS is created but EIP binding failed, the task failed. However, the ECS you created is temporarily displayed in the list. After the system rolls back, the ECS is removed from the list. diff --git a/ecs/umn/result/faqs/database_applications/can_a_database_be_deployed_on_an_ecs.rst b/ecs/umn/result/faqs/database_applications/can_a_database_be_deployed_on_an_ecs.rst deleted file mode 100644 index 3920d10a..00000000 --- a/ecs/umn/result/faqs/database_applications/can_a_database_be_deployed_on_an_ecs.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0018078507.html - -.. _en-us_topic_0018078507: - -Can a Database Be Deployed on an ECS? -===================================== - -Yes. There is no limitation on this operation. You can deploy a database of any type on an ECS. diff --git a/ecs/umn/result/faqs/database_applications/does_an_ecs_support_oracle_databases.rst b/ecs/umn/result/faqs/database_applications/does_an_ecs_support_oracle_databases.rst deleted file mode 100644 index f9b59a6b..00000000 --- a/ecs/umn/result/faqs/database_applications/does_an_ecs_support_oracle_databases.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0018078509.html - -.. _en-us_topic_0018078509: - -Does an ECS Support Oracle Databases? -===================================== - -Yes. You are advised to perform a performance test beforehand to ensure that the Oracle database can meet your requirements. diff --git a/ecs/umn/result/faqs/database_applications/index.rst b/ecs/umn/result/faqs/database_applications/index.rst deleted file mode 100644 index efe39393..00000000 --- a/ecs/umn/result/faqs/database_applications/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0018124789: - -===================== -Database Applications -===================== - -.. toctree:: - :maxdepth: 1 - - can_a_database_be_deployed_on_an_ecs - does_an_ecs_support_oracle_databases diff --git a/ecs/umn/result/faqs/disk_management/can_all_users_use_the_encryption_feature.rst b/ecs/umn/result/faqs/disk_management/can_all_users_use_the_encryption_feature.rst deleted file mode 100644 index ee510a27..00000000 --- a/ecs/umn/result/faqs/disk_management/can_all_users_use_the_encryption_feature.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: en-us_topic_0047272493.html - -.. _en-us_topic_0047272493: - -Can All Users Use the Encryption Feature? -========================================= - -The rights of users in a user group to use the encryption feature are as follows: - -- The user who has security administrator rights can grant KMS access rights to EVS for using the encryption feature. -- When a common user who does not have security administrator rights attempts to use the encryption feature, the condition varies depending on whether the user is the first one in the user group to use this feature. - - - If the common user is the first one in the user group to use the encryption feature, the common user must request a user who has security administrator rights to grant the common user permissions. Then, the common user can use the encryption feature. - - If the common user is not the first one in the user group to use the encryption feature, the user will have the permission to use the encryption feature. - -The following section uses a user group as an example to describe how to grant KMS access rights to EVS for using the encryption feature. - -For example, a user group shown in :ref:`Figure 1 ` consists of four users, user 1 to user 4. User 1 has security administrator rights. Users 2, 3, and 4 are common users who do not have security administrator rights. - -.. _en-us_topic_0047272493__fig10921739155249: - -.. figure:: /_static/images/en-us_image_0047273062.png - :alt: **Figure 1** User group - :figclass: vsd - - - **Figure 1** User group - -Scenario 1: User 1 Uses the Encryption Feature ----------------------------------------------- - -In this user group, if user 1 uses the encryption feature for the first time, the procedure is as follows: - -#. User 1 creates Xrole to grant KMS access permissions to EVS. - - After user 1 grants permissions, the system automatically creates CMK **evs/default** for encrypting EVS disks. - - .. note:: - - When user 1 uses the encryption feature for the first time, the user must grant the KMS access permissions to EVS. Then, all the users in the user group can use the encryption feature by default. - -#. User 1 selects a key. - - One of the following keys can be used: - - - Default CMK, **evs/default** - - CMK, the key created before using the EVS disk encryption feature - - Newly created key (For instructions about how to create a key, see "Creating a Key Pair" in *Key Management Service User Guide*.) - -After user 1 uses the encryption feature, all other users in the user group can use this feature, without requiring to contact user 1 for rights granting. - -Scenario 2: Common User Uses the Encryption Feature ---------------------------------------------------- - -In this user group, when user 3 uses the encryption feature for the first time: - -#. The system displays a message indicating that the user has no rights. -#. User 3 asks user 1 to create Xrole to grant KMS access permissions to EVS. - -After user 1 grants the permissions, user 3 and all other users in the user group can use the encryption feature by default. diff --git a/ecs/umn/result/faqs/disk_management/can_i_attach_multiple_disks_to_an_ecs.rst b/ecs/umn/result/faqs/disk_management/can_i_attach_multiple_disks_to_an_ecs.rst deleted file mode 100644 index b382efc7..00000000 --- a/ecs/umn/result/faqs/disk_management/can_i_attach_multiple_disks_to_an_ecs.rst +++ /dev/null @@ -1,56 +0,0 @@ -:original_name: en-us_topic_0018073215.html - -.. _en-us_topic_0018073215: - -Can I Attach Multiple Disks to an ECS? -====================================== - -Yes. The ECSs created after the disk function upgrade can have up to 60 attached disks. - -- When you create an ECS, you can attach 24 disks to it. -- After you create an ECS, you can attach up to 60 disks to it. - - .. table:: **Table 1** Numbers of disks that can be attached to a newly created ECS - - +---------------------+-------------------+--------------------+------------------------------------------------------------------------------+ - | ECS Type | Maximum VBD Disks | Maximum SCSI Disks | Constraint | - +=====================+===================+====================+==============================================================================+ - | KVM | 24 | 59 | VBD disks + SCSI disks ≤ 60 (This constraint does not apply to local disks.) | - | | | | | - | (excluding D2 ECSs) | | | The number of local disks is determined based on the ECS flavor. | - +---------------------+-------------------+--------------------+------------------------------------------------------------------------------+ - | D2 | 24 | 30 | VBD disks + SCSI disks ≤ 54 (This constraint does not apply to local disks.) | - | | | | | - | | | | The number of local disks is determined based on the ECS flavor. | - +---------------------+-------------------+--------------------+------------------------------------------------------------------------------+ - - .. note:: - - - The system disk of an ECS is of VBD type. Therefore, the maximum number of SCSI disks is 59. - - For a D-series KVM ECS, its local disks use two SCSI controllers, indicating that 30 SCSI drive letters are used. Therefore, a maximum of 30 SCSI disks can be attached to such an ECS. - -The maximum number of disks that you can attach to an ECS that was created before the disk function upgrade remains unchanged, as shown in :ref:`Table 2 `. - -.. _en-us_topic_0018073215__table3150162605720: - -.. table:: **Table 2** Numbers of disks that can be attached to an existing ECS - - +-------------------+--------------------+---------------------+-----------------------------+ - | Maximum VBD Disks | Maximum SCSI Disks | Maximum Local Disks | Constraint | - +===================+====================+=====================+=============================+ - | 24 | 23 | 59 | VBD disks + SCSI disks ≤ 24 | - +-------------------+--------------------+---------------------+-----------------------------+ - -To attach 60 disks, enable advanced disk. For details, see :ref:`Enabling Advanced Disk `. - -How Can I Check Whether an ECS Is Created Before or After the Disk Function Upgrade? ------------------------------------------------------------------------------------- - -#. Log in to management console. -#. Under **Computing**, click **Elastic Cloud Server**. -#. Click the name of the target ECS. The page providing details about the ECS is displayed. -#. Click the **Disks** tab. -#. Check the number of disks that can be attached to the ECS to determine the total number of disks. - - - If the total number of disks that can be attached is 24 (including the system disk), the ECS is created before the disk function upgrade. In such a case, you can enable advanced disk as prompted so that up to 60 disks can be attached to the ECS. For details, see :ref:`Enabling Advanced Disk `. - - If the total number of disks that can be attached is 60 (including the system disk), the ECS is created after the disk function upgrade. diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_end_root_partition_online.rst b/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_end_root_partition_online.rst deleted file mode 100644 index 7ca3565f..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_end_root_partition_online.rst +++ /dev/null @@ -1,87 +0,0 @@ -:original_name: en-us_topic_0078300749.html - -.. _en-us_topic_0078300749: - -How Can I Add the Empty Partition of an Expanded System Disk to the End Root Partition Online? -============================================================================================== - -Scenarios ---------- - -If the capacity of system disk partitions is inconsistent with the actual system disk capacity after an ECS is created, you can add the empty partition to the root partition of the system disk. - -This section describes how to add the empty partition to the end root partition online. - -Procedure ---------- - -In the following operations, the ECS that runs CentOS 6.5 64bit and has a 50 GB system disk is used as an example. The system disk has two partitions, **/dev/xvda1: swap** and **/dev/xvda2: root**, and the root partition is the end partition. - -#. Run the following command to view disk partitions: - - **parted -l /dev/xvda** - - .. code-block:: - - [root@sluo-ecs-5e7d ~]# parted -l /dev/xvda - Disk /dev/xvda: 53.7GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - - Number Start End Size Type File system Flags - 1 1049kB 4296MB 4295MB primary linux-swap(v1) - 2 4296MB 42.9GB 38.7GB primary ext4 boot - -#. Run the following command to obtain the file system type and UUID: - - **blkid** - - .. code-block:: - - /dev/xvda1: UUID="25ec3bdb-ba24-4561-bcdc-802edf42b85f" TYPE="swap" - /dev/xvda2: UUID="1a1ce4de-e56a-4e1f-864d-31b7d9dfb547" TYPE="ext4" - -#. Run the following command to install the growpart tool: - - This tool may be integrated in the **cloud-utils-growpart/cloud-utils/cloud-initramfs-tools/cloud-init** package. Run the **yum install cloud-\*** command to ensure it is available. - - **yum install cloud-utils-growpart** - -#. Run the following command to expand the root partition (the second partition) using growpart: - - **growpart /dev/xvda 2** - - .. code-block:: - - [root@sluo-ecs-5e7d ~]# growpart /dev/xvda 2 - CHANGED: partition=2 start=8390656 old: size=75495424 end=83886080 new: size=96465599,end=104856255 - -#. Run the following command to verify that online capacity expansion is successful: - - **parted -l /dev/xvda** - - .. code-block:: - - [root@sluo-ecs-5e7d ~]# parted -l /dev/xvda - Disk /dev/xvda: 53.7GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - - Number Start End Size Type File system Flags - 1 1049kB 4296MB 4295MB primary linux-swap(v1) - 2 4296MB 53.7GB 49.4GB primary ext4 boot - -#. Run the following command to expand the capacity of the file system: - - **resize2fs -f $Partition name** - - Suppose the partition name is **/dev/xvda2**, run the following command: - - .. code-block:: - - [root@sluo-ecs-a611 ~]# resize2fs -f /dev/xvda2 - resize2fs 1.42.9 (28-Dec-2013) - Filesystem at /dev/xvda2 is mounted on /; on-line resizing required - old_desc_blocks = 3, new_desc_blocks = 3 - .... - [root@sluo-ecs-a611 ~] # df -hT //Check file system capacity expansion diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_non-end_root_partition_online.rst b/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_non-end_root_partition_online.rst deleted file mode 100644 index 42133c6d..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_non-end_root_partition_online.rst +++ /dev/null @@ -1,200 +0,0 @@ -:original_name: en-us_topic_0078300750.html - -.. _en-us_topic_0078300750: - -How Can I Add the Empty Partition of an Expanded System Disk to the Non-end Root Partition Online? -================================================================================================== - -Scenarios ---------- - -If the capacity of system disk partitions is inconsistent with the actual system disk capacity after an ECS is created, you can add the empty partition to the root partition of the system disk. - -This section describes how to add the empty partition to the non-end root partition online. - -Procedure ---------- - -In the following operations, the ECS that runs CentOS 6.5 64bit and has a 100 GB system disk is used as an example. The system disk has two partitions, **/dev/xvda1: root** and **/dev/xvda2: swap**, and the root partition is not the end partition. - -#. Run the following command to view disk partitions: - - **parted -l /dev/xvda** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# parted -l /dev/xvda - Disk /dev/xvda: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - Disk Flags: - - Number Start End Size Type File system Flags - 1 1049kB 41.0GB 40.9GB primary ext4 boot - 2 41.0GB 42.9GB 2000MB primary linux-swap(v1) - - The first is the root partition, and the second is the swap partition. - -#. View and edit the fstab partition table to delete the swap partition attaching information. - - a. Run the following command to view the fstab partition table: - - **tail -n 3 /etc/fstab** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# tail -n 3 /etc/fstab - # - UUID=7c4fce5d-f8f7-4ed6-8463-f2bd22d0ddea / ext4 defaults 1 1 - UUID=5de3cf2c-30c6-4fb2-9e63-830439d4e674 swap swap defaults 0 0 - - b. Run the following command to edit the fstab partition table and delete the swap partition attaching information. - - **vi /etc/fstab** - - **tail -n 3 /etc/fstab** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# vi /etc/fstab - [root@sluo-ecs-a611 ~]# tail -n 3 /etc/fstab - # - UUID=7c4fce5d-f8f7-4ed6-8463-f2bd22d0ddea / ext4 defaults 1 1 - -#. Run the following command to disable the swap partition: - - **swapoff -a** - -#. Delete the swap partition. - - a. Run the following command to view the partition: - - **parted /dev/xvda** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# parted /dev/xvda - GNU Parted 3.1 - Using /dev/xvda - Welcome to GNU Parted! Type ´help´ to view a list of commands. - (parted) help - align-check TYPE N check partition N for TYPE(min|opt) alignment - help [COMMAND] print general help, or help on COMMAND - mklabel,mktable LABEL-TYPE create a new disklabel (partition table) - mkpart PART-TYPE [FS-TYPE] START END make a partition - name NUMBER NAME name partition NUMBER as NAME - print [devices|free|list,all|NUMBER] display the partition table, available devices, free space, all found partitions, or a - particular partition - quit exit program - rescue START END rescue a lost partition near START and END - rm NUMBER delete partition NUMBER - select DEVICE choose the device to edit - disk_set FLAG STATE change the FLAG on selected device - disk_toggle [FLAG] toggle the state of FLAG on selected device - set NUMBER FLAG STATE change the FLAG on partition NUMBER - toggle [NUMBER [FLAG]] toggle the state of FLAG on partition NUMBER - unit UNIT set the default unit to UNIT - version display the version number and copyright information of GNU Parted - (parted) - - b. Press **p**. - - .. code-block:: - - Disk /dev/xvda: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - Disk Flags: - - Number Start End Size Type File system Flags - 1 1049kB 41.0GB 40.9GB primary ext4 boot - 2 41.0GB 42.9GB 2000MB primary linux-swap(v1) - - - c. Run the following command to delete the partition: - - **rm 2** - - .. code-block:: - - (parted) rm2 - - d. Press **p**. - - .. code-block:: - - (parted) p - Disk /dev/xvda: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - Disk Flags: - - Number Start End Size Type File system Flags - 1 1049kB 41.0GB 40.9GB primary ext4 boot - - e. Run the following command to edit the fstab partition table: - - **quit** - - .. code-block:: - - (parted) quit - Information: You may need to update /etc/fstab. - -#. Run the following command to view partition after the swap partition is deleted: - - **parted -l /dev/xvda** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# parted -l /dev/xvda - Disk /dev/xvda: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - Disk Flags: - - Number Start End Size Type File system Flags - 1 1049kB 41.0GB 40.9GB primary ext4 boot - -#. Run the following command to install the growpart tool: - - This tool may be integrated in the **cloud-utils-growpart/cloud-utils/cloud-initramfs-tools/cloud-init** package. Run the **yum install cloud-\*** command to ensure it is available. - - **yum install cloud-utils-growpart** - -#. Run the following command to expand the root partition (the first partition) using growpart: - - **growpart /dev/xvda 1** - - .. code-block:: - - [root@sluo-ecs-a611 ~]# growpart /dev/xvda 1 - CHANGED: partition=1 start=2048 old: size=79978496 end=79980544 new: size=209710462,end=209712510 - -#. Run the following command to verify that online capacity expansion is successful: - - .. code-block:: - - [root@sluo-ecs-a611 ~]# parted -l /dev/xvda - Disk /dev/xvda: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: msdos - Disk Flags: - - Number Start End Size Type File system Flags - 1 1049kB 107GB 107GB primary ext4 boot - -#. Run the following command to expand the capacity of the file system: - - **resize2fs -f $Partition name** - - Suppose the partition name is **/dev/xvda1**, run the following command: - - .. code-block:: - - [root@sluo-ecs-a611 ~]# resize2fs -f /dev/xvda1 - resize2fs 1.42.9 (28-Dec-2013) - Filesystem at /dev/xvda1 is mounted on /; on-line resizing required - old_desc_blocks = 3, new_desc_blocks = 3 - .... - [root@sluo-ecs-a611 ~] # df -hT //Check file system capacity expansion diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_adjust_system_disk_partitions.rst b/ecs/umn/result/faqs/disk_management/how_can_i_adjust_system_disk_partitions.rst deleted file mode 100644 index 46775ecd..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_adjust_system_disk_partitions.rst +++ /dev/null @@ -1,314 +0,0 @@ -:original_name: en-us_topic_0076210995.html - -.. _en-us_topic_0076210995: - -How Can I Adjust System Disk Partitions? -======================================== - -Scenarios ---------- - -If the capacity of system disk partitions is inconsistent with the actual system disk capacity after an ECS is created, you can manually adjust the partitions to expand the system disk. - -There are two ways to expand a system disk: - -- Consider the empty partition as a new partition and attach this partition to a directory in the root partition after formatting it. For details, see this section. -- Add the empty partition to the root partition to be expanded. For detailed operations, see the following: - - - :ref:`How Can I Add the Empty Partition of an Expanded System Disk to the End Root Partition Online? ` - - :ref:`How Can I Add the Empty Partition of an Expanded System Disk to the Non-end Root Partition Online? ` - -Procedure ---------- - -This section uses an ECS running CentOS 7.3 64bit as an example. A 60 GB system disk was created with the ECS. However, the capacity of the system disk partition is displayed as only 40 GB. - -To use the 20 GB capacity, performing the following operations: - -#. View disk partitions. - - a. Log in to the Linux ECS. - - b. Run the following command to switch to user **root**: - - **sudo su -** - - c. Run the following command to view details about the ECS disk: - - **fdisk -l** - - In the following command output, **/dev/xvda** or **/dev/vda** indicates the system disk. - - .. _en-us_topic_0076210995__fig30207295194414: - - .. figure:: /_static/images/en-us_image_0076540987.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Viewing details about the disk - - d. Run the following command to view disk partitions: - - **parted -l /dev/xvda** - - .. _en-us_topic_0076210995__fig61751392489: - - .. figure:: /_static/images/en-us_image_0076598858.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Viewing disk partitions - -#. Create a partition for the expanded system disk capacity. - - a. Run the following command to switch to the fdisk mode (taking **/dev/xvda** as an example): - - **fdisk /dev/xvda** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-8d6c ]# fdisk /dev/xvda - Welcome to fdisk (util-linux 2.23.2). - - Changes will remain in memory only, until you decide to write them. - Be careful before using the write command. - - Command (m for help): - - b. Enter **n** and press **Enter** to create a new partition. - - Because the system disk has two existing partitions, the system automatically creates the third one. - - Information similar to the following is displayed. - - .. _en-us_topic_0076210995__fig8903145214811: - - .. figure:: /_static/images/en-us_image_0076540988.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Creating a new partition - - c. Enter the new partition's start cylinder number and press **Enter**. - - The start cylinder number must be greater than the end cylinder numbers of existing partitions. In this example, use the default value for the new partition's start cylinder number and press **Enter**. Information similar to the following is displayed. - - .. _en-us_topic_0076210995__fig181891453491: - - .. figure:: /_static/images/en-us_image_0076595619.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Specifying the new partition's start cylinder number - - d. Enter the new partition's end cylinder number and press **Enter**. - - In this example, use the default value for the new partition's end cylinder number and press **Enter**. Information similar to the following is displayed. - - .. _en-us_topic_0076210995__fig1575842424919: - - .. figure:: /_static/images/en-us_image_0076595620.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Specifying the new partition's end cylinder number - - e. Enter **p** and press **Enter** to view the created partition. - - Information similar to the following is displayed. - - .. _en-us_topic_0076210995__fig313793614917: - - .. figure:: /_static/images/en-us_image_0076596029.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Viewing the created partition - - f. Enter **w** and press **Enter**. The system saves and exits the partition. - - The system automatically writes the partition result into the partition list. Then, the partition is created. - - Information similar to the following is displayed. - - .. _en-us_topic_0076210995__fig31177535493: - - .. figure:: /_static/images/en-us_image_0076596326.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Completing the partition creation - - g. Run the following command to view disk partitions: - - **parted -l /dev/xvda** - - .. _en-us_topic_0076210995__fig1821920725014: - - .. figure:: /_static/images/en-us_image_0076600080.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Viewing disk partitions - -#. Run the following command to synchronize the modifications in the partition list with the OS: - - **partprobe** - -#. Configure the type of the new partition file system. - - a. Run the following command to view the type of the file system: - - **df -TH** - - .. _en-us_topic_0076210995__fig0499732105012: - - .. figure:: /_static/images/en-us_image_0076541187.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Viewing the file system type - - b. Run the following command to format the partition (taking the **ext4** type as an example): - - **mkfs -t ext4 /dev/xvda3** - - .. note:: - - Formatting the partition requires a period of time. During this time, observe the system running status and do not exit the system. - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-86dc ]# mkfs -t ext4 /dev/xvda3 - mke2fs 1.42.9 (28-Dec-2013) - Filesystem label= - OS type: Linux - Block size=4096 (log=2) - Fragment size=4096 (log=2) - Stride=0 blocks, Stripe width=0 blocks - 1790544 inodes, 7156992 blocks - 357849 blocks (5.00%) reserved for the super user - First data block=0 - Maximum filesystem blocks=2155872256 - 219 block groups - 32768 blocks per group, 32768 fragments per group - 8176 inodes per group - Superblock backups stored on blocks: - 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, - 4096000 - - Allocating group tables: done - Writing inode tables: done - Creating journal (32768 blocks): done - Writing superblocks and filesystem accounting information: done - -#. Mount the new partition to the target directory. - - If you mount the new partition to a directory that is not empty, the subdirectories and files in the directory will be hidden. It is a good practice to mount the new partition to an empty directory or a newly created directory. If you want to mount the new partition to a directory that is not empty, temporarily move the subdirectories and files in the directory to another directory. After the partition is mounted, move the subdirectories and files back. - - Take the newly created directory **/root/new** as an example. - - a. Run the following command to create the **/root/new** directory: - - **mkdir /root/new** - - b. Run the following command to mount the new partition to the **/root/new** directory: - - **mount /dev/xvda3 /root/new** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-86dc ]# mount /dev/xvda3 /root/new - [root@ecs-86dc ]# - - c. Run the following command to view the mounted file systems: - - **df -TH** - - Information similar to the following is displayed: - - .. _en-us_topic_0076210995__fig71852049155012: - - .. figure:: /_static/images/en-us_image_0076543500.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 10** Viewing the mounted file systems - -#. Determine whether to set automatic mounting upon system startup for the new disk. - - If you do not set automatic mounting upon system startup, you must mount the new partition to the specified directory again after the ECS is restarted. - - - If automatic mounting is required, go to :ref:`7 `. - - If automatic mounting is not required, no further action is required. - -#. .. _en-us_topic_0076210995__li51885379162851: - - Set automatic mounting upon system startup for the new disk. - - .. note:: - - Do not set automatic mounting upon system startup for unformatted disks because this will cause ECS startup failures. - - a. Run the following command to obtain the file system type and UUID: - - **blkid** - - .. _en-us_topic_0076210995__fig124697122517: - - .. figure:: /_static/images/en-us_image_0076543501.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 11** Viewing the file system type - - According to the preceding figure, the UUID of the new partition is 96e5e028-b0fb-4547-a82a-35ace1086c4f. - - b. Run the following command to open the **fstab** file using the vi editor: - - **vi /etc/fstab** - - c. Press **i** to enter editing mode. - - d. Move the cursor to the end of the file and press **Enter**. Then, add the following information: - - **UUID=96e5e028-b0fb-4547-a82a-35ace1086c4f /root/new ext4 defaults 0 0** - - e. Press **Esc**, run the following command, and press **Enter**. The system saves the configurations and exits the vi editor. - - **:wq** - - .. note:: - - If you want to detach a new disk for which automatic mounting upon system startup has been set, you must delete the automatic mounting configuration before you detach the disk. Otherwise, the ECS cannot be started after you detach the disk. To delete the automatic mounting configuration, perform the following operations: - - a. Run the following command to open the **fstab** file using the vi editor: - - **vi /etc/fstab** - - b. Press **i** to enter editing mode. - - c. Delete the following statement: - - **UUID=96e5e028-b0fb-4547-a82a-35ace1086c4f /root/new ext4 defaults 0 0** - - d. Press **Esc**, run the following command, and press **Enter**. The system saves the configurations and exits the vi editor. - - **:wq** diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_attach_a_snapshot-based_system_disk_to_an_ecs_as_its_data_disk.rst b/ecs/umn/result/faqs/disk_management/how_can_i_attach_a_snapshot-based_system_disk_to_an_ecs_as_its_data_disk.rst deleted file mode 100644 index a212d521..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_attach_a_snapshot-based_system_disk_to_an_ecs_as_its_data_disk.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_0152643976.html - -.. _en-us_topic_0152643976: - -How Can I Attach a Snapshot-based System Disk to an ECS as Its Data Disk? -========================================================================= - -Scenarios ---------- - -To restore data, a system disk snapshot of ECS A is used to create disk A. Then, disk A is attached to ECS B as a data disk. However, after ECS B is restarted, data disk A may be attached as the root file system but not the system disk of ECS B. In such a case, the data of ECS A is contained in the root file system of ECS B. - -Possible Causes ---------------- - -When Linux ECSs start, the root file systems to be mounted are identified by disk label but not UUID. However, system disk labels are the same, which may lead to a system disk attachment error. - -Solution --------- - -Replace the **/dev/disk/by-label/ROOT** files in **/etc/fstab** with the files in **/dev/disk/by-id**. The new files start with a unique virtio-EVS-ID. - -To do so, perform the following operations: - -#. Check whether the root file system is identified by disk label. If information similar to the following is displayed in the configuration files in **/etc/fstab** of the target ECS, its root file system is identified by disk label: - - .. code-block:: - - /dev/disk/by-label/ROOT / ext4 defaults 1 1 - -#. After attaching data disk A to ECS B, run the following command to obtain the disk ID: - - **$ ls -l /dev/disk/by-id/** - - .. code-block:: - - total 0 - lrwxrwxrwx. 1 root root 9 Nov 16 19:40 virtio-20211065-0f57-46d4-9 -> ../../vda - lrwxrwxrwx. 1 root root 10 Nov 16 19:40 virtio-20211065-0f57-46d4-9-part1 -> ../../vda1 - lrwxrwxrwx. 1 root root 9 Nov 16 19:40 virtio-842dbfd3-9f2c-4273-9 -> ../../vdb - lrwxrwxrwx. 1 root root 10 Nov 16 19:40 virtio-842dbfd3-9f2c-4273-9-part1 -> ../../vdb1 - -#. Run the following command to change the disk ID to the desired one in the configuration files in **/etc/fstab** of ECS B: - - **vi /etc/fstab** - - .. code-block:: - - /dev/disk/by-id/virtio-20211065-0f57-46d4-9-part1 / ext4 defaults 1 1 - /dev/disk/by-id/virtio-842dbfd3-9f2c-4273-9-part1 /vdb1-test ext4 defaults 1 1 - -#. Press **Esc** to exit editing mode. - -#. Run the following command to save the configuration and exit: - - **:wq** - -#. Restart the ECS for the modification to take effect. diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_enable_virtual_memory_on_a_windows_ecs.rst b/ecs/umn/result/faqs/disk_management/how_can_i_enable_virtual_memory_on_a_windows_ecs.rst deleted file mode 100644 index c1295c1c..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_enable_virtual_memory_on_a_windows_ecs.rst +++ /dev/null @@ -1,64 +0,0 @@ -:original_name: en-us_topic_0120795802.html - -.. _en-us_topic_0120795802: - -How Can I Enable Virtual Memory on a Windows ECS? -================================================= - -Enabling ECS virtual memory will deteriorate disk I/O performance. Therefore, the Windows ECSs provided by the platform do not have virtual memory enabled by default. If the memory size of an ECS is insufficient, you are advised to increase its memory size by modifying the ECS specifications. Perform the operations described in this section to enable virtual memory if required. - -.. note:: - - If the memory usage is excessively high and the I/O performance is not as good as expected, you are not suggested to enable virtual memory. The reason is as follows: The excessively high memory usage limits the system performance improvement. Furthermore, frequent memory switching requires massive additional I/O operations, which will further deteriorate the I/O performance and the overall system performance. - -The operations described in this section are provided for the ECSs running Windows Server 2008 or later. - -#. Right-click **Computer** and choose **Properties** from the shortcut menu. - -#. In the navigation pane on the left, choose **Advanced system settings**. - - The **System Properties** dialog box is displayed. - -#. Click the **Advanced** tab and then **Settings** in the **Performance** pane. - - The **Performance Options** dialog box is displayed. - - .. _en-us_topic_0120795802__fig862604114509: - - .. figure:: /_static/images/en-us_image_0120795956.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Performance Options - -#. Click the **Advanced** tab and then **Background Services** in the **Processor scheduling** pane. - -#. Click **Change** in the **Virtual memory** pane. - - The **Virtual Memory** dialog box is displayed. - -#. Configure virtual memory based on service requirements. - - - **Automatically manage paging file size for all drives**: Deselect the check box. - - - **Drive**: Select the drive where the virtual memory file is stored. - - You are advised not to select the system disk to store the virtual memory. - - - **Custom size**: Select **Custom size** and set **Initial size** and **Maximum size**. - - Considering **Memory.dmp** caused by blue screen of death (BSOD), you are advised to set **Initial size** to **16** and **Maximum size** to **4096**. - - .. _en-us_topic_0120795802__fig68314916547: - - .. figure:: /_static/images/en-us_image_0120795935.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Virtual Memory - -#. Click **Set** and then **OK** to complete the configuration. - -#. Restart the ECS for the configuration to take effect. diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_data_disk_information_if_tools_are_uninstalled.rst b/ecs/umn/result/faqs/disk_management/how_can_i_obtain_data_disk_information_if_tools_are_uninstalled.rst deleted file mode 100644 index 151c977c..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_data_disk_information_if_tools_are_uninstalled.rst +++ /dev/null @@ -1,42 +0,0 @@ -:original_name: en-us_topic_0029806525.html - -.. _en-us_topic_0029806525: - -How Can I Obtain Data Disk Information If Tools Are Uninstalled? -================================================================ - -If you uninstall Tools from a Linux ECS in a non-PVOPS system, data disks cannot be identified. In such a case, you can create a new ECS and attach the data disks of the original ECS to the new ECS and view information about the data disks. The procedure is as follows: - -#. Log in to the management console and create a new ECS. - - .. note:: - - Ensure that the new ECS is located in the same AZ and has the same parameter settings as the original ECS. - -#. (Optional) On the **Elastic Cloud Server** page, locate the row containing the original ECS, click **More** in the **Operation** column, and select **Stop**. On the **Stop ECS** page, select **Forcibly stop the preceding ECSs** and click **Yes** to forcibly stop the original ECS. - - Manually refresh the **Elastic Cloud Server** page. The original ECS is stopped once the **Status** changes to **Stopped**. - - .. note:: - - The ECSs running certain OSs support online data disk detaching. If your OS supports this feature, you can detach data disks from the running ECS. - -#. View information about the data disks attached to the original ECS. - - .. note:: - - If the original ECS has multiple data disks attached, repeat steps :ref:`4 ` to :ref:`6 ` to attach each data disk to the new ECS. - -#. .. _en-us_topic_0029806525__li3454282161441: - - Click a data disk. The **Elastic Volume Service** page is displayed. - -#. Select the data disk to be detached and click **Detach** in the **Operation** column. On the **Detach Disk** page, select the original ECS and click **OK** to detach the data disk from the original ECS. - - Manually refresh the **Elastic Volume Service** page. The data disk is detached from the original ECS once the **Status** changes to **Available**. - -#. .. _en-us_topic_0029806525__li3628995162045: - - Select the detached data disk and click **Attach** in the **Operation** column. On the **Attach Disk** page, click the new ECS, select a device name, and click **OK** to attach the data disk to the new ECS. - - Manually refresh the EVS list. The data disk is attached to the new ECS once the **Status** value changes to **In-use**. You can then log in to the management console and view information about the data disk of the new ECS. diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_linux_ecs.rst b/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_linux_ecs.rst deleted file mode 100644 index b608961f..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_linux_ecs.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0087901488.html - -.. _en-us_topic_0087901488: - -How Can I Obtain the Mapping Between Disk Partitions and Disk Devices on a Linux ECS? -===================================================================================== - -For a Linux ECS, its disk partitions correspond to disk devices. This section uses a Linux ECS running Red Hat Enterprise Linux 7 as an example to describe how to obtain the mapping between disk partitions and disk devices. - -#. Log in to the Linux ECS as user **root**. - -#. Right-click in the blank area of the desktop and choose **Open Terminal** from the shortcut menu. - - .. _en-us_topic_0087901488__fig63278226101115: - - .. figure:: /_static/images/en-us_image_0087903699.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** open terminal - -#. Run the following command to view disk partitions and disk devices: - - **fdisk -l** - - .. _en-us_topic_0087901488__fig101265111168: - - .. figure:: /_static/images/en-us_image_0087903704.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Viewing disk partitions and disk devices - - :ref:`Table 1 ` lists the mapping between disk partitions and disk devices. - - .. _en-us_topic_0087901488__table18572291102543: - - .. table:: **Table 1** Mapping between disk partitions and disk devices - - ============== =========== - Disk Partition Disk Device - ============== =========== - xvda xvda - xvdb xvdb - xvdc xvdc - xvdd xvdd - xvde xvde - xvdf xvdf - xvdg xvdg - xvdh xvdh - xvdi xvdi - xvdj xvdj - xvdk xvdk - xvdl xvdl - xvdm xvdm - xvdn xvdn - xvdo xvdo - xvdp xvdp - xvdq xvdq - xvdr xvdr - xvds xvds - xvdt xvdt - xvdu xvdu - xvdv xvdv - xvdw xvdw - xvdx xvdx - ============== =========== diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_windows_ecs.rst b/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_windows_ecs.rst deleted file mode 100644 index f9de9089..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_windows_ecs.rst +++ /dev/null @@ -1,90 +0,0 @@ -:original_name: en-us_topic_0087680813.html - -.. _en-us_topic_0087680813: - -How Can I Obtain the Mapping Between Disk Partitions and Disk Devices on a Windows ECS? -======================================================================================= - -This section uses an ECS running Windows Server 2008 R2 64bit as an example to describe how to obtain the mapping between disk partitions and disk devices. - -#. Log in to the Windows ECS. - -#. Click **Start** in the lower left corner of the desktop. - -#. Choose **Control Panel** > **Administrative Tools** > **Computer Management**. - -#. In the navigation pane on the left, choose **Storage** > **Disk Management**. - - .. _en-us_topic_0087680813__fig63278226101115: - - .. figure:: /_static/images/en-us_image_0087906013.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Disk Management - -#. Taking disk 1 marked in :ref:`Figure 1 ` as an example, view the disk device for disk 1. - - a. Right-click the gray area where disk 1 is located, as shown in the red box in :ref:`Figure 1 `. - - b. Click **Properties**. - - The **SCSI Disk Device Properties** dialog box is displayed, as shown in :ref:`Figure 2 `. - - .. _en-us_topic_0087680813__fig22437283101545: - - .. figure:: /_static/images/en-us_image_0087906055.png - :alt: **Figure 2** Disk properties - - - **Figure 2** Disk properties - - c. Click the **Details** tab and set **Property** to **Parent**. - - .. _en-us_topic_0087680813__fig2821199710173: - - .. figure:: /_static/images/en-us_image_0087906067.png - :alt: **Figure 3** Disk device details - - - **Figure 3** Disk device details - - d. Record the digits following **&** in the parameter value, for example, **51776**, which is the master and slave device number corresponding to the disk partition. - - e. Obtain the disk device according to the information listed in :ref:`Table 1 `. - - The disk device corresponding to **51776** is **xvde**. The disk device used by disk 1 is xvde. - - .. _en-us_topic_0087680813__table2257401020521: - - .. table:: **Table 1** Mapping between disk partitions and disk devices - - =================================================== =========== - Master and Slave Device Number for a Disk Partition Disk Device - =================================================== =========== - 51712 xvda - 51728 xvdb - 51744 xvdc - 51760 xvdd - 51776 xvde - 51792 xvdf - 51808 xvdg - 51824 xvdh - 51840 xvdi - 51856 xvdj - 51872 xvdk - 51888 xvdl - 51904 xvdm - 51920 xvdn - 51936 xvdo - 51952 xvdp - 268439552 xvdq - 268439808 xvdr - 268440064 xvds - 268440320 xvdt - 268440576 xvdu - 268440832 xvdv - 268441088 xvdw - 268441344 xvdx - =================================================== =========== diff --git a/ecs/umn/result/faqs/disk_management/how_can_i_rectify_the_fault_that_may_occur_on_a_linux_ecs_with_an_nvme_ssd_disk_attached.rst b/ecs/umn/result/faqs/disk_management/how_can_i_rectify_the_fault_that_may_occur_on_a_linux_ecs_with_an_nvme_ssd_disk_attached.rst deleted file mode 100644 index 91a7da9c..00000000 --- a/ecs/umn/result/faqs/disk_management/how_can_i_rectify_the_fault_that_may_occur_on_a_linux_ecs_with_an_nvme_ssd_disk_attached.rst +++ /dev/null @@ -1,74 +0,0 @@ -:original_name: en-us_topic_0087622835.html - -.. _en-us_topic_0087622835: - -How Can I Rectify the Fault That May Occur on a Linux ECS with an NVMe SSD Disk Attached? -========================================================================================= - -Symptom -------- - -When a Linux ECS with an NVMe SSD disk attached, such as a P1 ECS, becomes faulty, you must contact the administrator to remotely create the ECS again for reconstruction. - -If automatic NVMe SSD disk attaching upon ECS startup is enabled in **/etc/fstab** on the faulty ECS, the system disk recovers after the ECS is created. However, the attached NVMe SSD disk does not have a file system, and automatic NVMe SSD disk attaching upon ECS startup fails to take effect. As a result, the ECS enters the emergency mode. - -.. _en-us_topic_0087622835__fig13243412145029: - -.. figure:: /_static/images/en-us_image_0087630201.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Emergency mode - -To ensure that the new ECS is functional, you must manually delete the attaching information in **/etc/fstab**. - -.. note:: - - If the NVMe SSD disk is faulty, data on it will be lost. The operations provided in this section are only used to restore automatic NVMe SSD disk attachment to an ECS, but not restoring the data on the disk. - -Solution --------- - -#. Log in to the ECS. - -#. Enter the password of user **root** to log in to the ECS. - - .. _en-us_topic_0087622835__fig14351155425213: - - .. figure:: /_static/images/en-us_image_0087631679.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Logging in to the ECS - -#. Run the following command to edit the **/etc/fstab** file: - - **vi /etc/fstab** - -#. Delete the attaching information of the NVMe SSD disk and save the file. - - .. _en-us_topic_0087622835__fig6022199715759: - - .. figure:: /_static/images/en-us_image_0087632786.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Deleting the automatic attaching information - -#. Run the following command to restart the ECS: - - **reboot** - -#. Verify that the ECS recovers and can be logged in. - - .. _en-us_topic_0087622835__fig42664483151146: - - .. figure:: /_static/images/en-us_image_0087632787.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Logging in to the ECS diff --git a/ecs/umn/result/faqs/disk_management/how_do_i_obtain_my_disk_name_in_the_ecs_os_using_the_device_identifier_provided_on_the_console.rst b/ecs/umn/result/faqs/disk_management/how_do_i_obtain_my_disk_name_in_the_ecs_os_using_the_device_identifier_provided_on_the_console.rst deleted file mode 100644 index 19100c07..00000000 --- a/ecs/umn/result/faqs/disk_management/how_do_i_obtain_my_disk_name_in_the_ecs_os_using_the_device_identifier_provided_on_the_console.rst +++ /dev/null @@ -1,246 +0,0 @@ -:original_name: en-us_topic_0103285575.html - -.. _en-us_topic_0103285575: - -How Do I Obtain My Disk Name in the ECS OS Using the Device Identifier Provided on the Console? -=============================================================================================== - -Scenarios ---------- - -You find that the disk name displayed on the ECS OS is different from that displayed on the management console and you cannot determine which disk name is correct. This section describes how to obtain the disk name used on an ECS OS according to the device identifier on the console. - -.. _en-us_topic_0103285575__section1041415015310: - -Obtaining the Disk ID of an ECS on the Console ----------------------------------------------- - -#. Log in to the management console. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the target ECS name in the ECS list. - - The page providing details about the ECS is displayed. - -#. Click the **Disks** tab and then |image1| to expand the disk information. - -#. Check the device type and ID of the disk. - - .. note:: - - If **Device Identifier** is not displayed on the web page, stop the ECS and restart it. - - - KVM - - - If **Device Type** is **VBD**, use a serial number or BDF to obtain the disk device name. - - If you use a serial number (recommended) to obtain the disk name, see :ref:`Using a Serial Number to Obtain the Disk Name (Windows) ` and :ref:`Using a Serial Number to Obtain a Disk Device Name (Linux) `. - - If you use a BDF to obtain the disk device name, see :ref:`Using a VBD to Obtain a Disk Device Name (Linux) `. (BDF cannot be used to obtain the disk name of Windows ECSs.) - - - If **Device Type** is **SCSI**, use a WWN to obtain the disk name. For details, see :ref:`Using a WWN to Obtain the Disk Name (Windows) ` and :ref:`Using a WWN to Obtain a Disk Device Name (Linux) `. - -.. _en-us_topic_0103285575__section1549713815243: - -Using a Serial Number to Obtain the Disk Name (Windows) -------------------------------------------------------- - -If a serial number is displayed on the console, use either of the following methods to obtain the disk name. - -**cmd** - -#. Start **cmd** in a Windows OS as an administrator and run either of the following commands: - - **wmic diskdrive get serialnumber** - - **wmic path win32_physicalmedia get SerialNumber** - - **wmic path Win32_DiskDrive get SerialNumber** - - .. note:: - - A serial number is the first 20 digits of a disk UUID. - - For example, if the serial number of a VBD disk on the console is 97c876c0-54b3-460a-b, run either of the following commands to obtain the serial number of the disk on the ECS OS: - - **wmic diskdrive get serialnumber** - - **wmic path win32_physicalmedia get SerialNumber** - - **wmic path Win32_DiskDrive get SerialNumber** - - Information similar to the following is displayed: - - .. _en-us_topic_0103285575__fig141513348195: - - .. figure:: /_static/images/en-us_image_0000001127902463.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Obtaining the disk serial number - -#. Run the following command to check the disk corresponding to the serial number: - - **wmic** **diskdrive get Name, SerialNumber** - - .. _en-us_topic_0103285575__fig499418565481: - - .. figure:: /_static/images/en-us_image_0000001081131958.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Checking the disk corresponding to the serial number - -**PowerShell** - -#. Start PowerShell as an administrator in a Windows OS. -#. Run the following command to check the disk on which the logical disk is created: - - - Windows Server 2012 or later - - a. Run the following command to check the disk on which the logical disk is created: - - **Get-CimInstance -ClassName Win32_LogicalDiskToPartition \|select Antecedent, Dependent \|fl** - - As shown in :ref:`Figure 3 `, the disk is **Disk 0**. - - b. Run the following command to view the mapping between the serial number and the disk: - - **Get-Disk \|select Number, SerialNumber** - - As shown in :ref:`Figure 3 `, the disk is **Disk 0**. - - .. _en-us_topic_0103285575__fig1960253814473: - - .. figure:: /_static/images/en-us_image_0000001127906793.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Viewing the disk on which the logical disk is created - - - Versions earlier than Windows 2012 - - a. Run the following command to check the disk on which the logical disk is created: - - **Get-WmiObject -Class Win32_PhysicalMedia \|select Tag, Serialnumber** - - b. Run the following command to view the mapping between the serial number and the disk: - - **Get-WmiObject -Class Win32_LogicalDiskToPartition \|select Antecedent, Dependent \|fl** - -.. _en-us_topic_0103285575__section1251215393317: - -Using a Serial Number to Obtain a Disk Device Name (Linux) ----------------------------------------------------------- - -If a serial number is displayed on the console, run either of the following commands to obtain the device name. - -**#** **udevadm info --query=all --name=/dev/xxx \| grep ID_SERIAL** - -**# ll /dev/disk/by-id/\*** - -.. note:: - - A serial number is the first 20 digits of a disk UUID. - -For example, if the serial number of the VBD disk is 62f0d06b-808d-480d-8, run either of the following commands: - -**# udevadm info --query=all --name=/dev/vdb \| grep ID_SERIAL** - -**# ll /dev/disk/by-id/\*** - -The following information is displayed: - -.. code-block:: - - [root@ecs-ab63 ~]# udevadm info --query=all --name=/dev/vdb | grep ID_SERIAL - E: ID_SERIAL=62f0d06b-808d-480d-8 - [root@ecs-ab63 ~]# ll /dev/disk/by-id/* - lrwxrwxrwx 1 root root 9 Dec 30 15:56 /dev/disk/by-id/virtio-128d5bfd-f215-487f-9 -> ../../vda - lrwxrwxrwx 1 root root 10 Dec 30 15:56 /dev/disk/by-id/virtio-128d5bfd-f215-487f-9-part1 -> ../../vda1 - lrwxrwxrwx 1 root root 9 Dec 30 15:56 /dev/disk/by-id/virtio-62f0d06b-808d-480d-8 -> ../../vdb - -**/dev/vdb** is the disk device name. - -.. _en-us_topic_0103285575__section8901134753319: - -Using a VBD to Obtain a Disk Device Name (Linux) ------------------------------------------------- - -#. Run the following command to use a BDF to obtain the device name: - - **ll /sys/bus/pci/devices/**\ *BDF disk ID*\ **/virtio*/block** - - For example, if the BDF disk ID of the VBD disk is 0000:02:02.0, run the following command to obtain the device name: - - **ll /sys/bus/pci/devices/0000:02:02.0/virtio*/block** - - The following information is displayed: - - .. code-block:: - - [root@ecs-ab63 ~]# ll /sys/bus/pci/devices/0000:02:02.0/virtio*/block - total 0 - drwxr-xr-x 8 root root 0 Dec 30 15:56 vdb - - **/dev/vdb** is the disk device name. - -.. _en-us_topic_0103285575__section49041319248: - -Using a WWN to Obtain the Disk Name (Windows) ---------------------------------------------- - -#. Obtain the device identifier on the console by referring to :ref:`Obtaining the Disk ID of an ECS on the Console `. - -#. Manually convert the WWN. - - For example, the obtained WWN (device identifier) is 68886030000\ **3252f**\ fa16520d39517815. - - a. Obtain the 21st to 17th digits that are counted backwards (**3252f**). - b. Convert a hexadecimal (**3252f**) to a decimal (**206127**). - -#. Start PowerShell as an administrator in a Windows OS. - -#. Run the following command: - - **Get-CimInstance Win32_DiskDrive \| Select-Object DeviceID, SerialNumber** - -#. In the command output, the disk whose serial number ends with **206127** is the disk corresponding to the WWN. - - .. _en-us_topic_0103285575__fig3430181417335: - - .. figure:: /_static/images/en-us_image_0000001128111323.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Disk with the serial number ending with **206127** - -.. _en-us_topic_0103285575__section436018073419: - -Using a WWN to Obtain a Disk Device Name (Linux) ------------------------------------------------- - -#. Log in to the ECS as user **root**. - -#. Run the following command to view the disk device name: - - **ll /dev/disk/by-id \|grep** *WWN*\ **\|grep scsi-3** - - For example, if the WWN obtained on the console is 6888603000008b32fa16688d09368506, run the following command: - - **ll /dev/disk/by-id \|grep 6888603000008b32fa16688d09368506|grep scsi-3** - - The following information is displayed: - - .. code-block:: - - [root@host-192-168-133-148 block]# ll /dev/disk/by-id/ |grep 6888603000008b32fa16688d09368506 |grep scsi-3 - lrwxrwxrwx 1 root root 9 May 21 20:22 scsi-36888603000008b32fa16688d09368506 -> ../../sda - -.. |image1| image:: /_static/images/en-us_image_0216898618.png - diff --git a/ecs/umn/result/faqs/disk_management/index.rst b/ecs/umn/result/faqs/disk_management/index.rst deleted file mode 100644 index 32f51ea8..00000000 --- a/ecs/umn/result/faqs/disk_management/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _en-us_topic_0018124786: - -=============== -Disk Management -=============== - -.. toctree:: - :maxdepth: 1 - - what_should_i_do_if_the_data_disk_attached_a_windows_ecs_is_unavailable - how_can_i_adjust_system_disk_partitions - how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_windows_ecs - how_can_i_obtain_the_mapping_between_disk_partitions_and_disk_devices_on_a_linux_ecs - how_can_i_enable_virtual_memory_on_a_windows_ecs - why_is_the_memory_of_an_ecs_obtained_by_running_the_free_command_inconsistent_with_the_actual_memory - how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_end_root_partition_online - how_can_i_add_the_empty_partition_of_an_expanded_system_disk_to_the_non-end_root_partition_online - can_i_attach_multiple_disks_to_an_ecs - what_are_the_requirements_for_attaching_an_evs_disk_to_an_ecs - which_ecss_can_be_attached_with_scsi_evs_disks - how_do_i_obtain_my_disk_name_in_the_ecs_os_using_the_device_identifier_provided_on_the_console - how_can_i_attach_a_snapshot-based_system_disk_to_an_ecs_as_its_data_disk - why_does_a_linux_ecs_with_a_scsi_disk_attached_fails_to_restart - can_all_users_use_the_encryption_feature - why_does_a_disk_attached_to_a_windows_ecs_go_offline - why_does_the_disk_drive_letter_change_after_the_ecs_is_restarted - how_can_i_obtain_data_disk_information_if_tools_are_uninstalled - how_can_i_rectify_the_fault_that_may_occur_on_a_linux_ecs_with_an_nvme_ssd_disk_attached diff --git a/ecs/umn/result/faqs/disk_management/what_are_the_requirements_for_attaching_an_evs_disk_to_an_ecs.rst b/ecs/umn/result/faqs/disk_management/what_are_the_requirements_for_attaching_an_evs_disk_to_an_ecs.rst deleted file mode 100644 index 859405c1..00000000 --- a/ecs/umn/result/faqs/disk_management/what_are_the_requirements_for_attaching_an_evs_disk_to_an_ecs.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: en-us_topic_0040863659.html - -.. _en-us_topic_0040863659: - -What Are the Requirements for Attaching an EVS Disk to an ECS? -============================================================== - -- The EVS disk and the target ECS must be located in the same AZ. - -- For a non-shared disk, the EVS disk must be in **Available** state. - - For a shared disk, the target EVS disk must be in **In-use** or **Available** state. - -- The target ECS must be in **Running** or **Stopped** state. - -- A SCSI EVS disk cannot be used as an ECS system disk. - -- Certain ECSs support SCSI EVS disk attachment. For details, see :ref:`Which ECSs Can Be Attached with SCSI EVS Disks? ` diff --git a/ecs/umn/result/faqs/disk_management/what_should_i_do_if_the_data_disk_attached_a_windows_ecs_is_unavailable.rst b/ecs/umn/result/faqs/disk_management/what_should_i_do_if_the_data_disk_attached_a_windows_ecs_is_unavailable.rst deleted file mode 100644 index fe3119b1..00000000 --- a/ecs/umn/result/faqs/disk_management/what_should_i_do_if_the_data_disk_attached_a_windows_ecs_is_unavailable.rst +++ /dev/null @@ -1,52 +0,0 @@ -:original_name: en-us_topic_0251012483.html - -.. _en-us_topic_0251012483: - -What Should I Do If the Data Disk Attached a Windows ECS Is Unavailable? -======================================================================== - -Symptom -------- - -After logging in to my Windows ECS, I cannot find the attached data disk. - -.. caution:: - - Formatting a disk will cause data loss. Therefore, before formatting a disk, create a backup for it. - -Possible Causes ---------------- - -- A newly added data disk has not been partitioned or initialized. -- The disk becomes offline after the ECS OS is changed or the ECS specifications are modified. - -Newly Added Data Disk Has Not Been Partitioned or Initialized -------------------------------------------------------------- - -A new data disk does not have partitions and file systems by default. That is why it is unavailable in **My Computer**. To resolve this issue, manually initialize the disk. - -Disk Becomes Offline After the ECS OS Is Changed or the ECS Specifications Are Modified ---------------------------------------------------------------------------------------- - -After the ECS OS is changed, data disks may become unavailable due to file system inconsistency. After the specifications of a Windows ECS are modified, data disks may be offline. - -#. Log in to the ECS, open the **cmd** window, and enter **diskmgmt.msc** to switch to the **Disk Management** page. - - Check whether the affected disk is offline. - -#. Set the affected disk to be online. - - In the disk list, right-click the affected disk and choose **Online** from the shortcut menu to make it online. - - .. _en-us_topic_0251012483__fig1869603017195: - - .. figure:: /_static/images/en-us_image_0251063932.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting disk online - -#. In **My Computer**, check whether the data disk is displayed properly. - - If the fault persists, initialize and partition the disk again. Before initializing the disk, create a backup for it. diff --git a/ecs/umn/result/faqs/disk_management/which_ecss_can_be_attached_with_scsi_evs_disks.rst b/ecs/umn/result/faqs/disk_management/which_ecss_can_be_attached_with_scsi_evs_disks.rst deleted file mode 100644 index 256114fb..00000000 --- a/ecs/umn/result/faqs/disk_management/which_ecss_can_be_attached_with_scsi_evs_disks.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0077938284.html - -.. _en-us_topic_0077938284: - -Which ECSs Can Be Attached with SCSI EVS Disks? -=============================================== - -All types of ECSs can be attached with SCSI EVS disks. diff --git a/ecs/umn/result/faqs/disk_management/why_does_a_disk_attached_to_a_windows_ecs_go_offline.rst b/ecs/umn/result/faqs/disk_management/why_does_a_disk_attached_to_a_windows_ecs_go_offline.rst deleted file mode 100644 index 3628fc53..00000000 --- a/ecs/umn/result/faqs/disk_management/why_does_a_disk_attached_to_a_windows_ecs_go_offline.rst +++ /dev/null @@ -1,68 +0,0 @@ -:original_name: en-us_topic_0114225937.html - -.. _en-us_topic_0114225937: - -Why Does a Disk Attached to a Windows ECS Go Offline? -===================================================== - -Symptom -------- - -A disk attached to a Windows ECS goes offline, and the system displays the message "The disk is offline because of policy set by an administrator." - -.. _en-us_topic_0114225937__fig1167510561578: - -.. figure:: /_static/images/en-us_image_0114229858.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Offline disk - -Possible Causes ---------------- - -Windows has three types of SAN policies: **OnlineAll**, **OfflineShared**, and **OfflineInternal**. - -.. table:: **Table 1** SAN policies - - +-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | SAN Policy | Description | - +=================+=========================================================================================================================================================+ - | OnlineAll | Indicates that all newly detected disks are automatically brought online. | - +-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OfflineShared | Indicates that all newly detected disks on sharable buses, such as FC or iSCSI, are offline by default, whereas disks on non-sharable buses are online. | - +-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OfflineInternal | Indicates that all newly detected disks are offline. | - +-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+ - -The SAN policy of certain Windows OSs, such as Windows Server 2008/2012 Enterprise Edition and Data Center Edition, is **OfflineShared** by default. - -Solution --------- - -Use the disk partition management tool DiskPart to obtain and set the SAN policy on the ECS to **OnlineAll**. - -#. Log in to the Windows ECS. - -#. Press **Win+R** to run **cmd.exe**. - -#. Run the following command to access DiskPart: - - **diskpart** - -#. Run the following command to view the SAN policy on the ECS: - - **san** - - - If the SAN policy is **OnlineAll**, run the **exit** command to exit DiskPart. - - - If the SAN policy is not **OnlineAll**, go to step :ref:`5 `. - -#. .. _en-us_topic_0114225937__li5934113914122: - - Run the following command to change the SAN policy to **OnlineAll**: - - **san policy=onlineall** - -#. (Optional) Use the ECS with the SAN policy changed to create a private image so that the configuration takes effect permanently. After an ECS is created using this private image, the disks attached to the ECS are online by default. You only need to initialize them. diff --git a/ecs/umn/result/faqs/disk_management/why_does_a_linux_ecs_with_a_scsi_disk_attached_fails_to_restart.rst b/ecs/umn/result/faqs/disk_management/why_does_a_linux_ecs_with_a_scsi_disk_attached_fails_to_restart.rst deleted file mode 100644 index 22d59a73..00000000 --- a/ecs/umn/result/faqs/disk_management/why_does_a_linux_ecs_with_a_scsi_disk_attached_fails_to_restart.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0087382187.html - -.. _en-us_topic_0087382187: - -Why Does a Linux ECS with a SCSI Disk Attached Fails to Restart? -================================================================ - -Symptom -------- - -For a Linux ECS with a SCSI disk attached, if you have enabled automatic SCSI disk attachment upon ECS startup in **/etc/fstab** and the disk drive letter (for example, **/dev/sdb**) is used, the ECS fails to restart. - -Possible Causes ---------------- - -SCSI disk allocation is determined based on the ID of the slot accommodating the disk as well as the available drive letter in the ECS. Each time you attach a disk to the ECS, an idle drive letter is automatically allocated in sequence. When the ECS starts, the disks are loaded in slot sequence. Therefore, a slot ID corresponds to a drive letter. - -After the SCSI disk is detached from the running ECS, the slot sequence for disks may change, leading to the disk drive letter being changed after the ECS is restarted. As a result, the slot IDs do not correspond to the drive letters, and the ECS fails to restart. - -Solution --------- - -#. Log in to the Linux ECS. - -#. Run the following command to switch to user **root**: - - **sudo su -** - -#. .. _en-us_topic_0087382187__li2064141120446: - - Run the following command to obtain the SCSI ID according to the drive letter of the SCSI disk: - - **ll /dev/disk/by-id/|grep** *Disk drive letter* - - For example, if the drive letter of the SCSI disk is **/dev/sdb**, run the following command: - - **ll /dev/disk/by-id/|grep sdb** - - .. code-block:: - - CNA64_22:/opt/galax/eucalyptus/ecs_scripts # ll /dev/disk/by-id/|grep sdb - lrwxrwxrwx 1 root root 9 Dec 6 11:26 scsi-3688860300001436b005014f890338280 -> ../../sdb - lrwxrwxrwx 1 root root 9 Dec 6 11:26 wwn-0x688860300001436b005014f890338280 -> ../../sdb - -#. Change the drive letter (for example, **/dev/sdb**) of the SCSI disk to the corresponding SCSI ID in the **/etc/fstab** file. - - **/dev/disk/by-id/**\ *SCSI ID* - - For example, if the SCSI ID obtained in step :ref:`3 ` is scsi-3688860300001436b005014f890338280, use the following data to replace **/dev/sdb**: - - **/dev/disk/by-id/scsi-3688860300001436b005014f890338280** diff --git a/ecs/umn/result/faqs/disk_management/why_does_the_disk_drive_letter_change_after_the_ecs_is_restarted.rst b/ecs/umn/result/faqs/disk_management/why_does_the_disk_drive_letter_change_after_the_ecs_is_restarted.rst deleted file mode 100644 index ad961bdd..00000000 --- a/ecs/umn/result/faqs/disk_management/why_does_the_disk_drive_letter_change_after_the_ecs_is_restarted.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0240831198.html - -.. _en-us_topic_0240831198: - -Why Does the Disk Drive Letter Change After the ECS Is Restarted? -================================================================= - -Symptom -------- - -For a Linux ECS, the drive letter may change after an EVS disk is detached and then attached again, or after an EVS disk is detached and then the ECS is restarted. This is a normal phenomenon due to the drive letter allocation mechanism of the Linux system. - -For example, an ECS has three disks attached: **/dev/vda1**, **/dev/vdb1**, and **/dev/vdc1**. The mounting parameters in **/etc/fstab** are as follows: - -cat /etc/fstab - -.. code-block:: - - UUID=b9a07b7b-9322-4e05-ab9b-14b8050bdc8a / ext4 defaults 0 1 - /dev/vdb1 /data1 ext4 defaults 0 0 - /dev/vdc1 /data2 ext4 defaults 0 0 - -If **/dev/vdb1** is detached, **/dev/vdc1** becomes **/dev/vdb1** and is mounted to **/data1** after the ECS is restarted. In such a case, no disk is mounted to **/data2**. - -Solution --------- - -To prevent this issue, use a UUID, a unique character string provided by the Linux system for disk partitions, to replace the /dev/vdx device. - -#. Run the following command to obtain the partition UUID: - - **blkid** *Disk partition* - - In this example, run the following command to obtain the UUID of the **/dev/vdb1** partition: - - **blkid /dev/vdb1** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# blkid /dev/vdb1 - /dev/vdb1: UUID="b9a07b7b-9322-4e05-ab9b-14b8050cd8cc" TYPE="ext4" - - The UUID of the **/dev/vdb1** partition is displayed. - -#. Run the following command to open the **fstab** file using the vi editor: - - **vi /etc/fstab** - -#. Press **i** to enter the editing mode. - -#. Move the cursor to the end of the file and press **Enter**. Then, add the following information: - - .. code-block:: - - UUID=b9a07b7b-9322-4e05-ab9b-14b8050cd8cc /mnt/sdc ext4 defaults 0 0 - - Repeat the preceding operations to add the UUID of the **/dev/vdc1** partition and run the following command to check the disk mounting parameters: - - cat /etc/fstab - - The following information is displayed: - - .. code-block:: - - UUID=b9a07b7b-9322-4e05-ab9b-14b8050bdc8a / ext4 defaults 0 1 - UUID=b9a07b7b-9322-4e05-ab9b-14b8050cd8cc /data1 ext4 defaults 0 0 - UUID=b9a07b7b-9322-4e05-ab9b-14b8050ab6bb /data2 ext4 defaults 0 0 diff --git a/ecs/umn/result/faqs/disk_management/why_is_the_memory_of_an_ecs_obtained_by_running_the_free_command_inconsistent_with_the_actual_memory.rst b/ecs/umn/result/faqs/disk_management/why_is_the_memory_of_an_ecs_obtained_by_running_the_free_command_inconsistent_with_the_actual_memory.rst deleted file mode 100644 index 6e03c16e..00000000 --- a/ecs/umn/result/faqs/disk_management/why_is_the_memory_of_an_ecs_obtained_by_running_the_free_command_inconsistent_with_the_actual_memory.rst +++ /dev/null @@ -1,81 +0,0 @@ -:original_name: en-us_topic_0093153741.html - -.. _en-us_topic_0093153741: - -Why Is the Memory of an ECS Obtained by Running the **free** Command Inconsistent with the Actual Memory? -========================================================================================================= - -Symptom -------- - -After you create an ECS, you run the **free -m** command to view the ECS memory. The ECS memory is less than the memory configured during ECS creation. - -An example is provided as follows: - -For example, you configure the memory as 4,194,304 KB (4,096 MB) when you create the ECS. After the ECS is created, you run the **free -m** command to view its memory. The command output is as follows: - -.. code-block:: - - [root@localhost ~]# free -m - total used free shared buff/cache available - Mem: 3790 167 3474 8 147 3414 - Swap: 1022 0 1022 - -The memory in the command output is 3790 MB, which is less than the configured 4096 MB. - -Run the **dmidecode -t memory** command to check the actual memory configured for the ECS. The command output is as follows: - -.. code-block:: - - [root@localhost ~]# dmidecode -t memory - # dmidecode 3.0 - Getting SMBIOS data from sysfs. - SMBIOS 2.8 present. - - Handle 0x1000, DMI type 16, 23 bytes - Physical Memory Array - Location: Other - Use: System Memory - Error Correction Type: Multi-bit ECC - Maximum Capacity: 4 GB - Error Information Handle: Not Provided - Number Of Devices: 1 - - Handle 0x1100, DMI type 17, 40 bytes - Memory Device - Array Handle: 0x1000 - Error Information Handle: Not Provided - Total Width: Unknown - Data Width: Unknown - Size: 4096 MB - Form Factor: DIMM - Set: None - Locator: DIMM 0 - Bank Locator: Not Specified - Type: RAM - Type Detail: Other - Speed: Unknown - Manufacturer: QEMU - Serial Number: Not Specified - Asset Tag: Not Specified - Part Number: Not Specified - Rank: Unknown - Configured Clock Speed: Unknown - Minimum Voltage: Unknown - Maximum Voltage: Unknown - Configured Voltage: Unknown - -The memory in the command output is the same as that configured during ECS creation. - -Possible Causes ---------------- - -When the OS is started, related devices are initialized, which occupies memory. In addition, when the kernel is started, it also occupies memory. The memory occupied by kdump can be set. Unless otherwise specified, do not change the memory size occupied by kdump. - -The command output of **free -m** shows the available memory of the ECS, and that of **dmidecode -t memory** shows the hardware memory. - -Therefore, the memory obtained by running the **free -m** command is less than the memory configured for the ECS. This is a normal phenomenon. - -.. note:: - - This is a normal phenomenon even for physical servers. diff --git a/ecs/umn/result/faqs/ecs_management/how_can_a_changed_static_hostname_take_effect_permanently.rst b/ecs/umn/result/faqs/ecs_management/how_can_a_changed_static_hostname_take_effect_permanently.rst deleted file mode 100644 index a321f8b6..00000000 --- a/ecs/umn/result/faqs/ecs_management/how_can_a_changed_static_hostname_take_effect_permanently.rst +++ /dev/null @@ -1,80 +0,0 @@ -:original_name: en-us_topic_0050735736.html - -.. _en-us_topic_0050735736: - -How Can a Changed Static Hostname Take Effect Permanently? -========================================================== - -Symptom -------- - -The static hostname of a Linux ECS is user defined and injected using Cloud-Init during the ECS creation. Although the hostname can be changed by running the **hostname** command, the changed hostname is restored after the ECS is restarted. - -Changing the Hostname on the ECS --------------------------------- - -To make the hostname changed by running the **hostname** command take effect even after the ECS is stopped or restarted, save the changed hostname into configuration files. - -The changed hostname is assumed to be **new_hostname**. - -#. Modify the **/etc/hostname** configuration file. - - a. Run the following command to edit the configuration file: - - **sudo vim /etc/hostname** - - b. Change the hostname to the new one. - - c. Run the following command to save and exit the configuration file: - - **:wq** - -#. Modify the **/etc/sysconfig/network** configuration file. - - a. Run the following command to edit the configuration file: - - **sudo vim /etc/sysconfig/network** - - b. Change the **HOSTNAME** value to the new hostname. - - **HOSTNAME=**\ *Changed hostname* - - .. note:: - - If there is no **HOSTNAME** in the configuration file, manually add this parameter and set it to the changed hostname. - - An example is provided as follows: - - **HOSTNAME=new_hostname** - - c. Run the following command to save and exit the configuration file: - - **:wq** - -#. Modify the **/etc/cloud/cloud.cfg** configuration file. - - a. Run the following command to edit the configuration file: - - **sudo vim /etc/cloud/cloud.cfg** - - b. Use either of the following methods to modify the configuration file: - - - Method 1: Change the **preserve_hostname** parameter value or add the **preserve_hostname** parameter to the configuration file. - - If **preserve_hostname: false** is already available in the **/etc/cloud/cloud.cfg** configuration file, change it to **preserve_hostname: true**. If **preserve_hostname** is unavailable in the **/etc/cloud/cloud.cfg** configuration file, add **preserve_hostname: true** before **cloud_init_modules**. - - If you use method 1, the changed hostname still takes effect after the ECS is stopped or restarted. However, if the ECS is used to create a private image and the image is used to create a new ECS, the hostname of the new ECS is the hostname (**new_hostname**) used by the private image, and user-defined hostnames cannot be injected using Cloud-Init. - - - Method 2 (recommended): Delete or comment out **- update_hostname**. - - If you use method 2, the changed hostname still takes effect after the ECS is stopped or restarted. If the ECS is used to create a private image and the image is used to create a new ECS, the changed hostname permanently takes effect, and user-defined hostnames (such as **new_new_hostname**) can be injected using Cloud-Init. - -#. Run the following command to restart the ECS: - - **sudo reboot** - -#. Run the following command to check whether the hostname has been changed: - - **sudo hostname** - - If the changed hostname is displayed in the command output, the hostname has been changed and the new name permanently takes effect. diff --git a/ecs/umn/result/faqs/ecs_management/how_do_i_handle_error_messages_displayed_on_the_management_console.rst b/ecs/umn/result/faqs/ecs_management/how_do_i_handle_error_messages_displayed_on_the_management_console.rst deleted file mode 100644 index 5996a72c..00000000 --- a/ecs/umn/result/faqs/ecs_management/how_do_i_handle_error_messages_displayed_on_the_management_console.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0032398121.html - -.. _en-us_topic_0032398121: - -How Do I Handle Error Messages Displayed on the Management Console? -=================================================================== - -Symptom -------- - -This section helps you resolve the following issues: - -- An error message was displayed on the management console after you performed ECS-related operations. -- An error code was displayed after you used an ECS API (see *Elastic Cloud Server API Reference*). - -Background ----------- - -After you perform ECS-related operations on the management console, the system displays the request status on the **Elastic Cloud Server** page. You can determine the request execution status based on the information displayed in the request status. - -- If the operation request is executed, the system automatically clears the task prompt. -- If an error occurs during the request execution, the system displays an error code and its description in the taskbar. - -Solution --------- - -If an error occurs, check the error code and perform the corresponding operations listed in :ref:`Table 1 `. - -.. _en-us_topic_0032398121__table52205309173837: - -.. table:: **Table 1** Error codes and solution suggestions - - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Error Code | Message Displayed on the Management Console | Solution Suggestion | - +=======================+=======================================================================================================================================+=====================================================================================================================================+ - | Ecs.0000 | Request error. Try again later or contact customer service. | Adjust the request structure as directed in *Elastic Cloud Server API Reference*. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0001 | The maximum number of ECSs or EVS disks has been reached. Contact the customer service and request an ECS quota increase. | Contact customer service and request an ECS quota increase. | - | | | | - | | | .. note:: | - | | | | - | | | Before requesting for increasing your ECS quota, consider the number of to-be-added ECSs, vCPUs, and memory capacity required. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0003 | You do not have the permission or your balance is insufficient. | Contact customer service to check your account information. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0005 | System error. Try again later or contact customer service. | Adjust the request structure as directed in *Elastic Cloud Server API Reference*. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0010 | The private IP address is in use. Select an available IP address for ECS creation. | Use an idle IP address for ECS creation. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0011 | Invalid password. Change the password to make it meet the password complexity requirements, and perform the required operation again. | Input a password that meets password complexity requirements. Then, initial the request again. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0012 | Insufficient IP addresses in the subnet. Release IP addresses in the subnet or select another subnet for ECS creation. | Release IP addresses in the subnet or select another subnet for ECS creation. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0013 | Contact customer service and request an EIP quota increase. | Contact customer service and request an EIP quota increase. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0015 | The disk of this type is not supported by the ECS. | Select a proper disk and attach it to the ECS. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0100 | Invalid ECS status. Change the status and try again. | Change the ECS status to the desired one and try again. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0103 | The disk is unavailable. | Change the ECS status to the desired one and try again. If the EVS disk is faulty, contact customer service for troubleshooting. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0104 | The number of disks to be attached to an ECS exceeds the number allowed. | Detach EVS disks from the ECS before attaching new ones. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0105 | No system disk found. | Attach the system disk to the ECS and perform the desired operation again. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Ecs.0107 | The number of shared disks to be attached to an ECS exceeds the maximum limit. | Detach EVS disks from the ECS before attaching new ones. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | Other error codes | Other error messages | Initiate the request again. If the error persists, record the returned error code and contact customer service for troubleshooting. | - +-----------------------+---------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/faqs/ecs_management/index.rst b/ecs/umn/result/faqs/ecs_management/index.rst deleted file mode 100644 index b10f81e7..00000000 --- a/ecs/umn/result/faqs/ecs_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0208808104: - -============== -ECS Management -============== - -.. toctree:: - :maxdepth: 1 - - how_can_a_changed_static_hostname_take_effect_permanently - is_an_ecs_hostname_with_suffix_.novalocal_normal - why_do_the_disks_of_a_windows_ecs_go_offline_after_i_modify_the_ecs_specifications - why_does_the_disk_attachment_of_a_linux_ecs_fail_after_i_modify_the_ecs_specifications - how_do_i_handle_error_messages_displayed_on_the_management_console - why_does_the_system_display_a_question_mark_when_i_attempt_to_obtain_console_logs diff --git a/ecs/umn/result/faqs/ecs_management/is_an_ecs_hostname_with_suffix_.novalocal_normal.rst b/ecs/umn/result/faqs/ecs_management/is_an_ecs_hostname_with_suffix_.novalocal_normal.rst deleted file mode 100644 index 05501876..00000000 --- a/ecs/umn/result/faqs/ecs_management/is_an_ecs_hostname_with_suffix_.novalocal_normal.rst +++ /dev/null @@ -1,34 +0,0 @@ -:original_name: en-us_topic_0094874138.html - -.. _en-us_topic_0094874138: - -Is an ECS Hostname with Suffix .novalocal Normal? -================================================= - -Symptom -------- - -Hostnames of ECSs created based on some types of images have the suffix **.novalocal**, whereas others do not. - -For example, the hostname is set to **abc** during ECS creation. :ref:`Table 1 ` lists the hostnames (obtained by running the **hostname** command) of ECSs created using different images and those displayed after the ECSs are restarted. - -.. _en-us_topic_0094874138__table168595206502: - -.. table:: **Table 1** Hostnames of ECSs created from different images - - ========== =========================== ========================== - Image Hostname Before ECS Restart Hostname After ECS Restart - ========== =========================== ========================== - CentOS 6.8 abc abc.novalocal - CentOS 7.3 abc.novalocal abc.novalocal - Ubuntu 16 abc abc - ========== =========================== ========================== - -Troubleshooting ---------------- - -This is a normal phenomenon. - -The static hostname of a Linux ECS is user defined and injected using Cloud-Init during the ECS creation. According to the test results, Cloud-Init adapts to OSs differently. As a result, hostnames of some ECSs have suffix **.novalocal**, whereas others do not. - -If you do not need suffix **.novalocal** in obtained hostnames, change the hostnames. For details, see :ref:`How Can a Changed Static Hostname Take Effect Permanently? ` diff --git a/ecs/umn/result/faqs/ecs_management/why_do_the_disks_of_a_windows_ecs_go_offline_after_i_modify_the_ecs_specifications.rst b/ecs/umn/result/faqs/ecs_management/why_do_the_disks_of_a_windows_ecs_go_offline_after_i_modify_the_ecs_specifications.rst deleted file mode 100644 index d86b2ba0..00000000 --- a/ecs/umn/result/faqs/ecs_management/why_do_the_disks_of_a_windows_ecs_go_offline_after_i_modify_the_ecs_specifications.rst +++ /dev/null @@ -1,82 +0,0 @@ -:original_name: en-us_topic_0214940105.html - -.. _en-us_topic_0214940105: - -Why Do the Disks of a Windows ECS Go Offline After I Modify the ECS Specifications? -=================================================================================== - -Scenarios ---------- - -After you modify specifications of a Windows ECS, the disks may go offline. Therefore, you need to check the number of disks after you modify the specifications. - -Procedure ---------- - -#. Check whether the number of disks displayed on the **Computer** page after you modified ECS specifications is the same as the number of disks before you modified ECS specifications. - - - If the numbers are the same, the status of the disks is properly. No further action is required. - - If the numbers are different, the disks are offline. In this case, go to step :ref:`2 `. - - For example: - - An ECS running Windows Server 2008 has one system disk and two data disks attached before you modified the specifications. - - .. _en-us_topic_0214940105__en-us_topic_0100593628_fig21898319615: - - .. figure:: /_static/images/en-us_image_0214947577.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Disks before modifying ECS specifications - - After the specifications are modified, check the number of disks. - - .. _en-us_topic_0214940105__en-us_topic_0100593628_fig577522321219: - - .. figure:: /_static/images/en-us_image_0214947578.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Disks after modifying ECS specifications - - Only one system disk is displayed. The data disks are offline after you modify the specifications. - -#. .. _en-us_topic_0214940105__en-us_topic_0100593628_li1476865113179: - - Bring the disks online. - - a. Click **Start** in the task bar. In the displayed **Start** menu, right-click **Computer** and choose **Manage** from the shortcut menu. - - The **Server Manager** page is displayed. - - b. In the navigation pane on the left, choose **Storage** > **Disk Management**. - - The **Disk Management** page is displayed. - - c. In the left pane, the disk list is displayed. Right-click the offline disk and choose **Online** from the shortcut menu to bring it online. - - .. _en-us_topic_0214940105__en-us_topic_0100593628_fig2680331163510: - - .. figure:: /_static/images/en-us_image_0214947579.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Bringing the disk online - -#. On the **Computer** page, check whether the number of disks after you modified ECS specifications is the same as the number of disks before you modified the ECS specifications. - - - If the numbers are the same, no further action is required. - - If the numbers are different, contact customer service. - - .. _en-us_topic_0214940105__en-us_topic_0100593628_fig746964620392: - - .. figure:: /_static/images/en-us_image_0214947580.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Disks after you bring the disks online diff --git a/ecs/umn/result/faqs/ecs_management/why_does_the_disk_attachment_of_a_linux_ecs_fail_after_i_modify_the_ecs_specifications.rst b/ecs/umn/result/faqs/ecs_management/why_does_the_disk_attachment_of_a_linux_ecs_fail_after_i_modify_the_ecs_specifications.rst deleted file mode 100644 index 1cabe905..00000000 --- a/ecs/umn/result/faqs/ecs_management/why_does_the_disk_attachment_of_a_linux_ecs_fail_after_i_modify_the_ecs_specifications.rst +++ /dev/null @@ -1,89 +0,0 @@ -:original_name: en-us_topic_0214940106.html - -.. _en-us_topic_0214940106: - -Why Does the Disk Attachment of a Linux ECS Fail After I Modify the ECS Specifications? -======================================================================================= - -Scenarios ---------- - -After you modify specifications of a Linux ECS, disk attachment may fail. Therefore, you need to check the disk attachment after you modify the specifications. - -Procedure ---------- - -#. Log in to the ECS as user **root**. - -#. .. _en-us_topic_0214940106__en-us_topic_0120890833_li218141135312: - - Run the following command to view the disks attached before specifications modification: - - **fdisk -l** **\| grep 'Disk /dev/'** - - .. _en-us_topic_0214940106__en-us_topic_0120890833_fig10595124010458: - - .. figure:: /_static/images/en-us_image_0214947581.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Viewing disks attached before specifications modification - - As shown in :ref:`Figure 1 `, the ECS has three disks attached: **/dev/vda**, **/dev/vdb**, and **/dev/vdc**. - -#. .. _en-us_topic_0214940106__en-us_topic_0120890833_li161843557534: - - Run the following command to view disks attached after specifications modification: - - **df -h\| grep '/dev/'** - - .. _en-us_topic_0214940106__en-us_topic_0120890833_fig692535712437: - - .. figure:: /_static/images/en-us_image_0214947582.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Viewing disks attached after specifications modification - - As shown in :ref:`Figure 2 `, only one disk **/dev/vda** is attached to the ECS. - -#. Check whether the number of disks obtained in step :ref:`3 ` is the same as that obtained in step :ref:`2 `. - - - If the numbers are the same, the disk attachment is successful. No further action is required. - - If the numbers are different, the disk attachment failed. In this case, go to step :ref:`5 `. - -#. .. _en-us_topic_0214940106__en-us_topic_0120890833_li1478325211557: - - Run the **mount** command to attach the affected disks. - - For example, run the following command: - - **mount /dev/vbd1 /mnt/vbd1** - - In the preceding command, **/dev/vbd1** is the disk to be attached, and **/mnt/vbd1** is the path for disk attachment. - - .. important:: - - Ensure that **/mnt/vbd1** is empty. Otherwise, the attachment will fail. - -#. Run the following commands to check whether the numbers of disks before and after specifications modification are the same: - - **fdisk -l** **\| grep 'Disk /dev/'** - - **df -h\| grep '/dev/'** - - - If the numbers are the same, no further action is required. - - If the numbers are different, contact customer service. - - .. _en-us_topic_0214940106__en-us_topic_0120890833_fig722411124917: - - .. figure:: /_static/images/en-us_image_0214947583.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Checking the number of disks attached - - As shown in :ref:`Figure 3 `, the numbers of disks before and after specifications modification are the same. The disks are **/dev/vda**, **/dev/vdb**, and **/dev/vdc**. diff --git a/ecs/umn/result/faqs/ecs_management/why_does_the_system_display_a_question_mark_when_i_attempt_to_obtain_console_logs.rst b/ecs/umn/result/faqs/ecs_management/why_does_the_system_display_a_question_mark_when_i_attempt_to_obtain_console_logs.rst deleted file mode 100644 index 93b372ee..00000000 --- a/ecs/umn/result/faqs/ecs_management/why_does_the_system_display_a_question_mark_when_i_attempt_to_obtain_console_logs.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: en-us_topic_0088241338.html - -.. _en-us_topic_0088241338: - -Why Does the System Display a Question Mark When I Attempt to Obtain Console Logs? -================================================================================== - -Symptom -------- - -The system displays a question mark (?) when I attempt to obtain the console logs of an ECS. - -.. _en-us_topic_0088241338__fig5159771161128: - -.. figure:: /_static/images/en-us_image_0088242234.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Obtaining console logs - -Possible Causes ---------------- - -The image based on which the ECS was created supports viewing console logs. However, this function is not enabled on the ECS. - -Solution --------- - -Enable management console log obtaining on the ECS. - -For details, see step 1 in section :ref:`Obtaining ECS Console Logs `. diff --git a/ecs/umn/result/faqs/ecs_migration/can_i_migrate_an_ecs_to_another_region_or_account.rst b/ecs/umn/result/faqs/ecs_migration/can_i_migrate_an_ecs_to_another_region_or_account.rst deleted file mode 100644 index 5332787e..00000000 --- a/ecs/umn/result/faqs/ecs_migration/can_i_migrate_an_ecs_to_another_region_or_account.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0236308363.html - -.. _en-us_topic_0236308363: - -Can I Migrate an ECS to Another Region or Account? -================================================== - -Yes. diff --git a/ecs/umn/result/faqs/ecs_migration/index.rst b/ecs/umn/result/faqs/ecs_migration/index.rst deleted file mode 100644 index 91ce2845..00000000 --- a/ecs/umn/result/faqs/ecs_migration/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0208809314: - -============= -ECS Migration -============= - -.. toctree:: - :maxdepth: 1 - - can_i_migrate_an_ecs_to_another_region_or_account diff --git a/ecs/umn/result/faqs/ecs_overview/can_ecss_automatically_recover_after_the_physical_host_accommodating_the_ecss_becomes_faulty.rst b/ecs/umn/result/faqs/ecs_overview/can_ecss_automatically_recover_after_the_physical_host_accommodating_the_ecss_becomes_faulty.rst deleted file mode 100644 index 719b748e..00000000 --- a/ecs/umn/result/faqs/ecs_overview/can_ecss_automatically_recover_after_the_physical_host_accommodating_the_ecss_becomes_faulty.rst +++ /dev/null @@ -1,29 +0,0 @@ -:original_name: en-us_topic_0095020344.html - -.. _en-us_topic_0095020344: - -Can ECSs Automatically Recover After the Physical Host Accommodating the ECSs Becomes Faulty? -============================================================================================= - -Yes. - -ECSs run on physical hosts. Although there are multiple mechanisms to ensure system reliability, fault tolerance, and high availability, host hardware might be damaged or power failures might occur. If physical hosts cannot be powered on or restarted due to damage, CPU and memory data will lose and live migration cannot be used to recovery ECSs. - -The cloud platform provides automatic recovery by default to restart ECSs through cold migration, ensuring high availability and dynamic ECS migration. Once a physical host accommodating ECSs breaks down, the ECSs will automatically migrate to a functional physical host to minimize the impact on your services. During the process, the ECSs will restart. - -.. note:: - - - Automatic recovery does not ensure user data consistency. - - An ECS can be automatically recovered only if the physical server on which it is deployed becomes faulty. This function does not take effect if the fault is caused by the ECS itself. - - An ECS can be automatically recovered only after the physical server on which it is deployed is shut down. If the physical server is not shut down due to a fault, for example, a memory fault, automatic recovery fails to take effect. - - An ECS can be automatically recovered only once within 12 hours if the server on which it is deployed becomes faulty. - - ECS automatic recovery may fail in the following scenarios: - - - No physical server is available for migration due to a system fault. - - The target physical server does not have sufficient temporary capacity. - - - An ECS with any of the following resources cannot be automatically recovered: - - - Local disk - - Passthrough FPGA card - - Passthrough InfiniBand NIC diff --git a/ecs/umn/result/faqs/ecs_overview/index.rst b/ecs/umn/result/faqs/ecs_overview/index.rst deleted file mode 100644 index ade53119..00000000 --- a/ecs/umn/result/faqs/ecs_overview/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0030930805: - -============ -ECS Overview -============ - -.. toctree:: - :maxdepth: 1 - - what_are_the_precautions_for_using_ecss - what_can_i_do_with_ecss - can_ecss_automatically_recover_after_the_physical_host_accommodating_the_ecss_becomes_faulty diff --git a/ecs/umn/result/faqs/ecs_overview/what_are_the_precautions_for_using_ecss.rst b/ecs/umn/result/faqs/ecs_overview/what_are_the_precautions_for_using_ecss.rst deleted file mode 100644 index 3da013d6..00000000 --- a/ecs/umn/result/faqs/ecs_overview/what_are_the_precautions_for_using_ecss.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0013771102.html - -.. _en-us_topic_0013771102: - -What Are the Precautions for Using ECSs? -======================================== - -- Do not upgrade ECS kernel or OS versions. If you want to upgrade the main OS version, for example, from CentOS 7.2 to Cent OS 7.3, use the provided OS changing function. -- Do not uninstall the performance optimization software pre-installed on your ECSs. -- Do not change NIC MAC addresses. Otherwise, the network connection will fail. diff --git a/ecs/umn/result/faqs/ecs_overview/what_can_i_do_with_ecss.rst b/ecs/umn/result/faqs/ecs_overview/what_can_i_do_with_ecss.rst deleted file mode 100644 index ecd274cd..00000000 --- a/ecs/umn/result/faqs/ecs_overview/what_can_i_do_with_ecss.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0018073214.html - -.. _en-us_topic_0018073214: - -What Can I Do with ECSs? -======================== - -You can use ECSs just like traditional physical servers. On an ECS, you can deploy any service application, such as an email system, web system, and Enterprise Resource Planning (ERP) system. After creating an ECS, you can use it like using your local computer or physical server. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_mac_to_a_windows_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_mac_to_a_windows_ecs.rst deleted file mode 100644 index 535e46d5..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_mac_to_a_windows_ecs.rst +++ /dev/null @@ -1,92 +0,0 @@ -:original_name: en-us_topic_0295091738.html - -.. _en-us_topic_0295091738: - -How Can I Transfer Files from a Local Mac to a Windows ECS? -=========================================================== - -Scenarios ---------- - -This section describes how to use Microsoft Remote Desktop for Mac to transfer files from a local Mac to a Windows ECS. - -Prerequisites -------------- - -- The remote access tool supported by Mac has been installed on the local Mac. This section uses Microsoft Remote Desktop for Mac as an example. `Download Microsoft Remote Desktop for Mac `__. -- The target ECS has had an EIP bound. -- When you log in to the ECS for the first time, ensure that RDP has been enabled on it. To do so, use VNC to log in to the ECS, enable RDP, and access the ECS using MSTSC. - - .. note:: - - By default, RDP has been enabled on the ECSs created using a public image. - -Procedure ---------- - -#. Start Microsoft Remote Desktop. - -#. Click **Add Desktop**. - - .. _en-us_topic_0295091738__fig276023113838: - - .. figure:: /_static/images/en-us_image_0295099237.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Add Desktop - -#. Set login parameters. - - - **PC name**: Enter the EIP bound to the target Windows ECS. - - - **User account**: Select **Add User Account** from the drop-down list. - - The **Add a User Account** dialog box is displayed. - - a. Enter username **administrator** and password for logging in to the Windows ECS and click **Add**. - - .. _en-us_topic_0295091738__fig332991311254: - - .. figure:: /_static/images/en-us_image_0295099238.png - :alt: **Figure 2** Add user account - - - **Figure 2** Add user account - - .. _en-us_topic_0295091738__fig6992121711259: - - .. figure:: /_static/images/en-us_image_0295099198.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Add PC - -#. Select the folder to be uploaded. - - a. Click **Folders** and switch to the folder list. - b. Click |image1| in the lower left corner, select the folder to be uploaded, and click **Add**. - -#. On the **Remote Desktop** page, double-click the icon of the target Windows ECS. - - .. _en-us_topic_0295091738__fig020423384416: - - .. figure:: /_static/images/en-us_image_0295099239.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Double-click for login - -#. Confirm the information and click **Continue**. - - You have connected to the Windows ECS. - - View the shared folder on the ECS. - - Copy the files to be uploaded to the ECS. Alternatively, download the files from the ECS to your local Mac. - -.. |image1| image:: /_static/images/en-us_image_0295095212.png - diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_windows_computer_to_a_windows_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_windows_computer_to_a_windows_ecs.rst deleted file mode 100644 index 3198d931..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_transfer_files_from_a_local_windows_computer_to_a_windows_ecs.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0166284970.html - -.. _en-us_topic_0166284970: - -How Can I Transfer Files from a Local Windows Computer to a Windows ECS? -======================================================================== - -Scenarios ---------- - -You want to transfer files from a local Windows computer to a Windows ECS through an MSTSC-based remote desktop connection. - -Prerequisites -------------- - -- The target ECS is running. -- The ECS has an EIP bound. For details, see :ref:`Binding an EIP `. - -- The security group of the ECS allows traffic on port 3389. For details, see :ref:`Configuring Security Group Rules `. - -Solution --------- - -#. On the local Windows computer, click **Start**. In the **Search programs and files** text box, enter **mstsc**. - - The **Remote Desktop Connection** window is displayed. - -#. Click **Options**. - - |image1| - -#. On the **General** tab, enter the EIP bound to the ECS and username **Administrator** for logging in to the ECS. - - |image2| - -#. Click the **Local Resources** tab and verify that **Clipboard** is selected in the **Local devices and resources** pane. - - |image3| - -#. Click **More**. - -#. In the **Drives** pane, select the local disk where the file to be transferred to the Windows ECS is located. - - |image4| - -#. Click **OK** and log in to the Windows ECS. - -#. Choose **Start** > **Computer**. - - The local disk is displayed on the Windows ECS. - -#. Double-click the local disk to access it and copy the file to be transferred to the Windows ECS. - -.. |image1| image:: /_static/images/en-us_image_0166287347.png - -.. |image2| image:: /_static/images/en-us_image_0166287348.png - -.. |image3| image:: /_static/images/en-us_image_0166287349.png - -.. |image4| image:: /_static/images/en-us_image_0166287351.png - diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst deleted file mode 100644 index ac5c371e..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0263806054.html - -.. _en-us_topic_0263806054: - -How Can I Use FTP to Transfer Files Between a Local Linux Computer and a Linux ECS? -=================================================================================== - -Scenarios ---------- - -You want to use FTP on a local Linux computer to transfer files between the computer and a Linux ECS. - -Prerequisites -------------- - -You have enabled FTP on the target ECS. If you have not enabled FTP, check the following links to know how to set up an FTP site: - -Procedure ---------- - -#. Install FTP on the local Linux computer. - - Take CentOS 7.6 as an example. Run the following command to install FTP: - - **yum -y install ftp** - -#. Run the following command to access the ECS: - - **ftp** *EIP bound to the ECS* - - Enter the username and password as prompted for login. - - - **Uploading files** - - Run the following command to upload local files to the ECS: - - **put** *Path in which files are stored on the local computer* - - For example, to upload the **/home/test.txt** file on the local Linux computer to the ECS, run the following command: - - **put /home/test.txt** - - - **Downloading files** - - Run the following command to download files on the ECS to the local computer: - - **get** *Path in which the files are stored on the ECS Path in which the files are to be stored on the local computer* - - For example, to download the **test.txt** file on the ECS to the local Linux computer, run the following command: - - **get /home/test.txt** diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_from_a_local_windows_computer_to_a_windows_or_linux_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_from_a_local_windows_computer_to_a_windows_or_linux_ecs.rst deleted file mode 100644 index c6443549..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_ftp_to_transfer_files_from_a_local_windows_computer_to_a_windows_or_linux_ecs.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_0263806053.html - -.. _en-us_topic_0263806053: - -How Can I Use FTP to Transfer Files from a Local Windows Computer to a Windows or Linux ECS? -============================================================================================ - -Scenarios ---------- - -You want to use FTP to transfer files from a local Windows computer to an ECS. - -Prerequisites -------------- - -You have enabled FTP on the target ECS. If you have not enabled FTP, check the following links to know how to set up an FTP site: - -Procedure ---------- - -#. `Download FileZilla `__ and install it on the local Windows computer. - -#. On the local Windows computer, open FileZilla, enter the information about the target ECS, and click **Quickconnect**. - - - **Host**: EIP bound to the ECS - - **Username**: username set when the FTP site was set up - - **Password**: password of the username - - **Port**: FTP access port, which is port 21 by default - - .. _en-us_topic_0263806053__fig1437792312541: - - .. figure:: /_static/images/en-us_image_0263806339.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting connection parameters - -#. Drag files from the local computer on the left to the target ECS on the right to transfer them. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_scp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_scp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst deleted file mode 100644 index 6fe0e4ed..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_scp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_0263796591.html - -.. _en-us_topic_0263796591: - -How Can I Use SCP to Transfer Files Between a Local Linux Computer and a Linux ECS? -=================================================================================== - -Scenarios ---------- - -You want to use SCP to transfer files between a local Linux computer and a Linux ECS. - -Procedure ---------- - -Log in to the management console. On the **Elastic Cloud Server** page, obtain the EIP bound to the target ECS in the **IP Address** column. - -- **Uploading files** - - Run the following command on the local Linux computer to upload files to the Linux ECS: - - **scp** *Path in which the files are stored on the local computer Username@EIP:Path in which the files are to be stored on the Linux ECS* - - For example, to transfer the **/home/test.txt** file on the local computer to the **/home** directory on the ECS whose EIP is 139.x.x.x, run the following command: - - **scp /home/test.txt root@139.x.x.x:/home** - - Enter the login password as prompted. - - .. _en-us_topic_0263796591__fig14448226162016: - - .. figure:: /_static/images/en-us_image_0263796649.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting file uploading - -- **Downloading files** - - Run the following command on the local Linux computer to download files from the Linux ECS: - - **scp** *Username@EIP:Path in which the files are stored on the Linux ECS Path in which the files are to be stored on the local computer* - - For example, to download the **/home/test.txt** file on the ECS whose EIP is 139.x.x.x to the **/home** directory on the local computer, run the following command: - - **scp root@139.x.x.x:/home/test.txt /home/** - - Enter the login password as prompted. - - .. _en-us_topic_0263796591__fig1437792312541: - - .. figure:: /_static/images/en-us_image_0263796651.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Setting file downloading diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_sftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_sftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst deleted file mode 100644 index 6214b374..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_sftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs.rst +++ /dev/null @@ -1,123 +0,0 @@ -:original_name: en-us_topic_0170139796.html - -.. _en-us_topic_0170139796: - -How Can I Use SFTP to Transfer Files Between a Local Linux Computer and a Linux ECS? -==================================================================================== - -Scenarios ---------- - -You want to use SFTP to transfer files between a local Linux computer and a Linux ECS. The following uses CentOS as an example. - -Procedure ---------- - -#. Log in to the ECS as user **root**. - -#. Run the following command to check the OpenSSH version, which is expected to be 4.8p1 or later: - - **ssh -V** - - Information similar to the following is displayed: - - .. code-block:: - - # OpenSSH_7.4p1, OpenSSL 1.0.2k-fips 26 Jan 2017 - -#. Create a user group and a user (for example, **user1**). - - **groupadd sftp** - - **useradd -g sftp -s /sbin/nologin user1** - -#. Set a password for the user. - - **passwd user1** - - .. _en-us_topic_0170139796__en-us_topic_0138882178_fig282551904413: - - .. figure:: /_static/images/en-us_image_0263798009.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting a password - -#. Assign permissions to directories. - - **chown** **root:sftp /home/user1** - - **chmod 755 -R /home/user1** - - **mkdir /home/user1/upload** - - **chown -R user1:sftp /home/user1/upload** - - **chmod -R 755 /home/user1/upload** - -#. Run the following command to edit the **sshd_config** configuration file: - - **vim /etc/ssh/sshd_config** - - Comment out the following information: - - .. code-block:: - - #Subsystem sftp /usr/libexec/openssh/sftp-server - - Add the following information: - - .. code-block:: - - Subsystem sftp internal-sftp - Match Group sftp - ChrootDirectory /home/%u - ForceCommand internal-sftp - AllowTcpForwarding no - X11Forwarding no - - .. _en-us_topic_0170139796__fig8395112141418: - - .. figure:: /_static/images/en-us_image_0000001071727803.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** sshd_config file with the added information - -#. Run the following command to restart the ECS: - - **service sshd restart** - - Alternatively, run the following command to restart sshd: - - **systemctl restart sshd** - -#. Run the following command on the local computer to set up the connection: - - **sftp root@**\ *IP address* - -#. Run the **sftp** command to check the connection. - - |image1| - -#. Transfer files or folders. - - To upload files or folders, run the **put -r** command. - - |image2| - - To download files or folders, run the **get -r** command. - - |image3| - -.. |image1| image:: /_static/images/en-us_image_0263798010.png - :class: imgResize - -.. |image2| image:: /_static/images/en-us_image_0263798011.png - :class: imgResize - -.. |image3| image:: /_static/images/en-us_image_0263798012.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_winscp_to_transfer_files_from_a_local_windows_computer_to_a_linux_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_winscp_to_transfer_files_from_a_local_windows_computer_to_a_linux_ecs.rst deleted file mode 100644 index b6c97d45..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_can_i_use_winscp_to_transfer_files_from_a_local_windows_computer_to_a_linux_ecs.rst +++ /dev/null @@ -1,56 +0,0 @@ -:original_name: en-us_topic_0166284971.html - -.. _en-us_topic_0166284971: - -How Can I Use WinSCP to Transfer Files from a Local Windows Computer to a Linux ECS? -==================================================================================== - -Scenarios ---------- - -WinSCP can be used to securely copy-paste files across local and remote computers. Compared with FTP, WinSCP allows you to use a username and password to access the destination server without any additional configuration on the server. - -To transfer a file from a local Windows computer to a Linux ECS, WinSCP is commonly used. This section describes how to transfer files from a local Windows computer to a Linux ECS using WinSCP. In this example, the ECS running CentOS 7.2 is used as an example. - -Prerequisites -------------- - -- The target ECS is running. -- The ECS has an EIP bound. For details, see :ref:`Binding an EIP `. - -- The security group of the ECS allows traffic on port 22. For details, see :ref:`Configuring Security Group Rules `. - -Solution --------- - -#. `Download WinSCP `__. - -2. Install WinSCP. - -3. Start WinSCP. - - |image1| - - Set parameters as follows: - - - **File protocol**: Set this to **SFTP** or **SCP**. - - **Host name**: Enter the EIP bound to the ECS. Log in to the management console to obtain the EIP. - - **Port number**: **22** by default. - - **User Name**: Enter the username for logging in to the ECS. - - - If the ECS is logged in using an SSH key pair, - - - The username is **core** for a CoreOS public image. - - The username is **root** for a non-CoreOS public image. - - - If the ECS is logged in using a password, the username is **root** for a public image. - - - **Password**: the password set when you created the ECS or converted using a key. - -4. Click **Login**. - -5. Drag a file from the local computer on the left to the remotely logged in ECS on the right to transfer the file. - -.. |image1| image:: /_static/images/en-us_image_0166287336.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/how_do_i_upload_files_to_my_ecs.rst b/ecs/umn/result/faqs/file_upload_data_transfer/how_do_i_upload_files_to_my_ecs.rst deleted file mode 100644 index cc9d65c1..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/how_do_i_upload_files_to_my_ecs.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0236302789.html - -.. _en-us_topic_0236302789: - -How Do I Upload Files to My ECS? -================================ - -Windows -------- - -- File transfer tool - - Install a file transfer tool, such as FileZilla on both the local computer and the Windows ECS and use it to transfer files. - -- (Recommended) Local disk mapping - - Use MSTSC to transfer files. This method does not support resumable transmission. Therefore, do not use this method to transfer large files. - - For details, see :ref:`How Can I Transfer Files from a Local Windows Computer to a Windows ECS? ` - -- FTP site - - Transfer files through an FTP site. Before transferring files from a local computer to a Windows ECS, set up an FTP site on the ECS and install FileZilla on the local computer. - - For details, see :ref:`How Can I Use FTP to Transfer Files from a Local Windows Computer to a Windows or Linux ECS? ` - -- From a local Mac - - If your local computer runs Mac, use Microsoft Remote Desktop for Mac to transfer files to the Windows ECS For details, see :ref:`How Can I Transfer Files from a Local Mac to a Windows ECS? `. - -Linux ------ - -- From a local Windows computer - - Use WinSCP to transfer the files to the Linux ECS. For details, see :ref:`How Can I Use WinSCP to Transfer Files from a Local Windows Computer to a Linux ECS? ` - - Before transferring files from a local computer to a Linux ECS, set up an FTP site on the ECS and install FileZilla on the local computer. For details, see :ref:`How Can I Use FTP to Transfer Files from a Local Windows Computer to a Windows or Linux ECS? ` - -- From a local Linux computer - - Use SCP to transfer the files to the Linux ECS. For details, see :ref:`How Can I Use SCP to Transfer Files Between a Local Linux Computer and a Linux ECS? ` - - Use SFTP to transfer the files to the Linux ECS. For details, see :ref:`How Can I Use SFTP to Transfer Files Between a Local Linux Computer and a Linux ECS? ` - - Use FTP to transfer the files to the Linux ECS. For details, see :ref:`How Can I Use FTP to Transfer Files Between a Local Linux Computer and a Linux ECS? ` - -Does an ECS Support FTP-based File Transferring by Default? ------------------------------------------------------------ - -No. You need to install and configure FTP so that the ECS supports FTP-based file transfer. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/index.rst b/ecs/umn/result/faqs/file_upload_data_transfer/index.rst deleted file mode 100644 index 5616080a..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _en-us_topic_0170135967: - -========================= -File Upload/Data Transfer -========================= - -.. toctree:: - :maxdepth: 1 - - how_do_i_upload_files_to_my_ecs - how_can_i_transfer_files_from_a_local_windows_computer_to_a_windows_ecs - how_can_i_use_winscp_to_transfer_files_from_a_local_windows_computer_to_a_linux_ecs - how_can_i_transfer_files_from_a_local_mac_to_a_windows_ecs - how_can_i_use_scp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs - how_can_i_use_sftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs - how_can_i_use_ftp_to_transfer_files_from_a_local_windows_computer_to_a_windows_or_linux_ecs - how_can_i_use_ftp_to_transfer_files_between_a_local_linux_computer_and_a_linux_ecs - what_should_i_do_if_the_connection_between_the_client_and_the_server_times_out_when_i_upload_a_file_using_ftp - what_should_i_do_if_writing_data_failed_when_i_upload_a_file_using_ftp - why_am_i_seeing_an_ftp_folder_error_when_i_open_a_folder_on_an_ftp_server - why_do_i_fail_to_connect_to_a_linux_ecs_using_winscp diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_the_connection_between_the_client_and_the_server_times_out_when_i_upload_a_file_using_ftp.rst b/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_the_connection_between_the_client_and_the_server_times_out_when_i_upload_a_file_using_ftp.rst deleted file mode 100644 index 653b2c87..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_the_connection_between_the_client_and_the_server_times_out_when_i_upload_a_file_using_ftp.rst +++ /dev/null @@ -1,27 +0,0 @@ -:original_name: en-us_topic_0170139797.html - -.. _en-us_topic_0170139797: - -What Should I Do If the Connection Between the Client and the Server Times Out When I Upload a File Using FTP? -============================================================================================================== - -Symptom -------- - -When I attempted to access the server from the client to upload a file using FTP, the connection timed out. - -Constraints ------------ - -The operations described in this section apply to FTP on local Windows only. - -Possible Causes ---------------- - -Data is intercepted by the firewall or security group on the server. - -Solution --------- - -#. Check the firewall settings on the server. -#. Disable the firewall or add desired rules to the security group. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_writing_data_failed_when_i_upload_a_file_using_ftp.rst b/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_writing_data_failed_when_i_upload_a_file_using_ftp.rst deleted file mode 100644 index 1da2b419..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/what_should_i_do_if_writing_data_failed_when_i_upload_a_file_using_ftp.rst +++ /dev/null @@ -1,56 +0,0 @@ -:original_name: en-us_topic_0170139798.html - -.. _en-us_topic_0170139798: - -What Should I Do If Writing Data Failed When I Upload a File Using FTP? -======================================================================= - -Symptom -------- - -When I attempted to upload a file using FTP, writing data failed. As a result, the file transfer failed. - -Constraints ------------ - -The operations described in this section apply to FTP on Windows ECSs only. - -Possible Causes ---------------- - -When NAT is enabled on the FTP server, the FTP client must connect to the FTP server in passive mode. In such a case, the public IP address (EIP) of the server cannot be accessed from the router. Therefore, you need to add the EIP to the public IP address list on the server. Additionally, set the port range to limit the number of ports with data forwarded by the router. - -Solution --------- - -The public IP address must be associated with the private IP address using NAT. Therefore, the server must be configured accordingly. - -#. Configure the public IP address of the server. - - Choose **Edit** > **Settings**. - - .. _en-us_topic_0170139798__fig1124882045115: - - .. figure:: /_static/images/en-us_image_0171674763.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting the public IP address - -#. Choose **Passive mode settings**, set the port range (for example, 50000-50100) for transmitting data, and enter the target public IP address. - - .. _en-us_topic_0170139798__fig5351324135118: - - .. figure:: /_static/images/en-us_image_0182087025.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Setting the range of ports for data transmission - -#. Click **OK**. - -#. Allow traffic on TCP ports 50000-50100 and 21 in the security group in the inbound direction. - -#. Test the connection on the client. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/why_am_i_seeing_an_ftp_folder_error_when_i_open_a_folder_on_an_ftp_server.rst b/ecs/umn/result/faqs/file_upload_data_transfer/why_am_i_seeing_an_ftp_folder_error_when_i_open_a_folder_on_an_ftp_server.rst deleted file mode 100644 index 9a80de57..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/why_am_i_seeing_an_ftp_folder_error_when_i_open_a_folder_on_an_ftp_server.rst +++ /dev/null @@ -1,47 +0,0 @@ -:original_name: en-us_topic_0247282819.html - -.. _en-us_topic_0247282819: - -Why Am I Seeing an FTP Folder Error When I Open a Folder on an FTP Server? -========================================================================== - -Symptom -------- - -An error occurs when you open a folder on an FTP server. The system displays a message asking you to check permissions. - -.. _en-us_topic_0247282819__fig15936343121612: - -.. figure:: /_static/images/en-us_image_0247338934.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** FTP Folder Error - -Possible Causes ---------------- - -The FTP firewall configured for the browser does not allow you to open the folder. - -Solution --------- - -The following uses Internet Explorer as an example. - -#. Open the Internet Explorer and choose **Tools** > **Internet options**. - -#. Click the **Advanced** tab. - -#. Deselect **Use Passive FTP (for firewall and DSL modem compatibility)**. - - .. _en-us_topic_0247282819__fig9581026194412: - - .. figure:: /_static/images/en-us_image_0247293312.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Internet Options - -#. Click **OK**, restart Internet Explorer, and open the folder on the FTP server again. diff --git a/ecs/umn/result/faqs/file_upload_data_transfer/why_do_i_fail_to_connect_to_a_linux_ecs_using_winscp.rst b/ecs/umn/result/faqs/file_upload_data_transfer/why_do_i_fail_to_connect_to_a_linux_ecs_using_winscp.rst deleted file mode 100644 index 154d9aaa..00000000 --- a/ecs/umn/result/faqs/file_upload_data_transfer/why_do_i_fail_to_connect_to_a_linux_ecs_using_winscp.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0000001189572473.html - -.. _en-us_topic_0000001189572473: - -Why Do I Fail to Connect to a Linux ECS Using WinSCP? -===================================================== - -Symptom -------- - -Connecting to a Linux ECS using WinSCP fails, while using SSH tools like Xshell succeeds. - -.. _en-us_topic_0000001189572473__fig1580004542818: - -.. figure:: /_static/images/en-us_image_0000001189705789.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Connection error using WinSCP - -Root Cause ----------- - -If you can connect to a Linux ECS using SSH tools, the SSH tools run properly. Check the SFTP configuration file because WinSCP allows you to connect your Linux ECS via SFTP protocol. - -Run the following command to view the **/etc/ssh/sshd_config** file: - -**vi /etc/ssh/sshd_config** - -Check the SFTP configuration and the configuration file is **/usr/libexec/openssh/sftp-server**. - -.. _en-us_topic_0000001189572473__fig6965144916501: - -.. figure:: /_static/images/en-us_image_0000001150707636.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** SFTP configuration file - -If the SFTP configuration file does not exist or the file permission is not 755, connecting to a Linux ECS using WinSCP will fail. - -Solution --------- - -- If the SFTP configuration file does not exist, you can transfer the file from an ECS that runs properly to your Linux ECS using SCP or other file transfer tools. - -- If the file permission is not 755, you can run the following command to change the file permission to 755: - - **chmod 755 -R** **/usr/libexec/openssh/sftp-server** diff --git a/ecs/umn/result/faqs/index.rst b/ecs/umn/result/faqs/index.rst deleted file mode 100644 index f3421ac1..00000000 --- a/ecs/umn/result/faqs/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _en-us_topic_0013771101: - -==== -FAQs -==== - -.. toctree:: - :maxdepth: 1 - - ecs_overview/index - creation_and_deletion/index - login_and_connection/index - ecs_management/index - os_management/index - file_upload_data_transfer/index - ecs_migration/index - disk_management/index - passwords_and_key_pairs/index - network_configurations/index - resource_management_and_tags/index - resource_monitoring/index - database_applications/index diff --git a/ecs/umn/result/faqs/login_and_connection/how_can_i_change_a_remote_login_port.rst b/ecs/umn/result/faqs/login_and_connection/how_can_i_change_a_remote_login_port.rst deleted file mode 100644 index 4bdab833..00000000 --- a/ecs/umn/result/faqs/login_and_connection/how_can_i_change_a_remote_login_port.rst +++ /dev/null @@ -1,141 +0,0 @@ -:original_name: en-us_topic_0244854543.html - -.. _en-us_topic_0244854543: - -How Can I Change a Remote Login Port? -===================================== - -Scenarios ---------- - -This section describes how to change a port for remote logins. - -Windows -------- - -The following procedure uses an ECS running Windows Server 2012 as an example. The default login port of a Windows ECS is 3389. To change it to port 2020, for example, do as follows: - -#. In the **Run** dialog box, enter **regedit** to access the registry editor. - -#. In **Registry Editor**, choose **HKEY_LOCAL_MACHINE** > **SYSTEM** > **CurrentControlSet** > **Control** > **Terminal Server** > **Wds** > **rdpwd** > **Tds** > **tcp** and double-click **PortNumber**. - - a. In the dialog box that is displayed, set **Base** to **Decimal**. - - b. Change the value in **Value data** to the new port number, which is **2020** in this example. - - .. _en-us_topic_0244854543__fig6797745202319: - - .. figure:: /_static/images/en-us_image_0244859999.png - :alt: **Figure 1** Changing the port number to 2020 - - - **Figure 1** Changing the port number to 2020 - -#. In **Registry Editor**, choose **HKEY_LOCAL_MACHINE** > **SYSTEM** > **CurrentControlSet** > **Control** > **Terminal Server** > **WinStations** > **RDP-Tcp** and double-click **PortNumber**. - - a. In the dialog box that is displayed, set **Base** to **Decimal**. - - b. Change the value in **Value data** to the new port number, which is **2020** in this example. - - .. _en-us_topic_0244854543__en-us_topic_0244854543_fig6797745202319: - - .. figure:: /_static/images/en-us_image_0244859999.png - :alt: **Figure 2** Changing the port number to 2020 - - - **Figure 2** Changing the port number to 2020 - -#. Open the Windows search box, enter **services**, and select **Services**. - - .. _en-us_topic_0244854543__fig178235222919: - - .. figure:: /_static/images/en-us_image_0244860550.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Services - -#. (Skip this step if the firewall is disabled.) Modify the inbound rules of the firewall. - - Choose **Control Panel** > **Windows Firewall** > **Advanced Settings** > **Inbound Rules** > **New Rule**. - - - **Rule Type**: **Port** - - Protocol in **Protocol and Ports**: **TCP** - - Port in **Protocol and Ports**: **Specific local ports**, **2020** in this example - - **Action**: **Allow the connection** - - **Profile**: Default settings - - **Name**: **RDP-2020** - - After the configuration, refresh the page to view the new rule. - -#. Modify the security group rule. - - Add an inbound rule in which **Protocol** is set to **TCP** and **Port Range** is set to **2020**. - - Use port 2020 to remotely log in to the ECS. - -#. In the **Services** window, restart **Remote Desktop Services** or the ECS. - -Linux ------ - -The following procedure uses an ECS running CentOS 7.3 as an example. The default login port of a Linux ECS is 22. To change it to port 2020, for example, do as follows: - -#. Run the following command to edit the sshd configuration file: - - **vi /etc/ssh/sshd_config** - -#. Delete the comment tag (#) from the **#port 22** line and change **22** to **2020**. - - .. _en-us_topic_0244854543__fig188937250516: - - .. figure:: /_static/images/en-us_image_0244856480.png - :alt: **Figure 4** Changing the port number to 2020 - - - **Figure 4** Changing the port number to 2020 - -#. Press **Esc** to exit the editing mode. Enter **:wq!** to save and exit the configuration. - -#. Run either of the following commands to restart sshd: - - **service sshd restart** - - Or - - **systemctl restart sshd** - -#. Skip this step if the firewall is disabled. Configure the firewall. - - The firewall varies depending on the CentOS version. CentOS 7 uses firewalld, and CentOS 6 uses iptables. The following operations use CentOS 7 as an example. - - Run the **firewall-cmd --state** command to check the firewall status. - - - (Recommended) Method 1: Add information about a new port to firewalld. - - a. Run the following commands to add a rule for port 2020: - - **firewall-cmd --zone=public --add-port=2020/tcp --permanent** - - **firewall-cmd --reload** - - b. View the added port. The TCP connection of port 2020 will have been added. - - **firewall-cmd --list-all** - - c. Restart firewalld. - - **systemctl restart firewalld.service** - - - Method 2: Disable the firewall and the function of automatically enabling the firewall upon ECS startup. - - **systemctl stop firewalld** - - **systemctl disable firewalld** - -#. Modify the security group rule. - - Add an inbound rule in which **Protocol** is set to **TCP** and **Port Range** is set to **2020**. - - Use port 2020 to remotely log in to the ECS. diff --git a/ecs/umn/result/faqs/login_and_connection/how_can_i_log_in_to_an_ecs_after_its_system_disk_is_exchanged_with_that_attached_to_another_ecs_running_the_same_os.rst b/ecs/umn/result/faqs/login_and_connection/how_can_i_log_in_to_an_ecs_after_its_system_disk_is_exchanged_with_that_attached_to_another_ecs_running_the_same_os.rst deleted file mode 100644 index 2d566c52..00000000 --- a/ecs/umn/result/faqs/login_and_connection/how_can_i_log_in_to_an_ecs_after_its_system_disk_is_exchanged_with_that_attached_to_another_ecs_running_the_same_os.rst +++ /dev/null @@ -1,88 +0,0 @@ -:original_name: en-us_topic_0100005619.html - -.. _en-us_topic_0100005619: - -How Can I Log In to an ECS After Its System Disk Is Exchanged with That Attached to Another ECS Running the Same OS? -==================================================================================================================== - -Symptom -------- - -Two ECSs run the same OS, for example, both run Windows or Linux. The system disks attached to the two ECSs are exchanged offline. After the exchanging, the login keys of the ECSs may change. In such a case, how can I log in to the ECSs? - -.. note:: - - Before stopping an ECS for disk detachment, release the IP address assigned to the ECS using DHCP so that ECS can correctly obtain an IP address later. To do so, perform the following operations: - - #. Log in to the Windows ECS. - - #. Run the following command to release the IP address: - - **ipconfig /release** - - This operation will interrupt network connections and affect the use of the ECS. After the ECS is restarted, network connections will automatically recover. - -Windows -------- - -For example, there are two Windows ECSs with parameters configured in :ref:`Table 1 `. - -.. _en-us_topic_0100005619__table1365540183310: - -.. table:: **Table 1** Parameter configurations - - ====== =========== ========== - ECS System Disk Key Pair - ====== =========== ========== - ecs_01 vol_01 Keypair_01 - ecs_02 vol_02 Keypair_02 - ====== =========== ========== - -System disk vol_01 is detached from ecs_01 offline and then attached to ecs_02 as the system disk. How can I log in to ecs_02? - -The random password for logging in to ecs_02 must be resolved again. The procedure is as follows: - -#. Delete the initial password for logging in to ecs_02. - - Locate the row containing ecs_02, click **More** in the **Operation** column, and select **Delete Password** from the drop-down list. Then, click **Delete**. - - .. note:: - - ecs_02 must be in **Stopped** state. - -#. Start ecs_02. - - Locate the row containing ecs_02, click **More** in the **Operation** column, and select **Start** from the drop-down list. Then, in the **Start ECS** dialog box, click **OK**. - -#. .. _en-us_topic_0100005619__li138721252141517: - - Obtain the password for logging in to ecs_02. - - a. Locate the row containing ecs_02, click **More** in the **Operation** column, and select **Get Password** from the drop-down list. - b. Click **Select File** and upload private key file **Keypair_02** of ecs_02. - c. Click **Get Password** to obtain a new random password. - -#. Use the random password obtained in step :ref:`3 ` to log in to ecs_02 with the system disk replaced. - -Linux ------ - -For example, there are two Linux ECSs with parameters configured in :ref:`Table 2 `. - -.. _en-us_topic_0100005619__table9561950195614: - -.. table:: **Table 2** Parameter configurations - - ====== =========== ========== - ECS System Disk Key Pair - ====== =========== ========== - ecs_01 vol_01 Keypair_01 - ecs_02 vol_02 Keypair_02 - ====== =========== ========== - -System disk vol_01 is detached from ecs_01 offline and then attached to ecs_02 as the system disk. How can I log in to ecs_02? - -Use either of the following methods to log in to ecs_02: - -- Use private key file **Keypair_01** of ecs_01. -- Use private key file **Keypair_02** of ecs_02. diff --git a/ecs/umn/result/faqs/login_and_connection/how_can_i_obtain_the_permission_to_remotely_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/how_can_i_obtain_the_permission_to_remotely_log_in_to_a_windows_ecs.rst deleted file mode 100644 index bb999743..00000000 --- a/ecs/umn/result/faqs/login_and_connection/how_can_i_obtain_the_permission_to_remotely_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,49 +0,0 @@ -:original_name: en-us_topic_0264235940.html - -.. _en-us_topic_0264235940: - -How Can I Obtain the Permission to Remotely Log In to a Windows ECS? -==================================================================== - -Symptom -------- - -When you connect a remote desktop to a Windows ECS, the system prompts that you need to be granted the right to sign in through Remote Desktop Services. - -.. _en-us_topic_0264235940__en-us_topic_0250966366_fig4498153973513: - -.. figure:: /_static/images/en-us_image_0288997257.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Remote login right missing. - -Solution --------- - -#. Open the **cmd** window and enter **gpedit.msc**. -#. Click **OK** to start Local Group Policy Editor. -#. Choose **Computer Configuration** > **Windows Settings** > **Security Settings** > **Local Policies** > **User Rights Assignment**. - - a. Locate and double-click **Allow log on through Remote Desktop Services**. Ensure that **Administrators** and **Remote Desktop Users** have been added. - - .. _en-us_topic_0264235940__en-us_topic_0250966366_fig597875822711: - - .. figure:: /_static/images/en-us_image_0288997258.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Allow log on through Remote Desktop Services properties - - b. Locate and double-click **Deny log on through Remote Desktop Services**. If the administrator account exists, delete it. - - .. _en-us_topic_0264235940__en-us_topic_0250966366_fig1693533120329: - - .. figure:: /_static/images/en-us_image_0288997259.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Deny log on through Remote Desktop Services properties diff --git a/ecs/umn/result/faqs/login_and_connection/index.rst b/ecs/umn/result/faqs/login_and_connection/index.rst deleted file mode 100644 index c79e3e49..00000000 --- a/ecs/umn/result/faqs/login_and_connection/index.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. _en-us_topic_0030930807: - -==================== -Login and Connection -==================== - -.. toctree:: - :maxdepth: 1 - - why_are_characters_entered_through_vnc_still_incorrect_after_the_keyboard_language_is_switched - what_should_i_do_if_i_cannot_use_the_german_keyboard_to_enter_characters_when_i_log_in_to_a_linux_ecs_using_vnc - why_cannot_i_use_the_mac_keyboard_to_enter_lowercase_characters_when_i_log_in_to_an_ecs_using_vnc - what_should_i_do_if_the_page_does_not_respond_after_i_log_in_to_an_ecs_using_vnc_and_do_not_perform_any_operation_for_a_long_period_of_time - what_should_i_do_if_i_cannot_view_data_after_logging_in_to_an_ecs_using_vnc - why_does_a_blank_screen_appear_while_the_system_displays_a_message_indicating_successful_authentication_after_i_attempted_to_log_in_to_an_ecs_using_vnc - how_can_i_change_a_remote_login_port - why_cant_i_obtain_the_password_for_logging_in_to_my_windows_ecs_authenticated_using_a_key_pair - what_browser_version_is_required_to_remotely_log_in_to_an_ecs - how_can_i_log_in_to_an_ecs_after_its_system_disk_is_exchanged_with_that_attached_to_another_ecs_running_the_same_os - why_does_the_system_display_a_message_indicating_that_the_password_for_logging_in_to_a_windows_ecs_cannot_be_viewed - why_does_an_authentication_failure_occurs_after_i_attempt_to_remotely_log_in_to_a_windows_ecs - why_cant_i_use_the_local_computer_to_connect_to_my_windows_ecs - how_can_i_obtain_the_permission_to_remotely_log_in_to_a_windows_ecs - why_does_the_system_display_no_remote_desktop_license_servers_available_to_provide_a_license_when_i_log_in_to_a_windows_ecs - why_does_the_system_display_error_code_0x112f_when_i_log_in_to_a_windows_ecs - why_does_the_system_display_error_code_0x1104_when_i_log_in_to_a_windows_ecs - why_does_the_system_display_error_code_122.112.._when_i_log_in_to_a_windows_ecs - why_does_the_system_display_invalid_certificate_or_associated_chain_when_i_log_in_to_a_windows_ecs_from_a_mac - why_is_my_remote_session_interrupted_by_a_protocol_error - why_am_i_seeing_an_error_message_that_says_identity_of_remote_computer_cannot_be_verified_when_i_log_in_to_a_windows_ecs - why_am_i_seeing_an_error_message_that_says_the_two_computers_couldnt_be_connected_in_the_amount_of_time_allotted_when_i_log_in_to_a_windows_ecs - why_am_i_seeing_an_error_message_that_says_user_account_is_not_authorized_for_remote_login_when_i_log_in_to_a_windows_ecs - why_does_my_remote_desktop_session_end_because_another_user_logs_in_when_i_log_in_to_a_windows_ecs - why_does_an_ecs_fail_to_be_remotely_connected_using_rdp_and_internal_error_code_4_is_displayed - why_am_i_seeing_the_error_message_module_is_unknown_when_i_remotely_log_in_to_a_linux_ecs - what_should_i_do_if_error_message_permission_denied_is_displayed_when_i_remotely_log_in_to_a_linux_ecs - what_should_i_do_if_error_message_read_connection_reset_by_peer_is_displayed_when_i_remotely_log_in_to_a_linux_ecs - why_am_i_seeing_the_error_message_access_denied_when_i_remotely_log_in_to_a_linux_ecs - what_should_i_do_if_error_message_disconnected_no_supported_authentication_methods_available_is_displayed_when_i_remotely_log_in_to_a_linux_ecs diff --git a/ecs/umn/result/faqs/login_and_connection/what_browser_version_is_required_to_remotely_log_in_to_an_ecs.rst b/ecs/umn/result/faqs/login_and_connection/what_browser_version_is_required_to_remotely_log_in_to_an_ecs.rst deleted file mode 100644 index ba552061..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_browser_version_is_required_to_remotely_log_in_to_an_ecs.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: en-us_topic_0035233718.html - -.. _en-us_topic_0035233718: - -What Browser Version Is Required to Remotely Log In to an ECS? -============================================================== - -When you use a browser to remotely log in to an ECS, ensure that the browser version meets the requirements listed in :ref:`Table 1 `. - -.. _en-us_topic_0035233718__table1532118512038: - -.. table:: **Table 1** Browser version requirements - - ================= ========= - Browser Version - ================= ========= - Google Chrome 31.0-75.0 - Mozilla Firefox 27.0-62.0 - Internet Explorer 10.0-11.0 - ================= ========= diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_disconnected_no_supported_authentication_methods_available_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_disconnected_no_supported_authentication_methods_available_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst deleted file mode 100644 index 9bb11953..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_disconnected_no_supported_authentication_methods_available_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0277132844.html - -.. _en-us_topic_0277132844: - -What Should I Do If Error Message "Disconnected: No supported authentication methods available" Is Displayed When I Remotely Log In to a Linux ECS? -=================================================================================================================================================== - -Symptom -------- - -When I attempted to remotely log in to a Linux ECS, the system displayed error message "Disconnected: No supported authentication methods available". - -.. _en-us_topic_0277132844__fig2069165133516: - -.. figure:: /_static/images/en-us_image_0277132897.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** No supported authentication methods available - -Possible Causes ---------------- - -A policy that denies password-authenticated logins is enabled on the SSH server. - -Solution --------- - -#. Open the **/etc/ssh/sshd_config** file and check the following settings: - - **vi /etc/ssh/sshd_config** - -#. Modify the following settings: - - Change **PasswordAuthentication no** to **PasswordAuthentication yes**. - - Alternatively, delete the comment tag (#) before **PasswordAuthentication yes**. - -#. Restart SSH. - - - CentOS 6 - - **service sshd restart** - - - CentOS 7 - - **systemctl restart sshd** diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_permission_denied_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_permission_denied_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst deleted file mode 100644 index 5de9a80c..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_permission_denied_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0240708483.html - -.. _en-us_topic_0240708483: - -What Should I Do If Error Message "Permission denied" Is Displayed When I Remotely Log In to a Linux ECS? -========================================================================================================= - -Symptom -------- - -When I attempted to remotely log in to a Linux ECS, the system displayed error Message "Permission denied". - -.. _en-us_topic_0240708483__fig5631046188: - -.. figure:: /_static/images/en-us_image_0240710556.png - :alt: **Figure 1** Permission denied - - - **Figure 1** Permission denied - -.. note:: - - - To resolve this issue, you are required to restart the ECS and enter the rescue mode. - - Restarting the ECS may interrupt services. Exercise caution when performing this operation. - -Root Cause ----------- - -The **nofile** parameter in **/etc/security/limits.conf** is used to set the maximum number of files that can be opened in the system. If the value is greater than the **fs.nr_open** value (**1048576** by default) set in **PermissionDenied.png**, a login verification error will occur, leading to "Permission denied". - -Solution --------- - -#. Enter the single-user mode. - - The following uses CentOS 7 as an example: - - a. Restart the ECS and click **Remote Login**. - - b. Click **Ctrl+Alt+Del** in the upper part of the remote login panel to restart the ECS. - - c. Press the up arrow key to prevent automatic system startup. When the kernels are displayed, press **e** to enter the editing mode. - - .. _en-us_topic_0240708483__en-us_topic_0240708482_fig1087511256811: - - .. figure:: /_static/images/en-us_image_0240711431.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Entering the kernel editing mode - - .. note:: - - The grub file is encrypted by Euler images by default. Before entering the edit mode, you need to contact customer service to obtain username and password. - - d. Locate the row containing **linux16** and delete the parameters you do not require. - - e. Change **ro** to **rw** for mounting the root partition with read-write permissions. - - f. Add **rd.break** and press **Ctrl+X**. - - .. _en-us_topic_0240708483__en-us_topic_0240708482_fig1654418212503: - - .. figure:: /_static/images/en-us_image_0260575520.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Before the modification - - .. _en-us_topic_0240708483__en-us_topic_0240708482_fig1954412105016: - - .. figure:: /_static/images/en-us_image_0260575521.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** After the modification - - g. Run the following command to go to the **/sysroot** directory: - - **# chroot /sysroot** - -2. .. _en-us_topic_0240708483__li12380124143314: - - Run the following command to view the **fs.nr_open** value: - - **sysctl fs.nr_open** - -3. Change the **nofile** value in **/etc/security/limits.conf** so that the value is smaller than the **fs.nr_open** value obtained in :ref:`2 `. - - **vi /etc/security/limits.conf** - - .. note:: - - **limits.conf** is the **pam_limits.so** configuration file of Linux Pluggable Authentication Module (PAM). For more details, run the following command: - - **man limits.conf** - -4. Restart the ECS and try to log in to it again. diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_read_connection_reset_by_peer_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_read_connection_reset_by_peer_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst deleted file mode 100644 index e1628c39..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_error_message_read_connection_reset_by_peer_is_displayed_when_i_remotely_log_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,73 +0,0 @@ -:original_name: en-us_topic_0240714337.html - -.. _en-us_topic_0240714337: - -What Should I Do If Error Message "read: Connection reset by peer" Is Displayed When I Remotely Log In to a Linux ECS? -====================================================================================================================== - -Symptom -------- - -When I attempted to remotely log in to a Linux ECS, the system displayed error message "read: Connection reset by peer". - -.. _en-us_topic_0240714337__fig5631046188: - -.. figure:: /_static/images/en-us_image_0240714761.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** read: Connection reset by peer - -Possible Causes ---------------- - -- The remote login port is not permitted in the security group. -- The firewall is enabled on the ECS, but the remote login port is blocked by the firewall. - -Solution --------- - -Perform the following operations for troubleshooting: - -- **Check security group rules.** - - - Inbound: Add the remote login port. The default port 22 is used as an example. - - - Outbound: Outbound rules allow network traffic to be out of specified ports. - -- **Add a port to the ECS firewall exception.** - - The following uses Ubuntu as an example: - - #. Run the following command to view the firewall status: - - **sudo ufw status** - - The following information is displayed: - - .. code-block:: - - Status: active - - #. Add a port to the firewall exception, taking the default port 22 as an example. - - **ufw allow 22** - - **Rule added** - - **Rule added (v6)** - - #. Run following command to check the firewall status again: - - **sudo ufw status** - - .. code-block:: - - Status: active - To Action From - -- ------ ---- - 22 ALLOW Anywhere - 22 (v6) ALLOW Anywhere (v6) - - Try to remotely log in to the ECS again. diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_use_the_german_keyboard_to_enter_characters_when_i_log_in_to_a_linux_ecs_using_vnc.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_use_the_german_keyboard_to_enter_characters_when_i_log_in_to_a_linux_ecs_using_vnc.rst deleted file mode 100644 index 67fa0290..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_use_the_german_keyboard_to_enter_characters_when_i_log_in_to_a_linux_ecs_using_vnc.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_0030932496.html - -.. _en-us_topic_0030932496: - -What Should I Do If I Cannot Use the German Keyboard to Enter Characters When I Log In to a Linux ECS Using VNC? -================================================================================================================ - -Changing the OS Keyboard Language ---------------------------------- - -Run the following command to change the OS keyboard language: - -**loadkeys** *keymapfile* - -*keymapfile* is the name of the file for the mapping between keys and displayed characters. - -For example, if the name of a German keyboard mapping file is **de**, run the **loadkeys de** command. - -For instructions about how to configure the keyboard language for a Linux ECS, see :ref:`Login Using VNC `. - -Procedure ---------- - -- For all Linux ECSs, characters **â**, **ê**, **ô**, **û**, and **î** cannot be entered properly. To enter such characters, use either of the following methods: - - Method 1: Press **^+Space+Letter key**. - - Method 2: Click **^°** on the VNC page and then press the suitable key on the keyboard. - -- For all Linux ECSs, characters **²**, **³**, **{**, **[**, **]**, **}**, **\\**, **@**, **€**, **\|**, and **µ** cannot be entered properly. To enter such characters, use the following method: - - Click **AltGr** on the VNC page and then press the suitable key on the physical keyboard. - - An example is provided as follows: - - To obtain character **²**, perform the following operations: - - #. Click **AltGr** on the VNC page. - - This operation is successful if **AltGr** turns red. - - #. On a physical keyboard, press key **2**. - - The system displays special characters **²**. - - #. Click **AltGr** on the VNC page again to cancel the hold-down state. - -- For all Linux ECSs, character **~** cannot be entered properly. To enter such a character, use the following method: - - Click **AltGr** on the VNC page and then press the tilde (~) key on the keyboard twice. - -- For ECSs running CentOS 7, the following characters cannot be entered normally: ^ ´ \` - - To enter these characters, press the key on the keyboard twice and then press **Space**. - -- For ECSs running CentOS 7, when **Caps Lock** is enabled, the following characters cannot be entered normally: Ö Ä Ü - - To enter these characters, hold **Shift** and press the letter key on the keyboard. diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_view_data_after_logging_in_to_an_ecs_using_vnc.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_view_data_after_logging_in_to_an_ecs_using_vnc.rst deleted file mode 100644 index 041052bc..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_i_cannot_view_data_after_logging_in_to_an_ecs_using_vnc.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0030932499.html - -.. _en-us_topic_0030932499: - -What Should I Do If I Cannot View Data After Logging In to an ECS Using VNC? -============================================================================ - -After you log in to an ECS using VNC and view data, for example, play videos or run the **cat** command to view large files, VNC may become unavailable due to the high memory usage of the browser. In such a case, use another browser and log in to the ECS again. diff --git a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_the_page_does_not_respond_after_i_log_in_to_an_ecs_using_vnc_and_do_not_perform_any_operation_for_a_long_period_of_time.rst b/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_the_page_does_not_respond_after_i_log_in_to_an_ecs_using_vnc_and_do_not_perform_any_operation_for_a_long_period_of_time.rst deleted file mode 100644 index c990f955..00000000 --- a/ecs/umn/result/faqs/login_and_connection/what_should_i_do_if_the_page_does_not_respond_after_i_log_in_to_an_ecs_using_vnc_and_do_not_perform_any_operation_for_a_long_period_of_time.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0030932497.html - -.. _en-us_topic_0030932497: - -What Should I Do If the Page Does not Respond After I Log In to an ECS Using VNC and Do Not Perform Any Operation for a Long Period of Time? -============================================================================================================================================ - -If your computer is running Windows 7 and you logged in to the ECS using Internet Explorer 10 or 11, click **AltGr** twice on the VNC page to activate the page. diff --git a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_identity_of_remote_computer_cannot_be_verified_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_identity_of_remote_computer_cannot_be_verified_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 3a8d12a5..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_identity_of_remote_computer_cannot_be_verified_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: en-us_topic_0264235946.html - -.. _en-us_topic_0264235946: - -Why Am I Seeing an Error Message That Says Identity of Remote Computer Cannot be Verified When I Log In to a Windows ECS? -========================================================================================================================= - -Symptom -------- - -An error message is displayed indicating that the identity of the remote computer cannot be verified. You are required to enter the password and log in again. - -.. _en-us_topic_0264235946__en-us_topic_0173592522_en-us_topic_0120795668_fig1256612592310: - -.. figure:: /_static/images/en-us_image_0288997421.png - :alt: **Figure 1** Protocol error - - - **Figure 1** Protocol error - -Possible Causes ---------------- - -Security software installed on the ECS prevents logins from unknown IP addresses. - -Solution --------- - -- Uninstall the security software. -- Open the security software and enable the default login mode. diff --git a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_the_two_computers_couldnt_be_connected_in_the_amount_of_time_allotted_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_the_two_computers_couldnt_be_connected_in_the_amount_of_time_allotted_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 991a5402..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_the_two_computers_couldnt_be_connected_in_the_amount_of_time_allotted_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,27 +0,0 @@ -:original_name: en-us_topic_0264235947.html - -.. _en-us_topic_0264235947: - -Why Am I Seeing An Error Message That Says The Two Computers Couldn't Be Connected in the Amount of Time Allotted When I Log In to a Windows ECS? -================================================================================================================================================= - -Symptom -------- - -An error message is displayed indicating that the computer cannot connect to the remote computer in the amount of time allotted. - -.. _en-us_topic_0264235947__en-us_topic_0173599485_en-us_topic_0120795668_fig1256612592310: - -.. figure:: /_static/images/en-us_image_0288997357.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Error message - -Solution --------- - -#. On the local computer, click on the **Start** icon, type **cmd** into the box, and run the command as an administrator. -#. Run the **netsh winsock reset** command. -#. Restart the local computer as prompted and reconnect to the ECS. diff --git a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_user_account_is_not_authorized_for_remote_login_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_user_account_is_not_authorized_for_remote_login_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 2330d85a..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_an_error_message_that_says_user_account_is_not_authorized_for_remote_login_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0264235948.html - -.. _en-us_topic_0264235948: - -Why Am I Seeing an Error Message That Says User Account is not Authorized for Remote Login When I Log In to a Windows ECS? -========================================================================================================================== - -Symptom -------- - -An error message is displayed indicating that the connection is denied because the user account is not authorized for remote login. - -.. _en-us_topic_0264235948__en-us_topic_0173606024_en-us_topic_0120795668_fig1256612592310: - -.. figure:: /_static/images/en-us_image_0288997346.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Error message - -Possible Causes ---------------- - -The remote desktop connection permissions have been incorrectly configured. - -Solution --------- - -#. Check remote desktop permissions on the ECS. - - a. In the **Run** dialog box, enter **secpol.msc** and click **OK** to open **Local Security Policy**. - - b. Choose **Local Policies** > **User Rights Assignment** > **Allow log on through Remote Desktop Services**. - - .. _en-us_topic_0264235948__en-us_topic_0173606024_fig1890412198313: - - .. figure:: /_static/images/en-us_image_0288997347.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Local security policy - - c. Check whether there are user groups or users that have been granted the remote login permission. - - If not, add required users or groups. - - .. _en-us_topic_0264235948__en-us_topic_0173606024_fig1492115211134: - - .. figure:: /_static/images/en-us_image_0288997348.png - :alt: **Figure 3** Allow log on through Remote Desktop Services properties - - - **Figure 3** Allow log on through Remote Desktop Services properties - -#. Check the target user group. - - a. Open the **Run** dialog box, enter **lusrmgr.msc**, and click **OK** to open **Local Users and Groups**. - - b. .. _en-us_topic_0264235948__en-us_topic_0173606024_li19821176204810: - - Double-click **Users** on the left. - - c. Double-click the name of the user to whom the login error message was displayed. - - d. In the displayed dialog box, click the **Member Of** tab. Ensure that the user belongs to the user group that is assigned with the remote login permission in :ref:`2.b `. - - .. _en-us_topic_0264235948__en-us_topic_0173606024_fig37037542514: - - .. figure:: /_static/images/en-us_image_0288997349.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Checking the target user group - -#. Check the remote desktop session host configuration. - - a. In the **Run** dialog box, enter **tsconfig.msc** and click **OK** to open **Remote Desktop Session Host Configuration**. - - b. Double-click **RDP-Tcp** or other connections added by a user under **Connections** and click the **Security** tab. - - .. _en-us_topic_0264235948__en-us_topic_0173606024_fig76712011540: - - .. figure:: /_static/images/en-us_image_0288997350.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Security - - c. Check whether there are user groups or users that have been granted the remote login permission under **Group or user names**. - - If not, add required users or groups. - - d. Restart the ECS or run the following commands in the CLI to restart the Remote Desktop Services: - - **net stop TermService** - - **net start TermService** diff --git a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_access_denied_when_i_remotely_log_in_to_a_linux_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_access_denied_when_i_remotely_log_in_to_a_linux_ecs.rst deleted file mode 100644 index e521f755..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_access_denied_when_i_remotely_log_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,42 +0,0 @@ -:original_name: en-us_topic_0277097520.html - -.. _en-us_topic_0277097520: - -Why Am I Seeing the Error Message "Access denied" When I Remotely Log In to a Linux ECS? -======================================================================================== - -Symptom -------- - -When you attempt to remotely log in to a Linux ECS, the system displays the error message "Access denied". - -Possible Causes ---------------- - -- Incorrect username or password. -- A policy that denies logins from user **root** is enabled on the SSH server. - -Solution --------- - -- If the username or password is incorrect - - Check the username and password. - -- If a policy that denies logins from user **root** is enabled on the SSH server, - - #. Edit the **/etc/ssh/sshd_config** file and check the following settings to ensure that the SSH logins from user **root** are allowed: - - .. code-block:: - - PermitRootLogin yes - - #. Restart SSH. - - - CentOS 6 - - **service sshd restart** - - - CentOS 7 - - **systemctl restart sshd** diff --git a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_module_is_unknown_when_i_remotely_log_in_to_a_linux_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_module_is_unknown_when_i_remotely_log_in_to_a_linux_ecs.rst deleted file mode 100644 index 7e2ef8e6..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_am_i_seeing_the_error_message_module_is_unknown_when_i_remotely_log_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,124 +0,0 @@ -:original_name: en-us_topic_0240708482.html - -.. _en-us_topic_0240708482: - -Why Am I Seeing the Error Message "Module is unknown" When I Remotely Log In to a Linux ECS? -============================================================================================ - -Symptom -------- - -When you attempt to remotely log in to a Linux ECS, the system displays the error message "Module is unknown". - -.. _en-us_topic_0240708482__fig17499319191716: - -.. figure:: /_static/images/en-us_image_0240710552.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Module is unknown - -.. note:: - - - To resolve this issue, restart the ECS and enter the rescue mode. - - Restarting the ECS may interrupt services. Exercise caution when performing this operation. - -Root Cause ----------- - -The file in the **/etc/pam.d/** directory was modified by mistake. - -Solution --------- - -#. Enter the single-user mode. - - The following uses CentOS 7 as an example: - - a. Restart the ECS and click **Remote Login**. - - b. Click **Ctrl+Alt+Del** in the upper part of the remote login panel to restart the ECS. - - c. Press the up arrow key to prevent automatic system startup. When the kernels are displayed, press **e** to enter the editing mode. - - .. _en-us_topic_0240708482__fig1087511256811: - - .. figure:: /_static/images/en-us_image_0240711431.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Entering the kernel editing mode - - .. note:: - - The grub file is encrypted by Euler images by default. Before entering the edit mode, you need to contact customer service to obtain username and password. - - d. Locate the row containing **linux16** and delete the parameters you do not require. - - e. Change **ro** to **rw** for mounting the root partition with read-write permissions. - - f. Add **rd.break** and press **Ctrl+X**. - - .. _en-us_topic_0240708482__fig1654418212503: - - .. figure:: /_static/images/en-us_image_0260575520.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Before the modification - - .. _en-us_topic_0240708482__fig1954412105016: - - .. figure:: /_static/images/en-us_image_0260575521.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** After the modification - - g. Run the following command to go to the **/sysroot** directory: - - **# chroot /sysroot** - -#. Run the following command to view the system log for error files: - - **grep Module /var/log/messages** - - .. _en-us_topic_0240708482__fig31081356162719: - - .. figure:: /_static/images/en-us_image_0240710554.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** System log - -#. Comment out or modify the error line in the error files displayed in the system log. - - **vi /etc/pam.d/login** - - .. _en-us_topic_0240708482__fig11081756172711: - - .. figure:: /_static/images/en-us_image_0240710555.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Modifying the error information - -#. Restart the ECS and try to log in to it again. - - .. note:: - - - To view the modification records and check whether the modification is caused by misoperations, run the following command: - - **vi /root/.bash_history** - - Search for the keyword **vi** or **login**. - - - Do not modify the files in the **/etc/pam.d/** directory. Run the following command for details about pam: - - **man pam.d** diff --git a/ecs/umn/result/faqs/login_and_connection/why_are_characters_entered_through_vnc_still_incorrect_after_the_keyboard_language_is_switched.rst b/ecs/umn/result/faqs/login_and_connection/why_are_characters_entered_through_vnc_still_incorrect_after_the_keyboard_language_is_switched.rst deleted file mode 100644 index e8a2268f..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_are_characters_entered_through_vnc_still_incorrect_after_the_keyboard_language_is_switched.rst +++ /dev/null @@ -1,24 +0,0 @@ -:original_name: en-us_topic_0030932500.html - -.. _en-us_topic_0030932500: - -Why Are Characters Entered Through VNC Still Incorrect After the Keyboard Language Is Switched? -=============================================================================================== - -During ECS login using VNC, changing the remote login keyboard language ensures only that characters entered in the VNC window for an ECS are correctly mapped. It does not change the output language of the ECS OS. If characters are not entered correctly, you must log in to the ECS and configure its keyboard output language. - -- For Linux ECSs, perform the following: - -Run the following command to load the keyboard mapping file: - -**loadkeys keymapfile** - -The *keymapfile* parameter indicates the name of the file containing the mappings between the keys and displayed characters. - -For example, if the name of a German keyboard mapping file is **de**, run the **loadkeys de** command. - -- For Windows ECSs, switch the input method or open the soft keyboard to enter characters. To open the soft keyboard, perform the following: - -#. Click the **Option Menu** icon. -#. Select **Soft Keyboard**. -#. Select a keyboard layout. diff --git a/ecs/umn/result/faqs/login_and_connection/why_cannot_i_use_the_mac_keyboard_to_enter_lowercase_characters_when_i_log_in_to_an_ecs_using_vnc.rst b/ecs/umn/result/faqs/login_and_connection/why_cannot_i_use_the_mac_keyboard_to_enter_lowercase_characters_when_i_log_in_to_an_ecs_using_vnc.rst deleted file mode 100644 index fa675d65..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_cannot_i_use_the_mac_keyboard_to_enter_lowercase_characters_when_i_log_in_to_an_ecs_using_vnc.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0047624368.html - -.. _en-us_topic_0047624368: - -Why Cannot I Use the MAC Keyboard to Enter Lowercase Characters When I Log In to an ECS Using VNC? -================================================================================================== - -If you use the MAC keyboard to enter German characters on your computer running MAC OS, uppercase characters can be entered properly after **Caps Lock** is enabled. However, after **Caps Lock** is disabled, the entered characters are still uppercase. - -To resolve this issue, hold **Shift** and press the letter key on the keyboard. diff --git a/ecs/umn/result/faqs/login_and_connection/why_cant_i_obtain_the_password_for_logging_in_to_my_windows_ecs_authenticated_using_a_key_pair.rst b/ecs/umn/result/faqs/login_and_connection/why_cant_i_obtain_the_password_for_logging_in_to_my_windows_ecs_authenticated_using_a_key_pair.rst deleted file mode 100644 index ed9f70f1..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_cant_i_obtain_the_password_for_logging_in_to_my_windows_ecs_authenticated_using_a_key_pair.rst +++ /dev/null @@ -1,76 +0,0 @@ -:original_name: en-us_topic_0081525054.html - -.. _en-us_topic_0081525054: - -Why Can't I Obtain the Password for Logging In to My Windows ECS Authenticated Using a Key Pair? -================================================================================================ - -Symptom -------- - -A private key cannot be used to obtain the password for logging in to a Windows ECS that is authenticated using a key pair. - -Possible Causes ---------------- - -The password fails to inject using Cloudbase-Init due to: - -- A network fault, leading to the failure of the connection from the ECS to the Cloudbase-Init server. -- No configuration on the image for Cloudbase-Init to obtain the password. -- Other reasons. - -Solution --------- - -If logging in to an ECS with Cloudbase-Init enabled failed, perform the following operations to locate the fault: - -#. Ensure that Cloudbase-Init has been correctly configured on the image that was used to create the ECS. - - - If Cloudbase-Init has not been configured, your ECS will not allow customized configurations, and you can log in to it only by using the original image password. - - - The ECSs created using a public image have Cloudbase-Init installed by default. Therefore, you do not need to install and configure Cloudbase-Init anymore. - - - If you created your ECS by using an external image file, install and configure Cloudbase-Init. - - For details, see "Installing and Configuring Cloudbase-Init" in *Image Management Service User Guide*. - -2. Ensure that the key pair for logging in to the ECS is correct. - - The key used for obtaining the password must be the key used during the ECS creation. - -3. Ensure that DHCP is enabled in the VPC to which the ECS belongs. - - On the management console, check whether DHCP has been enabled in the target subnet. - -4. Ensure that the ECS has an EIP bound. - -5. Ensure that traffic to and from port 80 is allowed in security group rules. - -6. Check Cloudbase-Init logs to identify the cause. - - a. .. _en-us_topic_0081525054__li16969123912115: - - Stop the affected ECS and detach the system disk from it. - - b. Use a public image to create a temporary Windows ECS and attach the system disk detached in :ref:`6.a ` to the ECS. - - c. Log in to the temporary ECS, open the **Server Manager** page, choose **File and Storage Services** > **Volumes** > **Disks**, right-click the offline disk, and choose **Online** from the shortcut menu. - - .. _en-us_topic_0081525054__fig12301902519: - - .. figure:: /_static/images/en-us_image_0275724694.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Setting disk online - - d. Switch to the **cloudbase-init** file in **/Program Files/Cloudbase Solution/Cloudbase-Init/log** of this disk to view the log for fault locating. - - .. _en-us_topic_0081525054__fig9250818165110: - - .. figure:: /_static/images/en-us_image_0275726221.png - :alt: **Figure 2** cloudbase-init - - - **Figure 2** cloudbase-init diff --git a/ecs/umn/result/faqs/login_and_connection/why_cant_i_use_the_local_computer_to_connect_to_my_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_cant_i_use_the_local_computer_to_connect_to_my_windows_ecs.rst deleted file mode 100644 index f5c4c3c2..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_cant_i_use_the_local_computer_to_connect_to_my_windows_ecs.rst +++ /dev/null @@ -1,176 +0,0 @@ -:original_name: en-us_topic_0264235939.html - -.. _en-us_topic_0264235939: - -Why Can't I Use the Local Computer to Connect to My Windows ECS? -================================================================ - -Symptom -------- - -An error message is displayed indicating that your local computer cannot connect to the remote computer. - -.. _en-us_topic_0264235939__en-us_topic_0250947106_fig4931341421: - -.. figure:: /_static/images/en-us_image_0288997242.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Cannot connect to the remote computer - -Possible Causes ---------------- - -- Port 3389 of the security group on the ECS is disabled. For details, see :ref:`Checking Port Configuration on the ECS `. -- The firewall on the ECS is disabled. For details, see :ref:`Checking Whether the Firewall Is Correctly Configured `. -- The remote desktop connection is not correctly configured. For details, see :ref:`Checking Remote Desktop Connection Settings `. -- Remote Desktop Services are not started. For solution, see :ref:`Checking Remote Desktop Services `. -- Remote Desktop Session Host is not correctly configured. For details, see :ref:`Checking Remote Desktop Session Host Configuration `. - -.. _en-us_topic_0264235939__en-us_topic_0250947106_section143451864405: - -Checking Port Configuration on the ECS --------------------------------------- - -Check whether port 3389 (used by default) on the ECS is accessible. - -Ensure that port 3389 has been added in the inbound rule. - -On the page providing details about the ECS, click the **Security Groups** tab and view port 3389 in the inbound rule of the security group. - -.. _en-us_topic_0264235939__en-us_topic_0250947106_section1130118816394: - -Checking Whether the Firewall Is Correctly Configured ------------------------------------------------------ - -Check whether the firewall is enabled on the ECS. - -#. Log in to the ECS using VNC available on the management console. - -#. Click the Windows icon in the lower left corner of the desktop and choose **Control Panel** > **Windows Firewall**. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig7767914202818: - - .. figure:: /_static/images/en-us_image_0288997243.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Windows Firewall - -#. Click **Turn Windows Firewall on or off**. - - View and set the firewall status. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig919195822713: - - .. figure:: /_static/images/en-us_image_0288997244.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Checking firewall status - - To enable Windows firewall, perform the following steps: - -#. Click **Advanced settings**. - -#. Check **Inbound Rules** and ensure that the following rules are enabled: - - - Remote Desktop - User Mode (TCP-In), Public - - Remote Desktop - User Mode (TCP-In), Domain, Private - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig3823135463718: - - .. figure:: /_static/images/en-us_image_0288997245.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Inbound Rules - - If the port configured in the inbound rule of the firewall is different from that configured on the remote server, the remote login will fail. If this occurs, add the port configured on the remote server in the inbound rule of the firewall. - -.. note:: - - The default port is 3389. If you use another port, add that port in the inbound rule of the firewall. - -After you perform the preceding operations, try to remotely log in to the ECS again. - -.. _en-us_topic_0264235939__en-us_topic_0250947106_section1912111262434: - -Checking Remote Desktop Connection Settings -------------------------------------------- - -Modify the remote desktop connection settings on the Windows ECS: - -#. Log in to the ECS. - -#. Click **Start** in the lower left corner, right-click **Computer**, and choose **Properties** from the shortcut menu. - -#. In the left navigation pane, choose **Remote settings**. - -#. Click the **Remote** tab. In the **Remote Desktop** pane, select **Allow connections from computers running any version of Remote Desktop (less secure)**. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_en-us_topic_0018339851_fig62503556467: - - .. figure:: /_static/images/en-us_image_0288997246.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Remote settings - -#. Click **OK**. - -.. _en-us_topic_0264235939__en-us_topic_0250947106_section42842535476: - -Checking Remote Desktop Services --------------------------------- - -#. Open the Windows search box, enter **services**, and select **Services**. - -#. In the **Services** window, restart **Remote Desktop Services**. Ensure that **Remote Desktop Services** is in the **Running** status. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig1355354132417: - - .. figure:: /_static/images/en-us_image_0288997248.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Remote Desktop Services - -.. _en-us_topic_0264235939__en-us_topic_0250947106_section108021655155012: - -Checking Remote Desktop Session Host Configuration --------------------------------------------------- - -#. Open the **cmd** window and enter **gpedit.msc**. - -#. Click **OK** to start Local Group Policy Editor. - -#. Choose **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Remote Desktop Services**. - -#. Choose **Remote Desktop Session Host** > **Security** > **Require use of specific security layer for remote (RDP) connections**. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig179713287534: - - .. figure:: /_static/images/en-us_image_0288997249.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Require use of specific security layer for remote (RDP) connections - -#. Set **Require use of specific security layer for remote (RDP) connections** to **Enabled** and **Security layer** to **RDP**. - - .. _en-us_topic_0264235939__en-us_topic_0250947106_fig1437792312541: - - .. figure:: /_static/images/en-us_image_0288997250.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Setting security layer to RDP diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_a_blank_screen_appear_while_the_system_displays_a_message_indicating_successful_authentication_after_i_attempted_to_log_in_to_an_ecs_using_vnc.rst b/ecs/umn/result/faqs/login_and_connection/why_does_a_blank_screen_appear_while_the_system_displays_a_message_indicating_successful_authentication_after_i_attempted_to_log_in_to_an_ecs_using_vnc.rst deleted file mode 100644 index db9fc5c3..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_a_blank_screen_appear_while_the_system_displays_a_message_indicating_successful_authentication_after_i_attempted_to_log_in_to_an_ecs_using_vnc.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0032850906.html - -.. _en-us_topic_0032850906: - -Why Does a Blank Screen Appear While the System Displays a Message Indicating Successful Authentication After I Attempted to Log In to an ECS Using VNC? -======================================================================================================================================================== - -Another user has logged in to this ECS using VNC. - -Only one user can log in to an ECS using VNC at a time. If multiple users attempt to log in to an ECS at the same time, only the first user can log in to it. For other users, the system displays a message indicating that the user is authenticated, but the screen turns blank. If this occurs, wait until the other user logs out of the ECS. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_an_authentication_failure_occurs_after_i_attempt_to_remotely_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_an_authentication_failure_occurs_after_i_attempt_to_remotely_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 74a4122f..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_an_authentication_failure_occurs_after_i_attempt_to_remotely_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,49 +0,0 @@ -:original_name: en-us_topic_0018339851.html - -.. _en-us_topic_0018339851: - -Why Does an Authentication Failure Occurs After I Attempt to Remotely Log In to a Windows ECS? -============================================================================================== - -Symptom -------- - -When a local computer running Windows attempts to access a Windows ECS using RDP (for example, MSTSC), an identity authentication failure occurs and the desired function is not supported. - -- If the error message contains only the information that an identity authentication failure occurs and that the desired function is not supported, rectify the fault by following the instructions provided in :ref:`Solution `. - -- If the error message shows that the fault was caused by "CredSSP Encryption Oracle Remediation", as shown in :ref:`Figure 1 `, the fault may be caused by a security patch released by Microsoft in March 2018. This patch may affect RDP-based CredSSP connections. As a result, setting up RDP-based connections to ECSs failed. For details, see `Unable to RDP to Virtual Machine: CredSSP Encryption Oracle Remediation `__. Rectify the fault by following the instructions provided in `official Microsoft document `__. - - .. _en-us_topic_0018339851__fig18932134871212: - - .. figure:: /_static/images/en-us_image_0117334497.png - :alt: **Figure 1** Failed to set up a remote desktop connection - - - **Figure 1** Failed to set up a remote desktop connection - -.. _en-us_topic_0018339851__section9947102411203: - -Solution --------- - -Modify the remote desktop connection settings on the Windows ECS: - -#. Log in to the ECS. - -#. Click **Start** in the lower left corner, right-click **Computer**, and choose **Properties** from the shortcut menu. - -#. In the navigation pane on the left, choose **Remote settings**. - -#. Click the **Remote** tab. In the **Remote Desktop** pane, select **Allow connections from computers running any version of Remote Desktop (less secure)**. - - .. _en-us_topic_0018339851__fig62503556467: - - .. figure:: /_static/images/en-us_image_0253037157.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Remote settings - -#. Click **OK**. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_an_ecs_fail_to_be_remotely_connected_using_rdp_and_internal_error_code_4_is_displayed.rst b/ecs/umn/result/faqs/login_and_connection/why_does_an_ecs_fail_to_be_remotely_connected_using_rdp_and_internal_error_code_4_is_displayed.rst deleted file mode 100644 index 4bb79117..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_an_ecs_fail_to_be_remotely_connected_using_rdp_and_internal_error_code_4_is_displayed.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: en-us_topic_0018124779.html - -.. _en-us_topic_0018124779: - -Why Does an ECS Fail to Be Remotely Connected Using RDP and Internal Error Code 4 Is Displayed? -=============================================================================================== - -Symptom -------- - -An internal error is displayed when you log in to a Windows ECS and you fail to connect to the ECS remotely. Generally, this problem occurs because the Remote Desktop Services is busy. - -Possible Causes ---------------- - -The Remote Desktop Services is busy. - -The remote desktop is disconnected after login but is not logged out. To prevent this problem, log out of the ECS if you do not need to remotely connect to it. - -Solution --------- - -#. Use VNC provided by the management console to remotely log in to the ECS. - -#. Open the Windows search box, enter **services**, and select **Services**. - -#. In the **Services** window, restart **Remote Desktop Services**. Ensure that **Remote Desktop Services** is in the **Running** status. - - .. _en-us_topic_0018124779__en-us_topic_0250947106_fig1355354132417: - - .. figure:: /_static/images/en-us_image_0000001100835050.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Remote Desktop Services - -#. Remotely connect to the ECS again. - - If the connection still fails, run the cmd command on the local server as the administrator, run the **netsh winsock reset** command to restore the default network connection configurations, and then retry the remote connection. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_my_remote_desktop_session_end_because_another_user_logs_in_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_my_remote_desktop_session_end_because_another_user_logs_in_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index e5d43199..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_my_remote_desktop_session_end_because_another_user_logs_in_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,73 +0,0 @@ -:original_name: en-us_topic_0264235950.html - -.. _en-us_topic_0264235950: - -Why Does My Remote Desktop Session End Because Another User Logs In When I Log In to a Windows ECS? -=================================================================================================== - -Symptom -------- - -An error message is displayed indicating that your remote desktop session has ended because another user has connected to the remote computer. - -.. _en-us_topic_0264235950__en-us_topic_0180500563_fig1257094715194: - -.. figure:: /_static/images/en-us_image_0288997370.png - :alt: **Figure 1** Ended remote desktop session - - - **Figure 1** Ended remote desktop session - -Windows Server 2008 -------------------- - -#. Choose **Start** > **Administrative Tools** > **Remote Desktop Services** > **Remote Desktop Session Host Configuration**. - - .. _en-us_topic_0264235950__en-us_topic_0180500563_fig1226474210443: - - .. figure:: /_static/images/en-us_image_0288997371.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Remote Desktop Session Host Configuration - -#. Double-click **Restrict each user to a single session** and deselect **Restrict each user to a single session**, and click **OK**. - - .. _en-us_topic_0264235950__en-us_topic_0180500563_fig1676827173919: - - .. figure:: /_static/images/en-us_image_0288997372.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Modifying the configuration - -Windows Server 2012 -------------------- - -#. Choose **Start** > **Run**. In the **Run** dialog box, enter **gpedit.msc** and click **OK** to start Local Group Policy Editor. - -#. Choose **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Remote Desktop Services** > **Remote Desktop Session Host** > **Connections**. - - .. _en-us_topic_0264235950__en-us_topic_0180500563_fig370943472720: - - .. figure:: /_static/images/en-us_image_0288997374.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Connections - -#. Double-click **Restrict Remote Desktop Services users to a single Remote Desktop Services session**, change the value to **Disabled**, and click **OK**. - - .. _en-us_topic_0264235950__en-us_topic_0180500563_fig76712011540: - - .. figure:: /_static/images/en-us_image_0288997375.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Modifying the configuration - -#. Run **gpupdate/force** to update the group policy. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_a_message_indicating_that_the_password_for_logging_in_to_a_windows_ecs_cannot_be_viewed.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_a_message_indicating_that_the_password_for_logging_in_to_a_windows_ecs_cannot_be_viewed.rst deleted file mode 100644 index 3b5f9792..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_a_message_indicating_that_the_password_for_logging_in_to_a_windows_ecs_cannot_be_viewed.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: en-us_topic_0031736846.html - -.. _en-us_topic_0031736846: - -Why Does the System Display a Message Indicating that the Password for Logging In to a Windows ECS Cannot Be Viewed? -==================================================================================================================== - -Symptom -------- - -Password authentication is required to log in to a Windows ECS. Therefore, you require a key file to obtain the initial password for logging in to the ECS. However, after you click **Get Password** (see :ref:`Obtaining the Password for Logging In to a Windows ECS `), the system displays a message indicating that the password cannot be viewed. ECS login was therefore unsuccessful. - -Possible Causes ---------------- - -Possible causes vary depending on the image used to create the Windows ECS. - -- Cause 1: The image used to create the Windows ECS is a private image, on which Cloudbase-Init has not been installed. -- Cause 2: Cloudbase-Init has been installed on the image, but the key pair has not been obtained when the Windows ECS was created. - -Solution --------- - -- If the issue is a result of cause 1, proceed as follows: - - If a private image is created without Cloudbase-Init installed, the ECS configuration cannot be customized. As a result, you can log in to the ECS only using the original image password. - - The original image password is the OS password configured when the private image was created. - -- If the issue is a result of cause 2, proceed as follows: - - #. Locate the row containing the target ECS, click **More** in the **Operation** column, and select **Restart**. - #. Click **More** in the **Operation** column and select **Get Password** to check whether the password can be obtained. - - - If you can obtain the password, no further action is required. - - If you cannot obtain the password, contact customer service. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x1104_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x1104_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index ad1ccec6..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x1104_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,162 +0,0 @@ -:original_name: en-us_topic_0264235942.html - -.. _en-us_topic_0264235942: - -Why Does the System Display Error Code 0x1104 When I Log In to a Windows ECS? -============================================================================= - -Symptom -------- - -The system displays an error message indicating that a protocol error (code: 0x1104) is detected when you use MSTSC to access an ECS running Windows Server 2008. - -.. _en-us_topic_0264235942__en-us_topic_0138293293_fig7560131184912: - -.. figure:: /_static/images/en-us_image_0288997598.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Protocol error (code: 0x1104) - -Possible Causes ---------------- - -- Port 3389 of the security group on the ECS is disabled. -- The firewall on the ECS is disabled. -- Port 3389 on the ECS is used by other processes. -- The Remote Desktop Session Host is incorrectly configured. - -Solution --------- - -#. Check security group settings. - - Check whether port 3389 is allowed in inbound direction. If it is allowed, go to :ref:`2 `. - -#. .. _en-us_topic_0264235942__en-us_topic_0138293293_li18622172719193: - - Check whether the firewall is disabled: - - a. Log in to the Windows ECS. - - b. Click the Windows icon in the lower left corner of the desktop and choose **Control Panel** > **Windows Firewall**. - - |image1| - - c. Click **Turn Windows Firewall on or off**. - - View and set the firewall status. - - |image2| - - If the firewall is enabled, go to :ref:`3 `. - -#. .. _en-us_topic_0264235942__en-us_topic_0138293293_li15622182714191: - - Log in to the ECS using VNC and check the port. - - a. Open the **cmd** window and run the following command: - - **netstat -ano \|findstr: 3389** - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig1562219275192: - - .. figure:: /_static/images/en-us_image_0288997604.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Checking port 3389 - - As shown in :ref:`Figure 2 `, port 3389 is used by the process with ID of 4. - - b. Open Task Manager and find the process with ID of 4 is the System process. - - c. Generally, the IIS and SQL Server run as the System process. Run the following HTTP command for further check. - - **netsh http show servicestate** - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig16426409265: - - .. figure:: /_static/images/en-us_image_0288997606.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Checking System process - - d. If port 3389 is used by HTTP protocols, it indicates that the port is used by IIS. - - e. Enter **http://127.0.0.1:3389** in the address box of the browser and press **Enter**. Check whether the website can be visited normally. - - f. Change the port used by IIS and restart IIS. - -#. If no error occurs during the preceding steps, go to step :ref:`5 ` to check whether error 0x1104 is caused by the configuration of Remote Desktop Session Host. - -#. .. _en-us_topic_0264235942__en-us_topic_0138293293_li19441439143520: - - Check the remote desktop session host configuration. - - a. Log in to the ECS using VNC. - - b. Open the **cmd** window and enter **gpedit.msc**. - - c. Click **OK** to start Local Group Policy Editor. - - d. Choose **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Remote Desktop Services**. - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig1072317112254: - - .. figure:: /_static/images/en-us_image_0288997608.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Remote Desktop Services - - e. **Remote Desktop Session Host** > **Security**. - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig64299268259: - - .. figure:: /_static/images/en-us_image_0288997610.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Remote (RDP) Connection requires the use of the specified security layer - - f. Set **Require use of specific security layer for remote (RDP) connections** to **Enabled** and **Security layer** to **RDP**. - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig6816237202719: - - .. figure:: /_static/images/en-us_image_0288997612.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Setting security layer - - g. Click **OK**. - - h. After the configuration is complete, open the **cmd** window. - - i. Run the following command to update the group policy: - - **gpupdate** - - .. _en-us_topic_0264235942__en-us_topic_0138293293_fig1129272819299: - - .. figure:: /_static/images/en-us_image_0288997614.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Updating the group policy - -.. |image1| image:: /_static/images/en-us_image_0288997600.png - :class: imgResize - -.. |image2| image:: /_static/images/en-us_image_0288997602.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x112f_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x112f_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 77b36bbe..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_0x112f_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,41 +0,0 @@ -:original_name: en-us_topic_0120795668.html - -.. _en-us_topic_0120795668: - -Why Does the System Display Error Code 0x112f When I Log In to a Windows ECS? -============================================================================= - -Symptom -------- - -When you log in to a Windows ECS, the system displays error code 0x112f. - -.. _en-us_topic_0120795668__fig1256612592310: - -.. figure:: /_static/images/en-us_image_0120795776.jpg - :alt: **Figure 1** Error message (code: 0x112f) - - - **Figure 1** Error message (code: 0x112f) - -Possible Causes ---------------- - -The ECS memory is insufficient. - -Solution --------- - -- Method 1 (recommended) - - Modify the ECS specifications to increase the vCPUs and memory size. For instructions about how to modify ECS specifications, see :ref:`General Operations for Modifying Specifications `. - -- Method 2 - - Enable virtual memory on the ECS to obtain its idle memory. - - For instructions about how to enable virtual memory, see :ref:`How Can I Enable Virtual Memory on a Windows ECS? ` - - .. note:: - - This method will deteriorate the disk I/O performance. Therefore, use this method only when necessary. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_122.112.._when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_122.112.._when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 1c4abaa9..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_error_code_122.112.._when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: en-us_topic_0264235943.html - -.. _en-us_topic_0264235943: - -Why Does the System Display Error Code 122.112.\ *.* When I Log In to a Windows ECS? -==================================================================================== - -Symptom -------- - -The system displays error 122.112... when you use RDC to locally access an ECS running Windows Server 2012. The ECS is frequently disconnected and the Windows login process is unexpectedly interrupted. - -Possible Causes ---------------- - -#. System resources are insufficient or unavailable. -#. The services cannot be started. - -Solution --------- - -#. Check system logs. - - a. Log in to the ECS using VNC. - - b. Click |image1| to start the service manager and choose **Administrative Tools** > **Event Viewer** > **Windows Logs** > **System** > **Filter Current Logs**. - - .. _en-us_topic_0264235943__en-us_topic_0138293296_fig1129272819299: - - .. figure:: /_static/images/en-us_image_0000001122000869.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Event viewer - - c. In the **Event Level** pane, select event levels. - - .. _en-us_topic_0264235943__en-us_topic_0138293296_fig13103521154816: - - .. figure:: /_static/images/en-us_image_0000001121886141.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Filtering logs - - d. Search for login logs. - -#. Check the usage of host resources. - - a. Choose **Start** > **Task Manager** > **Performance**. - b. Check usage of CPU and memory. - -#. Check whether the purchased Windows ECS is with 1 vCPU and 1 GB of memory. - - If it is, change the flavor or stop unnecessary processes. - -.. |image1| image:: /_static/images/en-us_image_0000001122204571.png - diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_invalid_certificate_or_associated_chain_when_i_log_in_to_a_windows_ecs_from_a_mac.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_invalid_certificate_or_associated_chain_when_i_log_in_to_a_windows_ecs_from_a_mac.rst deleted file mode 100644 index 731ea8f1..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_invalid_certificate_or_associated_chain_when_i_log_in_to_a_windows_ecs_from_a_mac.rst +++ /dev/null @@ -1,108 +0,0 @@ -:original_name: en-us_topic_0264235944.html - -.. _en-us_topic_0264235944: - -Why Does the System Display Invalid Certificate or Associated Chain When I Log In to a Windows ECS from a Mac? -============================================================================================================== - -Symptom -------- - -When you use Microsoft Remote Desktop for Mac to remotely access a Windows ECS, the system displays invalid certificate or associated chain. - -.. _en-us_topic_0264235944__en-us_topic_0138877154_fig13103521154816: - -.. figure:: /_static/images/en-us_image_0000001122204673.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Microsoft Remote Desktop for Mac - -Due to the particularity of the Mac system, you need to perform internal configurations on Mac and the Windows ECS to ensure successful remote connection. When you log in to the Windows ECS using Microsoft Remote Desktop for Mac, the system displays an error message indicating that the certificate or associated chain is invalid. - -.. _en-us_topic_0264235944__en-us_topic_0138877154_fig135204375528: - -.. figure:: /_static/images/en-us_image_0000001122141457.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Invalid certificate or associated chain - -Possible Causes ---------------- - -The group policy setting is incorrect on the ECS. - -Procedure ---------- - -#. On the menu bar in the upper left corner, choose **RDC** > **Preferences** to open the preference setting page of the Microsoft Remote Desktop. - - .. _en-us_topic_0264235944__en-us_topic_0138877154_fig1018664945218: - - .. figure:: /_static/images/en-us_image_0000001122204675.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Preferences setting - -#. Select **Security** and modify the parameter settings according the following figure. - - .. _en-us_topic_0264235944__en-us_topic_0138877154_fig121513225316: - - .. figure:: /_static/images/en-us_image_0000001122000977.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Security setting - -#. Remotely connect to the Windows ECS again. If the error message **Invalid certificate or associated chain** is still displayed, go to :ref:`4 `. - -#. .. _en-us_topic_0264235944__en-us_topic_0138877154_li19176131183810: - - Log in to the Windows ECS using VNC. - -#. Press **Win+R** to start the **Open** text box. - -#. Enter **gpedit.msc** to access the Local Group Policy Editor. - -#. In the left navigation pane, choose **Computer Configuration** > **Administrative Templates** > **Windows Components** > **Remote Desktop Services** > **Remote Desktop Session Host** > **Security**. - - .. _en-us_topic_0264235944__en-us_topic_0138877154_fig113613152539: - - .. figure:: /_static/images/en-us_image_0000001122000979.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Remote Desktop Session Host - -#. Modify the following parameters as prompted: - - - Enable **Require use of specific security layer for remote (RDP) connections**. - - .. _en-us_topic_0264235944__en-us_topic_0138877154_fig1461293695320: - - .. figure:: /_static/images/en-us_image_0000001121886253.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Require use of specific security layer for remote (RDP) connections - - - Disable **Require user authentication for remote connections by using Network Level Authentication**. - - .. _en-us_topic_0264235944__en-us_topic_0138877154_fig135815477530: - - .. figure:: /_static/images/en-us_image_0000001122204677.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Remote connection authentication - -#. Close the group policy editor and restart the ECS. diff --git a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_no_remote_desktop_license_servers_available_to_provide_a_license_when_i_log_in_to_a_windows_ecs.rst b/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_no_remote_desktop_license_servers_available_to_provide_a_license_when_i_log_in_to_a_windows_ecs.rst deleted file mode 100644 index 3f2e4bc5..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_does_the_system_display_no_remote_desktop_license_servers_available_to_provide_a_license_when_i_log_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,96 +0,0 @@ -:original_name: en-us_topic_0264235941.html - -.. _en-us_topic_0264235941: - -Why Does the System Display No Remote Desktop License Servers Available to Provide a License When I Log In to a Windows ECS? -============================================================================================================================ - -Symptom -------- - -An error message is displayed indicating that there are no Remote Desktop License Servers available to provide a license and asks you to contact the administrator. - -.. _en-us_topic_0264235941__en-us_topic_0128065575_fig1693533120329: - -.. figure:: /_static/images/en-us_image_0288997286.png - :alt: **Figure 1** No Remote Desktop License Servers available to provide a license - - - **Figure 1** No Remote Desktop License Servers available to provide a license - -Possible Causes ---------------- - -You have installed the Remote Desktop Session Host. - -The grace period for Remote Desktop Services is 120 days. If you do not pay for it when the period expires, the service will stop. Windows allows a maximum of two users (including the local user) in remote desktop connections. To allow the access of more users, install the Remote Desktop Session Host and configure the desired number of authorized users. However, installing the Remote Desktop Session Host will automatically revoke the original two free connections. This leads to the preceding fault if desired number of authorized users has not been configured. - -Precautions ------------ - -- The operations described in this section apply to the ECSs running a Windows Server 2008 or Windows Server 2012. -- The ECS must be restarted during the operation, which may interrupt services. Back up data before restarting the ECS. - -Windows Server 2008 -------------------- - -#. Log in to the Windows ECS using VNC available on the management console. - -#. Open **Server Manager**, right-click **Remote Desktop Services** under **Roles**, and choose **Remove Roles** from the shortcut menu. - - .. _en-us_topic_0264235941__en-us_topic_0128065575_fig16121213182410: - - .. figure:: /_static/images/en-us_image_0288997287.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Deleting roles - -#. In the displayed dialog box, deselect **Remote Desktop Session Host** and keep clicking **Next** till you finish the operation. - - .. _en-us_topic_0264235941__en-us_topic_0128065575_fig199398290243: - - .. figure:: /_static/images/en-us_image_0288997288.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Deselecting Remote Desktop Session Host - -#. Click **Delete**. - -#. Restart the ECS. - -Windows Server 2012 -------------------- - -#. Log in to the Windows ECS using VNC available on the management console. - -#. Open **Server Manager**, choose **Manage** > **Remove Roles and Features**, and click **Next**. - - .. _en-us_topic_0264235941__en-us_topic_0128065575_en-us_topic_0018339851_fig18932134871212: - - .. figure:: /_static/images/en-us_image_0288997289.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Deleting roles and features - -#. Select the destination server and click **Next**. - -#. Deselect **Remote Desktop Services**. - - .. _en-us_topic_0264235941__en-us_topic_0128065575_fig1386565415529: - - .. figure:: /_static/images/en-us_image_0288997290.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Deselecting Remote Desktop Services - -#. Click **Delete**. - -#. Restart the ECS. diff --git a/ecs/umn/result/faqs/login_and_connection/why_is_my_remote_session_interrupted_by_a_protocol_error.rst b/ecs/umn/result/faqs/login_and_connection/why_is_my_remote_session_interrupted_by_a_protocol_error.rst deleted file mode 100644 index 5cd4c50e..00000000 --- a/ecs/umn/result/faqs/login_and_connection/why_is_my_remote_session_interrupted_by_a_protocol_error.rst +++ /dev/null @@ -1,75 +0,0 @@ -:original_name: en-us_topic_0264235945.html - -.. _en-us_topic_0264235945: - -Why Is My Remote Session Interrupted by a Protocol Error? -========================================================= - -Symptom -------- - -An error message is displayed indicating that the remote session will be disconnected because of a protocol error. - -.. _en-us_topic_0264235945__en-us_topic_0173587265_en-us_topic_0120795668_fig1256612592310: - -.. figure:: /_static/images/en-us_image_0288997423.png - :alt: **Figure 1** Protocol error - - - **Figure 1** Protocol error - -Possible Causes ---------------- - -The registry subkey Certificate is damaged. - -Solution --------- - -#. In the **Run** dialog box, enter **regedit** and click **OK** to open the registry editor. - - .. _en-us_topic_0264235945__en-us_topic_0173587265_fig429554874215: - - .. figure:: /_static/images/en-us_image_0288997424.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Opening the registry editor - -#. Choose **HKEY_LOCAL_MACHINE** > **SYSTEM** > **ControlSet001** > **Control** > **Terminal Server** > **RCM**. - -#. Delete **Certificate**. - - .. _en-us_topic_0264235945__en-us_topic_0173587265_fig134336512282: - - .. figure:: /_static/images/en-us_image_0288997425.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Deleting Certificate - -#. Restart the ECS. - -#. Choose **Start** > **Administrative Tools** > **Remote Desktop Services** > **Remote Desktop Session Host Configuration**. - - .. _en-us_topic_0264235945__en-us_topic_0173587265_fig15551901388: - - .. figure:: /_static/images/en-us_image_0288997426.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Opening Remote Desktop Session Host Configuration - -#. Right-click **RDP-Tcp** and choose **Properties**. In the displayed dialog box, click **General** and set **Security layer** to **RDP Security Layer**. - - .. _en-us_topic_0264235945__en-us_topic_0173587265_fig538416200307: - - .. figure:: /_static/images/en-us_image_0288997427.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** RDP-Tcp properties diff --git a/ecs/umn/result/faqs/network_configurations/can_an_ecs_without_an_eip_access_the_internet.rst b/ecs/umn/result/faqs/network_configurations/can_an_ecs_without_an_eip_access_the_internet.rst deleted file mode 100644 index 1804e74f..00000000 --- a/ecs/umn/result/faqs/network_configurations/can_an_ecs_without_an_eip_access_the_internet.rst +++ /dev/null @@ -1,20 +0,0 @@ -:original_name: en-us_topic_0030013188.html - -.. _en-us_topic_0030013188: - -Can an ECS Without an EIP Access the Internet? -============================================== - -Yes. - -- Method 1: Configure a SNAT server. - - You can configure the SNAT server so that the ECS without an EIP bound can access the Internet. - - For details, see `"Configuring an SNAT Server" `__ in *Virtual Private Cloud User Guide*. - -- Method 2: Create a NAT gateway. - - If a large number of concurrent connections are required, it is a good practice to use the NAT Gateway service provided by the cloud platform. - - The NAT Gateway service offers the NAT function for ECSs in a VPC, allowing these ECSs to access the Internet using an EIP. For more information about NAT Gateway, see *NAT Gateway User Guide*. diff --git a/ecs/umn/result/faqs/network_configurations/can_i_bind_multiple_eips_to_an_ecs.rst b/ecs/umn/result/faqs/network_configurations/can_i_bind_multiple_eips_to_an_ecs.rst deleted file mode 100644 index 938e22b9..00000000 --- a/ecs/umn/result/faqs/network_configurations/can_i_bind_multiple_eips_to_an_ecs.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: en-us_topic_0018073216.html - -.. _en-us_topic_0018073216: - -Can I Bind Multiple EIPs to an ECS? -=================================== - -Scenarios ---------- - -You can bind multiple EIPs to an ECS. However, this configuration is not recommended. - -To bind multiple EIPs to an ECS, you must manually configure routes. - -Configuration Example ---------------------- - -:ref:`Table 1 ` lists ECS configurations. - -.. _en-us_topic_0018073216__table10449199163243: - -.. table:: **Table 1** ECS configurations - - ============= ================ - Parameter Configuration - ============= ================ - Name ecs_test - Image CentOS 6.5 64bit - EIP 2 - Primary NIC eth0 - Secondary NIC eth1 - ============= ================ - -**Example 1:** - -If you are required to access public network 11.11.11.0/24 through standby NIC **eth1**, perform the following operations to configure a route: - -#. Log in to the ECS. - -#. Run the following command to configure a route: - - **ip route add 11.11.11.0/24 dev eth1 via 192.168.2.1** - - In the preceding command, **192.168.2.1** is the gateway IP address of standby NIC **eth1**. - -**Example 2:** - -Based on example 1, if you are required to enable routing for default public network traffic through standby NIC **eth1**, perform the following operations to configure a route: - -#. Log in to the ECS. - -#. Run the following command to delete the default route: - - **ip route delete default** - -#. Run the following command to configure a new default route: - - **ip route add 0.0.0.0/0 dev eth1 via 192.168.2.1** - - In the preceding command, **192.168.2.1** is the gateway IP address of standby NIC **eth1**. diff --git a/ecs/umn/result/faqs/network_configurations/can_the_ecss_of_different_accounts_communicate_over_an_intranet.rst b/ecs/umn/result/faqs/network_configurations/can_the_ecss_of_different_accounts_communicate_over_an_intranet.rst deleted file mode 100644 index d906de69..00000000 --- a/ecs/umn/result/faqs/network_configurations/can_the_ecss_of_different_accounts_communicate_over_an_intranet.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0018078501.html - -.. _en-us_topic_0018078501: - -Can the ECSs of Different Accounts Communicate over an Intranet? -================================================================ - -No. The ECSs of different accounts cannot communicate with each other over an intranet. diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_check_whether_the_network_communication_is_normal_between_two_ecss_equipped_with_an_infiniband_nic_driver.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_check_whether_the_network_communication_is_normal_between_two_ecss_equipped_with_an_infiniband_nic_driver.rst deleted file mode 100644 index 6258f8c1..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_check_whether_the_network_communication_is_normal_between_two_ecss_equipped_with_an_infiniband_nic_driver.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0058747426.html - -.. _en-us_topic_0058747426: - -How Can I Check Whether the Network Communication Is Normal Between Two ECSs Equipped with an InfiniBand NIC Driver? -==================================================================================================================== - -For high-performance H2 ECSs equipped with an InfiniBand NIC driver (InfiniBand ECSs for short), perform the following operations to check whether the driver installation is successful and whether the network communication between the ECSs is normal. - -.. note:: - - During the check, if your ECS has no command tool installed, such as ibstat, obtain the tool from the installation package for the InfiniBand NIC driver and install the tool. - -#. Check whether the NICs of the InfiniBand ECSs are functional. - - a. Log in to an ECS. - - b. Run the following command to check whether the NIC is functional: - - **ibstat** - - - If it is functional, go to :ref:`2 `. - - If it is not functional, contact customer service for technical support. - -#. .. _en-us_topic_0058747426__li2420713023281: - - Check whether the network communication between two InfiniBand ECSs is normal. - - a. Log in to one InfiniBand ECS and run the following command: - - **ib_write_bw -x 0 --pkey_index 0** - - b. Log in to the other InfiniBand ECS and run the following command: - - **ib_write_bw -x 0 --pkey_index 0**\ *ip_addr* - - In the preceding command, *ip_addr* is the NIC IP address of the first InfiniBand ECS. - - c. Check whether the terminal display is correct. - - .. _en-us_topic_0058747426__fig13564645028: - - .. figure:: /_static/images/en-us_image_0058747512.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Normal network communication - - - If the terminal display is shown in :ref:`Figure 1 `, the network communication between the two InfiniBand ECSs is normal. - - If the InfiniBand network is inaccessible, contact customer service for technical support. diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_configure_port_redirection.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_configure_port_redirection.rst deleted file mode 100644 index b800f915..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_configure_port_redirection.rst +++ /dev/null @@ -1,101 +0,0 @@ -:original_name: en-us_topic_0101604507.html - -.. _en-us_topic_0101604507: - -How Can I Configure Port Redirection? -===================================== - -Requirement ------------ - -It is expected that the EIP and port on ECS 1 accessed from the Internet can be automatically redirected to the EIP and port on ECS 2. - -Windows -------- - -For example, to redirect port 8080 on ECS 1 bound with EIP 192.168.10.43 to port 18080 on ECS 2 bound with EIP 192.168.10.222, perform the following operations on ECS 1. - -.. note:: - - Ensure that the desired ports have been enabled on the ECS security group and firewall. - -#. Open the **cmd** window on the ECS and run the following command: The ECS running Windows Server 2012 is used as an example. - - **netsh interface portproxy add v4tov4 listenaddress=192.168.10.43 listenport=8080 connectaddress=192.168.10.222 connectport=18080** - - To cancel port redirection, run the following command: - - **netsh interface portproxy delete v4tov4 listenaddress=192.168.10.43 listenport=8080** - -#. Run the following command to view all port redirections configured on the ECS: - - **netsh interface portproxy show v4tov4** - - .. _en-us_topic_0101604507__en-us_topic_0206596992_en-us_topic_0206596992_fig147071411162911: - - .. figure:: /_static/images/en-us_image_0267133745.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Port redirections on Windows - -Linux ------ - -For example, to redirect port 1080 on ECS 1 to port 22 on ECS 2 with the following configurations: - -Private IP address and EIP of ECS 1: 192.168.72.10 and 123.xxx.xxx.456 - -Private IP address of ECS 2: 192.168.72.20 - -.. note:: - - - Ensure that the desired ports have been enabled on the ECS security group and firewall. - - - Ensure that the source/destination check function is disabled. - - On the ECS details page, click **NICs** and disable **Source/Destination Check**. - - By default, the source/destination check is enabled, and the system checks whether source IP addresses contained in the packets sent by ECSs are correct. If the IP addresses are incorrect, the system does not allow the ECSs to send the packets. This mechanism prevents packet spoofing, thereby improving system security. However, this mechanism prevents the packet sender from receiving returned packets. Therefore, disable the source/destination check. - -#. Log in to Linux ECS 1. - - a. Run the following command to modify the configuration file: - - **vi /etc/sysctl.conf** - - b. Add **net.ipv4.ip_forward = 1** to the file. - - c. Run the following command to complete the modification: - - **sysctl -p /etc/sysctl.conf** - -#. Run the following commands to add rules to the **nat** table in **iptables** so that the access to port 1080 on ECS 1 can be redirected to port 22 on ECS 2: - - **iptables -t nat -A PREROUTING -d 192.168.72.10 -p tcp --dport 1080 -j DNAT --to-destination 192.168.72.20:22** - - **iptables -t nat -A POSTROUTING -d 192.168.72.20 -p tcp --dport 22 -j SNAT --to 192.168.72.10** - -#. Run the following command to log in to port 1080 on ECS 1 for check: - - **ssh -p 1080 123.xxx.xxx.456** - - .. _en-us_topic_0101604507__fig11283122115016: - - .. figure:: /_static/images/en-us_image_0121682390.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Port redirections on Linux - - Enter the password to log in to ECS 2 with hostname **ecs-inner**. - - .. _en-us_topic_0101604507__fig19311141225012: - - .. figure:: /_static/images/en-us_image_0121682392.png - :alt: **Figure 3** Logging in to ECS 2 - - - **Figure 3** Logging in to ECS 2 diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_handle_the_issue_that_a_windows_7_ecs_equipped_with_an_intel_82599_nic_reports_an_error_in_sr-iov_scenarios.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_handle_the_issue_that_a_windows_7_ecs_equipped_with_an_intel_82599_nic_reports_an_error_in_sr-iov_scenarios.rst deleted file mode 100644 index 76d6f58a..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_handle_the_issue_that_a_windows_7_ecs_equipped_with_an_intel_82599_nic_reports_an_error_in_sr-iov_scenarios.rst +++ /dev/null @@ -1,35 +0,0 @@ -:original_name: en-us_topic_0053287548.html - -.. _en-us_topic_0053287548: - -How Can I Handle the Issue that a Windows 7 ECS Equipped with an Intel 82599 NIC Reports an Error in SR-IOV Scenarios? -====================================================================================================================== - -Symptom -------- - -When the 20.4.1 driver package downloaded at Intel website `https://downloadcenter.intel.com/search?keyword=Intel++Ethernet+Connections+CD `__ was installed in a Windows 7 64bit ECS with SR-IOV passthrough enabled, the system displayed the message "No Intel adapter found". - -Cause Analysis --------------- - -The OS identifies an Intel 82599 passthrough NIC without a driver installed as an Ethernet controller. When the 20.4.1 driver package was installed, the OS did not identify the Intel NIC, leading to the error. - -Solution --------- - -Run **Autorun.exe** in the folder where the 20.4.1 driver package is stored. Install a driver on the NIC before installing the driver package so that the NIC can be identified as an Intel 82599 virtual function (VF) device by the OS. Use either of the following methods to install the driver: - -- Method 1: Update the version. - - #. Download the 18.6 driver package at the Intel website. - #. Run **Autorun.exe**. - #. Run **Autorun.exe** in the folder where the 20.4.1 driver package is stored to update the driver. - -- Method 2: Use the device manager. - - #. Start the Windows resource manager. Right-click **Computer** and choose **Manage** from the shortcut menu. In the **Device Manager** window, locate the NIC. When the NIC has no driver installed, the NIC locates in **Other devices** and is named **Ethernet Controller**. - #. Right-click **Ethernet Controller** and choose **Update Driver Software**. - #. Click **Browse**, select the path where the driver package is stored, and click **Next**. - #. Locate the NIC in **Network Adapter** of **Device Manager**. - #. Run **Autorun.exe** to install the 20.4.1 driver package. diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_manually_configure_an_ip_address_for_an_infiniband_nic.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_manually_configure_an_ip_address_for_an_infiniband_nic.rst deleted file mode 100644 index 929f592a..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_manually_configure_an_ip_address_for_an_infiniband_nic.rst +++ /dev/null @@ -1,59 +0,0 @@ -:original_name: en-us_topic_0083225171.html - -.. _en-us_topic_0083225171: - -How Can I Manually Configure an IP Address for an InfiniBand NIC? -================================================================= - -IP over InfiniBand (IPoIB) allows IP data transmission over InfiniBand. For SUSE high-performance H2 and HL1 ECSs, if IPoIB is required, you must manually configure an IP address for the InfiniBand NIC after installing the InfiniBand NIC driver. - -Prerequisites -------------- - -The InfiniBand NIC driver has been installed on the high-performance H2 or HL1 ECSs. - -.. _en-us_topic_0083225171__section42060912112551: - -Background ----------- - -To prevent IP address conflict of the InfiniBand NICs configured for the ECSs of a tenant, determine the IP address to be configured for an InfiniBand NIC according to the IP addresses available in the VPC. The method is as follows: - -For example, if the first two eight-bits of the IP address (specified by **IPADDR**) to be configured for the InfiniBand NIC are consistently **169.254**, the latter two eight-bits must be the same as those of the **eth0** IP address, and the subnet mask must be the same as that of the **eth0** NIC. - -An example is provided as follows: - -If the IP address of the **eth0** NIC is 192.168.0.100/24, the IP address to be configured for the InfiniBand NIC is 169.254.0.100/24. - -Procedure ---------- - -#. Log in to the ECS. - -#. Run the following command to switch to user **root**: - - **sudo su -** - -#. Run the following command to edit the **/etc/sysconfig/network/ifcfg-ib0** file: - - **vi /etc/sysconfig/network/ifcfg-ib0** - -#. Enter the following information: - - **DEVICE=ib0** - - **BOOTPROTO=static** - - **IPADDR=**\ *IP address to be configured for the InfiniBand NIC* - - **NETMASK=**\ *Subnet mask* - - **STARTMODE=auto** - - .. note:: - - For instructions about how to obtain the IP address and subnet mask for an InfiniBand NIC, see :ref:`Background `. - -#. Run the following command to restart the network for the configuration to take effect: - - **service network restart** diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_obtain_the_mac_address_of_my_ecs.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_obtain_the_mac_address_of_my_ecs.rst deleted file mode 100644 index 8dd89bc8..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_obtain_the_mac_address_of_my_ecs.rst +++ /dev/null @@ -1,91 +0,0 @@ -:original_name: en-us_topic_0101604506.html - -.. _en-us_topic_0101604506: - -How Can I Obtain the MAC Address of My ECS? -=========================================== - -This section describes how to obtain the MAC address of an ECS. - -.. note:: - - The MAC address of an ECS cannot be changed. - -Linux (CentOS 6) ----------------- - -#. Log in to the Linux ECS. - -#. Run the following command to view the MAC address of the ECS: - - **ifconfig** - - .. _en-us_topic_0101604506__en-us_topic_0167240183_fig5947759164518: - - .. figure:: /_static/images/en-us_image_0121682272.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Obtaining the MAC address - -Linux (CentOS 7) ----------------- - -#. Log in to the Linux ECS. - -#. Run the following command to view the MAC address of the ECS: - - **ifconfig** - - .. _en-us_topic_0101604506__fig469484533215: - - .. figure:: /_static/images/en-us_image_0268824628.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Obtaining the NIC information - -#. Run the following command to view the MAC address of NIC **eth0**: - - **ifconfig eth0 \|egrep "ether"** - - .. _en-us_topic_0101604506__fig19751114377: - - .. figure:: /_static/images/en-us_image_0268825353.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Obtaining the MAC address of eth0 - -#. Obtain the returned MAC address. - - **ifconfig eth0 \|egrep "ether" \|awk '{print $2}'** - - .. _en-us_topic_0101604506__fig92621536113716: - - .. figure:: /_static/images/en-us_image_0268826092.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Obtaining the MAC address of eth0 - -Windows -------- - -#. Press **Win+R** to start the **Run** text box. - -#. Enter **cmd** and click **OK**. - -#. Run the following command to view the MAC address of the ECS: - - **ipconfig /all** - - |image1| - -.. |image1| image:: /_static/images/en-us_image_0188029785.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_test_network_performance.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_test_network_performance.rst deleted file mode 100644 index 7916f6ca..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_test_network_performance.rst +++ /dev/null @@ -1,518 +0,0 @@ -:original_name: en-us_topic_0115820205.html - -.. _en-us_topic_0115820205: - -How Can I Test Network Performance? -=================================== - -Use netperf and iperf3 to test network performance between ECSs. The test operations include preparations, TCP bandwidth test, UDP PPS test, and latency test. - -Background ----------- - -- Tested ECS: an ECS that is tested for network performance. Such an ECS functions as the client (TX end) or server (RX end) in netperf tests. - -- Auxiliary ECS: an ECS that is used to exchange test data with the tested ECS. The auxiliary ECS functions as the client (TX end) or server (RX end) in netperf tests. - -- :ref:`Table 1 ` and :ref:`Table 2 ` list the common netperf and iperf3 parameters. - - .. _en-us_topic_0115820205__table15359114885218: - - .. table:: **Table 1** Common netperf parameters - - +-----------+-----------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+===============================================================================================+ - | -p | Port number | - +-----------+-----------------------------------------------------------------------------------------------+ - | -H | IP address of the RX end | - +-----------+-----------------------------------------------------------------------------------------------+ - | -t | Protocol used in packet transmitting, the value of which is **TCP_STREAM** in bandwidth tests | - +-----------+-----------------------------------------------------------------------------------------------+ - | -l | Test duration | - +-----------+-----------------------------------------------------------------------------------------------+ - | -m | Data packet size, which is suggested to be **1440** in bandwidth tests | - +-----------+-----------------------------------------------------------------------------------------------+ - - .. _en-us_topic_0115820205__table8470126153613: - - .. table:: **Table 2** Common iperf3 parameters - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=================================================================================================================================================+ - | -p | Port number | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -c | IP address of the RX end | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -u | UDP packets | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -b | TX bandwidth | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -t | Test duration | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -l | Data packet size, which is suggested to be **16** in PPS tests | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | -A | ID of the vCPU used by iperf3 | - | | | - | | In this section, the maximum number of 16 vCPUs is used as an example for each ECS. If an ECS has 8 vCPUs, the **-A** value ranges from 0 to 7. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -Test Preparations ------------------ - -#. Prepare ECSs. - - Ensure that both type and specifications of the tested ECS and auxiliary ECSs are the same. In addition, ensure that these ECSs are deployed in the same ECS group with anti-affinity enabled. - - .. table:: **Table 3** Preparations - - +---------------+----------+--------------------------------+----------------------+---------------------------+ - | Category | Quantity | Image | Specifications | IP Address | - +===============+==========+================================+======================+===========================+ - | Tested ECS | 1 | CentOS 7.4 64bit (recommended) | At least eight vCPUs | 192.168.2.10 | - +---------------+----------+--------------------------------+----------------------+---------------------------+ - | Auxiliary ECS | 8 | CentOS 7.4 64bit (recommended) | At least 8 vCPUs | 192.168.2.11-192.168.2.18 | - +---------------+----------+--------------------------------+----------------------+---------------------------+ - -#. Install the netperf, iperf3, and sar test tools on both the tested ECS and auxiliary ECSs. - - :ref:`Table 4 ` lists the procedures for installing these tools. - - .. _en-us_topic_0115820205__table231811914413: - - .. table:: **Table 4** Installing test tools - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | Tool | Procedure | - +===================================+======================================================================================================================+ - | netperf | a. Run the following command to install gcc: | - | | | - | | **yum -y install unzip gcc gcc-c++** | - | | | - | | b. Run the following command to download the netperf installation package: | - | | | - | | **wget --no-check-certificate** **https://github.com/HewlettPackard/netperf/archive/refs/tags/netperf-2.7.0.zip** | - | | | - | | c. Run the following commands to decompress the installation package and install netperf: | - | | | - | | **unzip netperf-2.7.0.zip** | - | | | - | | **cd netperf-netperf-2.7.0/** | - | | | - | | **./configure && make && make install** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | iperf3 | a. Run the following command to download the iperf3 installation package: | - | | | - | | **wget --no-check-certificate https://codeload.github.com/esnet/iperf/zip/master -O iperf3.zip** | - | | | - | | b. Run the following commands to decompress the installation package and install iperf3: | - | | | - | | **unzip iperf3.zip** | - | | | - | | **cd iperf-master/** | - | | | - | | **./configure && make && make install** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ - | sar | Run the following command to install sar: | - | | | - | | **yum -y install sysstat** | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------+ - -#. Enable NIC multi-queue. - - Perform the following operations on both tested ECS and auxiliary ECSs. - - a. .. _en-us_topic_0115820205__li162918018139: - - Run the following command to check the number of queues supported by the ECSs: - - **ethtool -l eth0 \| grep -i Pre -A 5 \| grep Combined** - - b. Run the following command to enable NIC multi-queue: - - **ethtool -L eth0 combined** *X* - - In the preceding command, *X* is the number of queues obtained in :ref:`3.a `. - -TCP Bandwidth Test (Using netperf) ----------------------------------- - -Perform the test on multiple flows. This section considers 16 flows that are evenly distributed to eight ECSs, as an example. - -#. Test the TCP TX bandwidth. - - a. Run the following commands on all auxiliary ECSs to start the netserver process: - - **netserver -p** *12001* - - **netserver -p** *12002* - - In the preceding commands, **-p** specifies the listening port. - - b. Start the netperf process on the tested ECS and specify a netserver port for each auxiliary ECS. For details about common netperf parameters, see :ref:`Table 1 `. - - ##The IP address is for the first auxiliary ECS. - - **netperf -H** **192.168.2.11** **-p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.11** **-p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the second auxiliary ECS. - - **netperf -H** **192.168.2.12** **-p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.12** **-p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the third auxiliary ECS. - - **netperf -H** **192.168.2.13 -p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.13 -p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the fourth auxiliary ECS. - - **netperf -H** **192.168.2.14 -p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.14 -p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the fifth auxiliary ECS. - - **netperf -H** **192.168.2.15 -p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.15 -p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the sixth auxiliary ECS. - - **netperf -H** **192.168.2.16 -p** **12001 -t TCP_STREAM -l 300 -- -m** **1440 &** - - **netperf -H** **192.168.2.16 -p** **12002 -t TCP_STREAM -l 300 -- -m** **1440 &** - - ##The IP address is for the seventh auxiliary ECS. - - **netperf -H** **192.168.2.17 -p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.17 -p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - ##The IP address is for the eighth auxiliary ECS. - - **netperf -H** **192.168.2.18 -p** **12001 -t TCP_STREAM -l** **300 -- -m** **1440 &** - - **netperf -H** **192.168.2.18 -p** **12002 -t TCP_STREAM -l** **300 -- -m** **1440 &** - -#. Test the TCP RX bandwidth. - - a. Start the netserver process on the tested ECS. - - ##The port number is for the first auxiliary ECS. - - **netserver -p** **12001** - - **netserver -p** **12002** - - ##The port number is for the second auxiliary ECS. - - **netserver -p** **12003** - - **netserver -p** **12004** - - ##The port number is for the third auxiliary ECS. - - **netserver -p** **12005** - - **netserver -p** **12006** - - ##The port number is for the fourth auxiliary ECS. - - **netserver -p** **12007** - - **netserver -p** **12008** - - ##The port number is for the fifth auxiliary ECS. - - **netserver -p 12009** - - **netserver -p 12010** - - ##The port number is for the sixth auxiliary ECS. - - **netserver -p** **12011** - - **netserver -p** **12012** - - ##The port number is for the seventh auxiliary ECS. - - **netserver -p** **12013** - - **netserver -p** **12014** - - ##The port number is for the eighth auxiliary ECS. - - **netserver -p** **12015** - - **netserver -p** **12016** - - b. Start the netperf process on all auxiliary ECSs. - - Log in to auxiliary ECS 1. - - **netperf -H 192.168.2.10 -p 12001 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12002 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 2. - - **netperf -H 192.168.2.10 -p 12003 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12004 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 3. - - **netperf -H 192.168.2.10 -p 12005 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12006 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 4. - - **netperf -H 192.168.2.10 -p 12007 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12008 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 5. - - **netperf -H 192.168.2.10 -p 12009 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12010 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 6. - - **netperf -H 192.168.2.10 -p 12011 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12012 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 7. - - **netperf -H 192.168.2.10 -p 12013 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12014 -t TCP_STREAM -l 300 -- -m 1440 &** - - Log in to auxiliary ECS 8. - - **netperf -H 192.168.2.10 -p 12015 -t TCP_STREAM -l 300 -- -m 1440 &** - - **netperf -H 192.168.2.10 -p 12016 -t TCP_STREAM -l 300 -- -m 1440 &** - -#. Analyze the test result. - - After the test is complete, the output of the netperf process on one TX end is shown in :ref:`Figure 1 `. The final result is the sum of the test results of the netperf processes on all TX ends. - - .. _en-us_topic_0115820205__fig333414318238: - - .. figure:: /_static/images/en-us_image_0115873247.png - :alt: **Figure 1** Output of the netperf process on one TX end - - - **Figure 1** Output of the netperf process on one TX end - - .. note:: - - There are a large number of netperf processes. To facilitate statistics collection, it is a good practice to run the following command to view test data on the tested ECS using sar: - - **sar -n DEV 1 60** - -UDP PPS Test (Using iperf3) ---------------------------- - -#. Test the UDP TX PPS. - - a. Run the following commands on all auxiliary ECSs to start the server process: - - **iperf3 -s -p 12001 &** - - **iperf3 -s -p 12002 &** - - In the preceding commands, **-p** specifies the listening port. - - b. Start the client process on the tested ECS. For details about common iperf3 parameters, see :ref:`Table 2 `. - - ##Auxiliary ECS 1 - - **iperf3 -c 192.168.2.11 -p 12001 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.11 -p 12002 -u -b 100M -t 300 -l 16 -A 1 &** - - ##Auxiliary ECS 2 - - **iperf3 -c 192.168.2.12 -p 12001 -u -b 100M -t 300 -l 16 -A 2 &** - - **iperf3 -c 192.168.2.12 -p 12002 -u -b 100M -t 300 -l 16 -A 3 &** - - ##Auxiliary ECS 3 - - **iperf3 -c 192.168.2.13 -p 12001 -u -b 100M -t 300 -l 16 -A 4 &** - - **iperf3 -c 192.168.2.13 -p 12002 -u -b 100M -t 300 -l 16 -A 5 &** - - ##Auxiliary ECS 4 - - **iperf3 -c 192.168.2.14 -p 12001 -u -b 100M -t 300 -l 16 -A 6 &** - - **iperf3 -c 192.168.2.14 -p 12002 -u -b 100M -t 300 -l 16 -A 7 &** - - ##Auxiliary ECS 5 - - **iperf3 -c 192.168.2.15 -p 12001 -u -b 100M -t 300 -l 16 -A 8 &** - - **iperf3 -c 192.168.2.15 -p 12002 -u -b 100M -t 300 -l 16 -A 9 &** - - ##Auxiliary ECS 6 - - **iperf3 -c 192.168.2.16 -p 12001 -u -b 100M -t 300 -l 16 -A 10 &** - - **iperf3 -c 192.168.2.16 -p 12002 -u -b 100M -t 300 -l 16 -A 11 &** - - ##Auxiliary ECS 7 - - **iperf3 -c 192.168.2.17 -p 12001 -u -b 100M -t 300 -l 16 -A 12 &** - - **iperf3 -c 192.168.2.17 -p 12002 -u -b 100M -t 300 -l 16 -A 13 &** - - ##Auxiliary ECS 8 - - **iperf3 -c 192.168.2.18 -p 12001 -u -b 100M -t 300 -l 16 -A 14 &** - - **iperf3 -c 192.168.2.18 -p 12002 -u -b 100M -t 300 -l 16 -A 15 &** - -#. Test the UDP RX PPS. - - a. Start the server process on the tested ECS. For details about common iperf3 parameters, see :ref:`Table 2 `. - - ##Auxiliary ECS 1 - - **iperf3 -s -p 12001 -A 0 -i 60 &** - - **iperf3 -s -p 12002 -A 1 -i 60 &** - - ##Auxiliary ECS 2 - - **iperf3 -s -p 12003 -A 2 -i 60 &** - - **iperf3 -s -p 12004 -A 3 -i 60 &** - - ##Auxiliary ECS 3 - - **iperf3 -s -p 12005 -A 4 -i 60 &** - - **iperf3 -s -p 12006 -A 5 -i 60 &** - - ##Auxiliary ECS 4 - - **iperf3 -s -p 12007 -A 6 -i 60 &** - - **iperf3 -s -p 12008 -A 7 -i 60 &** - - ##Auxiliary ECS 5 - - **iperf3 -s -p 12009 -A 8 -i 60 &** - - **iperf3 -s -p 12010 -A 9 -i 60 &** - - ##Auxiliary ECS 6 - - **iperf3 -s -p 12011 -A 10 -i 60 &** - - **iperf3 -s -p 12012 -A 11 -i 60 &** - - ##Auxiliary ECS 7 - - **iperf3 -s -p 12013 -A 12 -i 60 &** - - **iperf3 -s -p 12014 -A 13 -i 60 &** - - ##Auxiliary ECS 8 - - **iperf3 -s -p 12015 -A 14 -i 60 &** - - **iperf3 -s -p 12016 -A 15 -i 60 &** - - b. Start the client process on all auxiliary ECSs. For details about common iperf3 parameters, see :ref:`Table 2 `. - - Log in to auxiliary ECS 1. - - **iperf3 -c 192.168.2.10 -p 12001 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12002 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 2. - - **iperf3 -c 192.168.2.10 -p 12003 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12004 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 3. - - **iperf3 -c 192.168.2.10 -p 12005 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12006 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 4. - - **iperf3 -c 192.168.2.10 -p 12007 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12008 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 5. - - **iperf3 -c 192.168.2.10 -p 12009 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12010 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 6. - - **iperf3 -c 192.168.2.10 -p 12011 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12012 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 7. - - **iperf3 -c 192.168.2.10 -p 12013 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12014 -u -b 100M -t 300 -l 16 -A 1 &** - - Log in to auxiliary ECS 8. - - **iperf3 -c 192.168.2.10 -p 12015 -u -b 100M -t 300 -l 16 -A 0 &** - - **iperf3 -c 192.168.2.10 -p 12016 -u -b 100M -t 300 -l 16 -A 1 &** - -#. Analyze the test result. - - :ref:`Figure 2 ` shows an example of the UDP PPS test result. - - .. _en-us_topic_0115820205__fig166644134610: - - .. figure:: /_static/images/en-us_image_0115874559.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** UDP PPS test result - - .. note:: - - There are a large number of iperf3 processes. To facilitate statistics collection, it is a good practice to run the following command to view test data on the tested ECS using sar: - - **sar -n DEV 1 60** - -Latency Test ------------- - -#. Run the following command to start the qperf process on the tested ECS: - - **qperf &** - -#. Log in to auxiliary ECS 1 and run the following command to perform a latency test: - - **qperf 192.168.2.10 -m 64 -t 60 -vu udp_lat** - - After the test is complete, the **lat** value in the command output is the latency between ECSs. diff --git a/ecs/umn/result/faqs/network_configurations/how_can_i_view_and_modify_kernel_parameters_of_a_linux_ecs.rst b/ecs/umn/result/faqs/network_configurations/how_can_i_view_and_modify_kernel_parameters_of_a_linux_ecs.rst deleted file mode 100644 index 9c26b419..00000000 --- a/ecs/umn/result/faqs/network_configurations/how_can_i_view_and_modify_kernel_parameters_of_a_linux_ecs.rst +++ /dev/null @@ -1,190 +0,0 @@ -:original_name: en-us_topic_0107659745.html - -.. _en-us_topic_0107659745: - -How Can I View and Modify Kernel Parameters of a Linux ECS? -=========================================================== - -Modify the kernel parameters only if the parameter settings affect your services. Kernel parameters vary depending on OS versions. If the parameter settings must be modified, - -- Ensure that the target parameter settings meet service requirements. -- Modify the correct kernel parameters. For details about common kernel parameters, see :ref:`Table 1 `. -- Back up key ECS data before modifying kernel parameter settings. - -Background ----------- - -.. _en-us_topic_0107659745__table15253154115313: - -.. table:: **Table 1** Common Linux kernel parameters - - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +====================================================+=====================================================================================================================================================================================================================================================================================================================================================================+ - | net.core.rmem_default | Specifies the default size (in bytes) of the window for receiving TCP data. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.rmem_max | Specifies the maximum size (in bytes) of the window for receiving TCP data. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.wmem_default | Specifies the default size (in bytes) of the window for transmitting TCP data. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.wmem_max | Specifies the maximum size (in bytes) of the window for transmitting TCP data. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.netdev_max_backlog | Specifies the maximum number of packets that can be sent to a queue when the rate at which each network port receives packets is faster than the rate at which the kernel processes these packets. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.somaxconn | Defines the maximum length of the listening queue for each port in the system. This parameter applies globally. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.core.optmem_max | Specifies the maximum size of the buffer allowed by each socket. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_mem | Uses the TCP stack to show memory usage in memory pages (4 KB generally). | - | | | - | | The first value is the lower limit of memory usage. | - | | | - | | The second value is the upper limit of the load added to the buffer when the memory is overloaded. | - | | | - | | The third value is the upper limit of memory usage. When this value is reached, packets can be discarded to reduce memory usage. For a large BDP, increase the parameter value as needed. The unit of this parameter is memory page but not byte. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_rmem | Specifies the memory used by sockets for automatic optimization. | - | | | - | | The first value is the minimum number of bytes allocated to the socket buffer for receiving data. | - | | | - | | The second value is the default value, which is overwritten by **rmem_default**. The buffer size can increase to this value when the system load is not heavy. | - | | | - | | The third value is the maximum number of bytes allocated to the socket buffer for receiving data. This value is overwritten by **rmem_max**. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_wmem | Specifies the memory used by sockets for automatic optimization. | - | | | - | | The first value is the minimum number of bytes allocated to the socket buffer for transmitting data. | - | | | - | | The second value is the default value, which is overwritten by **wmem_default**. The buffer size can increase to this value when the system load is not heavy. | - | | | - | | The third value is the maximum number of bytes allocated to the socket buffer for transmitting data. This value is overwritten by **wmem_max**. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_keepalive_time | Specifies the interval at which keepalive detection messages are sent in seconds for checking TCP connections. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_keepalive_intvl | Specifies the interval at which keepalive detection messages are resent in seconds when no response is received. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_keepalive_probes | Specifies the maximum number of keepalive detection messages that are sent to determine a TCP connection failure. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_sack | Enables selective acknowledgment (value **1** indicates enabled). This configuration allows the transmitter to resend only lost packets, thereby improving system performance. However, this configuration will increase the CPU usage. You are suggested to enable selective acknowledgment for WAN communication. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_fack | Enables forwarding acknowledgment for selective acknowledgment (SACK), thereby reducing congestion. You are suggested to enable forwarding acknowledgment. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_timestamps | Specifies a TCP timestamp, which will add 12 bytes in the TCP packet header. This configuration calculates RTT using RFC1323, a more precise retransmission method upon timeout than retransmission. You are suggested to use this configuration for higher system performance. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_window_scaling | Enables RFC1323-based window scaling by setting the parameter value to **1** if the TCP window is larger than 64 KB. The maximum TCP window is 1 GB. This parameter takes effect only when window scaling is enabled on both ends of the TCP connection. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_syncookies | Specifies whether to enable TCP synchronization (**syncookie**). This configuration prevents socket overloading when a large number of connections are attempted to set up. **CONFIG_SYN_COOKIES** must be enabled in the kernel for compilation. The default value is **0**, indicating that TCP synchronization is disabled. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_tw_reuse | Specifies whether a **TIME-WAIT** socket (**TIME-WAIT** port) can be used for new TCP connections. | - | | | - | | .. note:: | - | | | - | | This parameter cannot be set to **1** if NAT is enabled. Otherwise, an error will occur in remote ECS logins. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_tw_recycle | Allows fast recycle of **TIME-WAIT** sockets. | - | | | - | | .. note:: | - | | | - | | Do not set this parameter to **1** if NAT is enabled. Otherwise, an error will occur during remote ECS logins. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_fin_timeout | Specifies the time (in seconds) during which a socket TCP connection that is disconnected from the local end remains in the **FIN-WAIT-2** state. Process suspension may be caused by the disconnection from the peer end, continuous connection from the peer end, or other reasons. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.ip_local_port_range | Specifies local port numbers allowed by TCP/UDP. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_max_syn_backlog | Specifies the maximum number of connection requests that are not acknowledged by the peer end and that can be stored in the queue. The default value is **1024**. If the server is frequently overloaded, try to increase the value. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_low_latency | This option should be disabled if the TCP/IP stack is used for high throughput, low latency. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_westwood | Enables the congestion control algorithm on the transmitter end to evaluate throughput and improve the overall bandwidth utilization. You are suggested to enable the congestion control algorithm for WAN communication. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_bic | Enables binary increase congestion for fast long-distance networks so that the connections with operations being performed at a rate of Gbit/s can be functional. You are suggested to enable binary increase congestion for WAN communication. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_max_tw_buckets | Specifies the number of TIME_WAIT buckets, which defaults to **180000**. If the number of buckets exceeds the default value, extra ones will be cleared. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_synack_retries | Specifies the number of times that SYN+ACK packets are retransmitted in **SYN_RECV** state. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.tcp_abort_on_overflow | When this parameter is set to **1**, if the system receives a large number of requests within a short period of time but fails to process them, the system will send reset packets to terminate the connections. It is recommended that you improve system processing capabilities by optimizing the application efficiency instead of performing reset operations. | - | | | - | | Default value: **0** | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.route.max_size | Specifies the maximum number of routes allowed by the kernel. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.ip_forward | Forward packets between interfaces. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.ipv4.ip_default_ttl | Specifies the maximum number of hops that a packet can pass through. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.netfilter.nf_conntrack_tcp_timeout_established | Clears iptables connections that are inactive for a specific period of time. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net.netfilter.nf_conntrack_max | Specifies the maximum value of hash entries. | - +----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Viewing Kernel Parameters -------------------------- - -- Method 1: Run the cat command in **/proc/sys** to view file content. - - **/proc/sys/** is a pseudo directory generated after the Linux kernel is started. The **net** folder in this directory stores all kernel parameters that have taken effect in the system. The directory tree structure is determined based on complete parameter names. For example, **net.ipv4.tcp_tw_recycle** corresponds to the **/proc/sys/net/ipv4/tcp_tw_recycle** file, and the content of the file is the parameter value. - - Example: - - To view the **net.ipv4.tcp_tw_recycle** value, run the following command: - - **cat /proc/sys/net/ipv4/tcp_tw_recycle** - -- Method 2: Use the **/etc/sysctl.conf** file. - - Run the following command to view all parameters that have taken effect in the system: - - **/usr/sbin/sysctl -a** - - .. code-block:: - - net.ipv4.tcp_syncookies = 1 - net.ipv4.tcp_max_tw_buckets = 4096 - net.ipv4.tcp_tw_reuse = 1 - net.ipv4.tcp_tw_recycle = 1 - net.ipv4.tcp_keepalive_time = 1800 - net.ipv4.tcp_fin_timeout = 30 - ...... - net.ipv4.tcp_keepalive_time = 1200 - net.ipv4.ip_local_port_range = 1024 65000 - net.ipv4.tcp_max_syn_backlog = 8192 - net.ipv4.tcp_rmem = 16384 174760 349520 - net.ipv4.tcp_wmem = 16384 131072 262144 - net.ipv4.tcp_mem = 262144 524288 1048576 - ...... - -Modifying Kernel Parameter Settings ------------------------------------ - -- Method 1: Run the echo command in **/proc/sys** to modify the file for the target kernel parameters. - - The parameter values changed using this method take effect only during the current running and will be reset after the system is restarted. To make the modification take effect permanently, see method 2. - - **/proc/sys/** is a pseudo directory generated after the Linux kernel is started. The **net** folder in this directory stores all kernel parameters that have taken effect in the system. The directory tree structure is determined based on complete parameter names. For example, **net.ipv4.tcp_tw_recycle** corresponds to the **/proc/sys/net/ipv4/tcp_tw_recycle** file, and the content of the file is the parameter value. - - Example: - - To change the **net.ipv4.tcp_tw_recycle** value to **0**, run the following command: - - **echo "0" > /proc/sys/net/ipv4/tcp_tw_recycle** - -- Method 2: Use the **/etc/sysctl.conf** file. - - The parameter values changed using this method take effect permanently. - - #. Run the following command to change the value of a specified parameter: - - **/sbin/sysctl -w kernel.domainname="**\ *example.com*\ **"** - - Example: - - sysctl -w net.ipv4.tcp_tw_recycle="0" - - #. Run the following command to change the parameter value in the **/etc/sysctl.conf** file: - - **vi /etc/sysctl.conf** - - #. Run the following command for the configuration to take effect: - - **/sbin/sysctl -p** diff --git a/ecs/umn/result/faqs/network_configurations/index.rst b/ecs/umn/result/faqs/network_configurations/index.rst deleted file mode 100644 index 165e1820..00000000 --- a/ecs/umn/result/faqs/network_configurations/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _en-us_topic_0018124785: - -====================== -Network Configurations -====================== - -.. toctree:: - :maxdepth: 1 - - can_i_bind_multiple_eips_to_an_ecs - can_an_ecs_without_an_eip_access_the_internet - why_cant_an_eip_be_pinged - why_can_i_remotely_access_an_ecs_but_cannot_ping_it - will_nics_added_to_an_ecs_start_automatically - how_can_i_check_whether_the_network_communication_is_normal_between_two_ecss_equipped_with_an_infiniband_nic_driver - how_can_i_manually_configure_an_ip_address_for_an_infiniband_nic - why_is_the_nic_not_working - how_can_i_handle_the_issue_that_a_windows_7_ecs_equipped_with_an_intel_82599_nic_reports_an_error_in_sr-iov_scenarios - why_cant_my_linux_ecs_obtain_metadata - how_can_i_obtain_the_mac_address_of_my_ecs - how_can_i_test_network_performance - why_cant_i_use_dhcp_to_obtain_a_private_ip_address - how_can_i_view_and_modify_kernel_parameters_of_a_linux_ecs - how_can_i_configure_port_redirection - can_the_ecss_of_different_accounts_communicate_over_an_intranet - will_ecss_that_i_purchased_deployed_in_the_same_subnet diff --git a/ecs/umn/result/faqs/network_configurations/why_can_i_remotely_access_an_ecs_but_cannot_ping_it.rst b/ecs/umn/result/faqs/network_configurations/why_can_i_remotely_access_an_ecs_but_cannot_ping_it.rst deleted file mode 100644 index cf309f9d..00000000 --- a/ecs/umn/result/faqs/network_configurations/why_can_i_remotely_access_an_ecs_but_cannot_ping_it.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: en-us_topic_0018078505.html - -.. _en-us_topic_0018078505: - -Why Can I Remotely Access an ECS But Cannot Ping It? -==================================================== - -Symptom -------- - -You can remotely access an ECS but when you ping the EIP bound to the ECS, the ping operation fails. - -Possible Causes ---------------- - -A desired inbound rule is not added for the security group, and ICMP is not enabled. - -Solution --------- - -#. Log in to the management console. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Security Groups** tab, expand the information of the security group, and click the security group ID. - -#. On the **Inbound Rules** tab of the **Security Group** page, click **Add Rule**. - -#. Add an inbound rule for the security group and enable ICMP. - - - **Protocol**: **ICMP** - - **Source**: **IP address** **0.0.0.0/0** diff --git a/ecs/umn/result/faqs/network_configurations/why_cant_an_eip_be_pinged.rst b/ecs/umn/result/faqs/network_configurations/why_cant_an_eip_be_pinged.rst deleted file mode 100644 index 3ae4b250..00000000 --- a/ecs/umn/result/faqs/network_configurations/why_cant_an_eip_be_pinged.rst +++ /dev/null @@ -1,261 +0,0 @@ -:original_name: en-us_topic_0105130172.html - -.. _en-us_topic_0105130172: - -Why Can't an EIP Be Pinged? -=========================== - -Symptom -------- - -After you purchase an EIP and bind it to an ECS, the ping operation to the EIP fails, or the ECS fails to access the Internet. - -Fault Locating --------------- - -The following fault causes are sequenced based on their occurrence probability. - -If the fault persists after you have ruled out a cause, check other causes. - -.. _en-us_topic_0105130172__en-us_topic_0118498854_fig257119102320: - -.. figure:: /_static/images/en-us_image_0293553366.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Method of locating the failure to ping an EIP - -.. table:: **Table 1** Method of locating the failure to ping an EIP - - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Possible Cause | Solution | - +==============================================================+==========================================================================================================================================================================================================================================================================+ - | ICMP access rules are not added to the security group. | Add ICMP access rules to the security group. For details, see :ref:`Checking Security Group Rules `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Ping operations are prohibited on the firewall. | Allow ping operations on the firewall. For details, see :ref:`Checking Firewall Settings `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Ping operations are prohibited on the ECS. | Allow ping operations on the ECS. For details, see :ref:`Checking Whether Ping Operations Have Been Disabled on the ECS `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Network ACL is associated. | If the VPC is associated with a network ACL, check the network ACL rules. For details, see :ref:`Checking ACL Rules `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | A network exception occurred. | Use another ECS in the same region to check whether the local network is functional. For details, see :ref:`Checking Whether the Network Is Functional `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Routes are incorrectly configured if multiple NICs are used. | If the network is inaccessible due to an extension NIC, the fault is generally caused by incorrect route configurations. To resolve this issue, see :ref:`Checking the ECS Route Configuration If Multiple NICs Are Used `. | - +--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0105130172__section1715910911214: - -Checking Security Group Rules ------------------------------ - -The ping operations use the ICMP protocol. Check whether the security group accommodating the ECS allows ICMP traffic in the inbound direction. - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Security Groups** tab, expand the information of the security group, and view security group rules. - -#. Click the security group ID. - - The system automatically switches to the **Security Group** page. - -#. On the **Inbound Rules** tab, click **Add Rule**. In the displayed dialog box, set required parameters to add an inbound rule. - - .. table:: **Table 2** Security group rules - - +--------------------+-----------------+---------------------+---------------------------------------+ - | Transfer Direction | Type | Protocol/Port Range | Source | - +====================+=================+=====================+=======================================+ - | Inbound | IPv4 | ICMP/Any | 0.0.0.0/0 | - | | | | | - | | | | 0.0.0.0/0 indicates all IP addresses. | - +--------------------+-----------------+---------------------+---------------------------------------+ - -#. Click **OK** to complete the security rule configuration. - -.. _en-us_topic_0105130172__section774414326138: - -Checking Firewall Settings --------------------------- - -If a firewall is enabled on the ECS, check whether the firewall blocks the ping operations. - -**Linux** - -#. Consider CentOS 7 as an example. Run the following command to check the firewall status: - - **firewall-cmd --state** - - If **running** is displayed in the command output, the firewall has been enabled. - -2. Check whether there is any ICMP rule blocking the ping operations. - - **iptables -L** - - If the command output shown in :ref:`Figure 2 ` is displayed, there is no ICMP rule blocking the ping operations. - - .. _en-us_topic_0105130172__fig7244357113416: - - .. figure:: /_static/images/en-us_image_0250117342.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Checking firewall rules - - If the ping operations are blocked by an ICMP rule, run the following commands to modify the rule for unblocking: - - **iptables -A INPUT -p icmp --icmp-type echo-request -j ACCEPT** - - **iptables -A OUTPUT -p icmp --icmp-type echo-reply -j ACCEPT** - -**Windows** - -#. Log in to the Windows ECS, click the Windows icon in the lower left corner of the desktop, and choose **Control Panel** > **Windows Firewall**. - -#. Click **Turn Windows Firewall on or off**. - - View and set the firewall status. - -#. If the firewall is **On**, go to :ref:`4 `. - -#. .. _en-us_topic_0105130172__li192824161474: - - Check the ICMP rule statuses in the firewall. - - a. In the navigation pane on the **Windows Firewall** page, click **Advanced settings**. - - b. Enable the following rules: - - **Inbound Rules**: **File and Printer Sharing (Echo Request - ICMPv4-In)** - - **Outbound Rules**: **File and Printer Sharing (Echo Request - ICMPv4-Out)** - - If IPv6 is enabled, enable the following rules: - - **Inbound Rules**: **File and Printer Sharing (Echo Request - ICMPv6-In)** - - **Outbound Rules**: **File and Printer Sharing (Echo Request - ICMPv6-Out)** - - .. _en-us_topic_0105130172__fig178326362544: - - .. figure:: /_static/images/en-us_image_0250182352.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Inbound Rules - - .. _en-us_topic_0105130172__fig5225320554: - - .. figure:: /_static/images/en-us_image_0250182717.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Outbound Rules - -.. _en-us_topic_0105130172__section42301821174115: - -Checking Whether Ping Operations Have Been Disabled on the ECS --------------------------------------------------------------- - -**Windows** - -Enable ping operations using the CLI. - -#. Start the **Run** dialog box. Enter **cmd** and press **Enter**. - -#. Run the following command to enable ping operations: - - **netsh firewall set icmpsetting 8** - -**Linux** - -Check the ECS kernel parameters. - -#. Check the **net.ipv4.icmp_echo_ignore_all** value in the **/etc/sysctl.conf** file. Value **0** indicates that ping operations are allowed, and value **1** indicates that ping operations are prohibited. -#. Allow ping operations. - - - Run the following command to temporarily allow the ping operations: - - #echo 0 >/proc/sys/net/ipv4/icmp_echo_ignore_all - - - Run the following command to permanently allow the ping operations: - - net.ipv4.icmp_echo_ignore_all=0 - -.. _en-us_topic_0105130172__en-us_topic_0096302298_section374314592329: - -Checking ACL Rules ------------------- - -By default, no ACL is configured for a VPC. If a network ACL is associated with a VPC, check the ACL rules. - -#. Check whether the subnet of the ECS has been associated with a network ACL. - - If an ACL name is displayed, the network ACL has been associated with the ECS. - -#. Click the ACL name to view its status. - -#. If the network ACL is enabled, add an ICMP rule to allow traffic. - - .. note:: - - The default network ACL rule denies all incoming and outgoing packets. If a network ACL is disabled, the default rule is still effective. - -.. _en-us_topic_0105130172__section108152100162: - -Checking Whether the Network Is Functional ------------------------------------------- - -#. Use another ECS in the same region to check whether the local network is functional. - - Use another ECS in the same region to ping the affected EIP. If the EIP can be pinged, the VPC is functional. In such a case, rectify the local network fault and ping the affected EIP again. - -#. Check whether the link is accessible. - - A ping failure is caused by packet loss or long delay, which may be caused by link congestion, link node faults, or heavy load on the ECS. - -.. _en-us_topic_0105130172__section175172388145: - -Checking the ECS Route Configuration If Multiple NICs Are Used --------------------------------------------------------------- - -Generally, the default route of an OS will preferentially select the primary NIC. If an extension NIC is selected in a route and the network malfunctions, this issue is typically caused by incorrect route configuration. - -- If the ECS has multiple NICs, check whether the default route is available. - - #. Log in to the ECS and run the following command to check whether the default route is available: - - **ip route** - - .. _en-us_topic_0105130172__fig7362102412018: - - .. figure:: /_static/images/en-us_image_0250105611.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Default route - - #. If the route is unavailable, run the following command to add it: - - **ip route add default via XXXX dev eth0** - - .. note:: - - In the preceding command, *XXXX* specifies a gateway IP address. - -- If the ECS has multiple NICs and the EIP is bound to an extension NIC, configure policy routing on the ECS for network communication with the extension NIC. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/faqs/network_configurations/why_cant_i_use_dhcp_to_obtain_a_private_ip_address.rst b/ecs/umn/result/faqs/network_configurations/why_cant_i_use_dhcp_to_obtain_a_private_ip_address.rst deleted file mode 100644 index d2464a3e..00000000 --- a/ecs/umn/result/faqs/network_configurations/why_cant_i_use_dhcp_to_obtain_a_private_ip_address.rst +++ /dev/null @@ -1,77 +0,0 @@ -:original_name: en-us_topic_0105130173.html - -.. _en-us_topic_0105130173: - -Why Can't I Use DHCP to Obtain a Private IP Address? -==================================================== - -Symptom -------- - -You attempt to use DHCP to obtain a private IP address, but you cannot obtain the IP address. - -- For Linux, a private IP address cannot be assigned. -- For Windows, a private IP address is changed to an IP address in the 169.254 network segment, which is different from the private IP address displayed on the ECS console. - -Solution --------- - -#. Check whether dhclient is running in the ECS. - - a. Log in to the ECS and run the following command: - - **ps -ef \| grep dhclient** - - b. If the process is not running, log in to the ECS, and restart the ECS NIC or initiate a DHCP request. - - - Linux - - Run the **dhclient eth0**, **ifdown eth0 + ifup eth0**, or **dhcpcd eth0** command. - - - Windows - - Right-click a local area connection and choose **Disable** from the shortcut menu. Then, choose **Enable**. - - |image1| - -#. Handle the issue if the DHCP client fails to work for a long time (for example, the issue recurs after the NIC is restarted). - - a. Configure a static IP address. - - - Windows - - #. Right-click **Local Area Connection** and choose **Properties** from the shortcut menu. - - #. In the displayed dialog box, select **Internet Protocol Version 4 (TCP/IPv4)**, click **Properties**, and modify parameter settings. - - |image2| - - - Linux - - #. Log in to the ECS and run the following command to modify parameter settings: - - **vi /etc/sysconfig/network-scripts/ifcfg-eth0** - - .. code-block:: - - BOOTPROTO=static - IPADDR=192.168.1.100 #IP address (modified) - NETMASK=255.255.255.0 #Mask (modified) - GATEWAY=192.168.1.1 #Gateway IP address (modified) - - #. Restart the ECS to make the network settings take effect. - - b. Select an image in which DHCP runs stably. - - Use the public images, which support DHCP, provided on the management console. - - DHCP needs to be configured only when Network is used for network management. DHCP does not need to be configured when NetworkManager is used for network management. - -#. If the fault persists, obtain the messages in **/var/log/messages** on the affected ECS, use the MAC address of the affected NIC to filter the desired log, and check whether there is any process that prevents DHCP from obtaining an IP address. -#. If the fault persists, contact customer service for technical support. - -.. |image1| image:: /_static/images/en-us_image_0121682580.png - -.. |image2| image:: /_static/images/en-us_image_0121682602.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/network_configurations/why_cant_my_linux_ecs_obtain_metadata.rst b/ecs/umn/result/faqs/network_configurations/why_cant_my_linux_ecs_obtain_metadata.rst deleted file mode 100644 index 907ef409..00000000 --- a/ecs/umn/result/faqs/network_configurations/why_cant_my_linux_ecs_obtain_metadata.rst +++ /dev/null @@ -1,62 +0,0 @@ -:original_name: en-us_topic_0000001138811177.html - -.. _en-us_topic_0000001138811177: - -Why Can't My Linux ECS Obtain Metadata? -======================================= - -Symptom -------- - -The security group of the Linux ECS has been configured based on the prerequisites in :ref:`Obtaining Metadata ` in the outbound direction, but the ECS still cannot obtain the metadata through the route with the destination of 169.254.169.254. - -Root Cause ----------- - -Run the following command on the Linux ECS configured with a static IP address: - -**#** **ip route\| grep 169.254** - -The route with the destination of 169.254.169.254 does not exist, but the route with the destination of 169.254.0.0/16 exists. - -.. _en-us_topic_0000001138811177__fig538615619196: - -.. figure:: /_static/images/en-us_image_0000001092174258.png - :alt: **Figure 1** Route information - - - **Figure 1** Route information - -After the network is restarted, the original route with the destination of 169.254.169.254 is changed to the route with the destination of 169.254.0.0/16 without a next hop. As a result, the Linux ECS cannot obtain metadata. - -Solution --------- - -#. Add the route with the destination of 169.254.169.254, and specify the next hop (gateway) and the output device (primary NIC of the Linux ECS). The following is an example: - - **# ip route add 169.254.169.254 via** **192.168.1.1** **dev** **eth0** - - 192.168.1.1 is the gateway address of the subnet that the primary NIC resides, and eth0 is the primary NIC. - -#. Run the following command to verify that the metadata can be obtained: - - **# curl** **http://169.254.169.254** - - .. _en-us_topic_0000001138811177__fig813563852216: - - .. figure:: /_static/images/en-us_image_0000001092045958.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Obtaining metadata - -3. Run the following command to create or modify the **/etc/sysconfig/network-scripts/route-eth0** file to prevent the static route from being changed after network restart: - - **# vi /etc/sysconfig/network-scripts/route-eth0** - - Add the following content to the file: - - In this example, the primary NIC is eth0 and gateway address is 192.168.1.1. Replace them based on site requirements. - - **# 169.254.169.254 via 192.168.1.1** diff --git a/ecs/umn/result/faqs/network_configurations/why_is_the_nic_not_working.rst b/ecs/umn/result/faqs/network_configurations/why_is_the_nic_not_working.rst deleted file mode 100644 index 56ce46fe..00000000 --- a/ecs/umn/result/faqs/network_configurations/why_is_the_nic_not_working.rst +++ /dev/null @@ -1,131 +0,0 @@ -:original_name: en-us_topic_0036068717.html - -.. _en-us_topic_0036068717: - -Why Is the NIC Not Working? -=========================== - -Symptom -------- - -The NIC equipped on a disk-intensive or large-memory ECS does not work. - -Possible Causes ---------------- - -The NIC driver has not been correctly installed. - -Solution --------- - -Disk-intensive and large-memory ECSs use passthrough NICs to improve network performance. You must install the passthrough NIC driver on the ECSs or the image that is used for creating the ECSs. - -.. note:: - - If you mount the CD/DVD-ROM driver over a VPN, ensure that the VPN bandwidth is greater than 8 Mbit/s. - -To install the passthrough NICE driver, do as follows: - -#. Obtain the passthrough NIC driver. - - Passthrough NIC driver versions vary depending on the OS. For details, see :ref:`Table 1 `. - - .. _en-us_topic_0036068717__table39612229174432: - - .. table:: **Table 1** NIC driver versions and OSs - - +-----------------------+-------------------------------------------+-----------------------------------------------------------------------+ - | NIC Driver Version | OS | How to Obtain | - +=======================+===========================================+=======================================================================+ - | ixgbevf 2.16.4 | CentOS 7.2 64bit | https://sourceforge.net/projects/e1000/files/ixgbevf%20stable/2.16.4/ | - +-----------------------+-------------------------------------------+-----------------------------------------------------------------------+ - | | Red Hat Enterprise Linux 7.2 64bit | | - +-----------------------+-------------------------------------------+-----------------------------------------------------------------------+ - | ixgbevf 2.16.1 | SUSE Linux Enterprise Server 11 SP3 64bit | https://sourceforge.net/projects/e1000/files/ixgbevf%20stable/2.16.1/ | - | | | | - | | SUSE Linux Enterprise Server 11 SP4 64bit | | - +-----------------------+-------------------------------------------+-----------------------------------------------------------------------+ - -#. Log in to the ECS. - - For more details, see :ref:`Login Overview `. - -#. Install the passthrough NIC driver on the ECS. In this procedure, Red Hat Enterprise Linux 7.2 64bit is used as an example. - - a. Configure the passthrough NIC. - - Not all ECS OSs identify passthrough NICs using the standard NIC naming rule of **eth**\ *x*, where *x* is a number. If this is the case, you must configure the ECS so that it can identify the passthrough NIC. The procedure is as follows: - - #. Run the following command to view all NICs on the ECS and identify the passthrough NIC: - - **ifconfig -a** - - #. Run the following command to switch to the directory where configuration files are stored: - - **cd /etc/sysconfig/network-scripts/** - - #. Run the following command to create a configuration file for the passthrough NIC: - - **cp ifcfg-eth0 ifcfg-**\ *NIC_name* - - In the preceding command, *NIC_name* specifies the name of the passthrough NIC. - - #. Use the vi editor to edit this configuration file: - - **vi ifcfg-**\ *NIC_name* - - #. Set the **DEVICE** parameter in the configuration file to the name of the passthrough NIC. The following is an example configuration: - - .. code-block:: - - DEVICE="NIC_name" - BOOTPROTO="dhcp" - ONBOOT="yes" - STARTMODE="onboot" - - #. Run the following command to restart the network service and allow the configuration to take effect: - - **service network restart** - - b. Upload the obtained passthrough NIC driver to a directory on the ECS, for example, **/home**. - - c. Switch to user **root** on the ECS CLI and open the target directory. - - In this example, the passthrough NIC driver is stored in the **/home** directory. Run the **cd** */home* command to switch to the target directory. - - d. Run the following command to decompress the software package. (In this procedure, ixgbevf version 2.16.4 is used as an example.) - - **tar -zxvf ixgbevf-2.16.4.tar.gz** - - e. Run the following command to switch to the generated **src** directory: - - **cd ixgbevf-2.16.4/src** - - f. Run the following commands to install the driver: - - **make** - - **make install** - - g. Run the following command to restart the ECS to make the drive take effect: - - **reboot** - - h. Switch to user **root** on the ECS CLI and open the **src** directory, for example, by running the **cd** */home/ixgbevf-2.16.4/src* command. Then, run the following commands to check whether the driver has been installed: - - **rmmod ixgbevf** - - **insmod ./ixgbevf.ko** - - **ethtool -i** *NIC_name* - - In the preceding command, *NIC_name* specifies the passthrough NIC name, for example, **ens5**. - - .. note:: - - - After you run the **rmmod ixgbevf** command, the system may display an error message. This message does not affect the installation of the passthrough NIC driver and can be ignored. - - *NIC_name* specifies the passthrough NIC name, for example, **ens5.** - - i. Check the driver status based on the displayed information. - - In this example, the driver is installed if **driver** is **ixgbevf** and **version** is **2.16.4**. diff --git a/ecs/umn/result/faqs/network_configurations/will_ecss_that_i_purchased_deployed_in_the_same_subnet.rst b/ecs/umn/result/faqs/network_configurations/will_ecss_that_i_purchased_deployed_in_the_same_subnet.rst deleted file mode 100644 index 574c47d8..00000000 --- a/ecs/umn/result/faqs/network_configurations/will_ecss_that_i_purchased_deployed_in_the_same_subnet.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0018078503.html - -.. _en-us_topic_0018078503: - -Will ECSs That I Purchased Deployed in the Same Subnet? -======================================================= - -You can customize your network to deploy the ECSs. Therefore, whether they are in the same subnet is totally up to you. diff --git a/ecs/umn/result/faqs/network_configurations/will_nics_added_to_an_ecs_start_automatically.rst b/ecs/umn/result/faqs/network_configurations/will_nics_added_to_an_ecs_start_automatically.rst deleted file mode 100644 index 3f7eb6aa..00000000 --- a/ecs/umn/result/faqs/network_configurations/will_nics_added_to_an_ecs_start_automatically.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0025445670.html - -.. _en-us_topic_0025445670: - -Will NICs Added to an ECS Start Automatically? -============================================== - -Based on test results, if the ECS runs CentOS 7.0, NICs added to the ECS cannot start automatically. You must start the NICs manually. diff --git a/ecs/umn/result/faqs/os_management/can_i_change_the_os_of_an_ecs.rst b/ecs/umn/result/faqs/os_management/can_i_change_the_os_of_an_ecs.rst deleted file mode 100644 index ca64de12..00000000 --- a/ecs/umn/result/faqs/os_management/can_i_change_the_os_of_an_ecs.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0018078522.html - -.. _en-us_topic_0018078522: - -Can I Change the OS of an ECS? -============================== - -Yes. You can change the OS of an ECS. - -For instructions about how to change an ECS OS, see :ref:`Changing the OS `. diff --git a/ecs/umn/result/faqs/os_management/can_i_install_or_upgrade_the_os_of_an_ecs.rst b/ecs/umn/result/faqs/os_management/can_i_install_or_upgrade_the_os_of_an_ecs.rst deleted file mode 100644 index 1d709d11..00000000 --- a/ecs/umn/result/faqs/os_management/can_i_install_or_upgrade_the_os_of_an_ecs.rst +++ /dev/null @@ -1,11 +0,0 @@ -:original_name: en-us_topic_0018078520.html - -.. _en-us_topic_0018078520: - -Can I Install or Upgrade the OS of an ECS? -========================================== - -You can install or upgrade ECS OSs provided on the cloud platform. - -- When you create an ECS, you can select a public image or a private image created from a public image to install the ECS OS. Select an OS image based on the programming language in the actual application scenario. -- You can change your ECS OS through the management console, for example, you can upgrade CentOS 7.2 to CentOS 7.3. diff --git a/ecs/umn/result/faqs/os_management/can_i_select_another_os_during_ecs_os_reinstallation.rst b/ecs/umn/result/faqs/os_management/can_i_select_another_os_during_ecs_os_reinstallation.rst deleted file mode 100644 index fcba6238..00000000 --- a/ecs/umn/result/faqs/os_management/can_i_select_another_os_during_ecs_os_reinstallation.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0024912311.html - -.. _en-us_topic_0024912311: - -Can I Select Another OS During ECS OS Reinstallation? -===================================================== - -No. You can use only the original image of the ECS to reinstall the OS. You need to use a new image if you want to change the OS. For details, see :ref:`Changing the OS `. diff --git a/ecs/umn/result/faqs/os_management/do_ecss_support_gui.rst b/ecs/umn/result/faqs/os_management/do_ecss_support_gui.rst deleted file mode 100644 index 49a5fe4c..00000000 --- a/ecs/umn/result/faqs/os_management/do_ecss_support_gui.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0018078523.html - -.. _en-us_topic_0018078523: - -Do ECSs Support GUI? -==================== - -Windows ECSs are managed through a GUI but Linux ECSs are managed through the CLI. You can configure a GUI if required. - -Before installing a GUI on an ECS, ensure that the idle memory is greater than or equal to 2 GB. Otherwise, the GUI installation may fail or the ECS cannot be started after the installation. diff --git a/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_change_an_ecs_os.rst b/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_change_an_ecs_os.rst deleted file mode 100644 index c94b2b5f..00000000 --- a/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_change_an_ecs_os.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0101604511.html - -.. _en-us_topic_0101604511: - -How Long Does It Take to Change an ECS OS? -========================================== - -Typically, the process of changing the OS of an ECS takes about 1 to 2 minutes. Stop the ECS, click **More** in the **Operation** column, and select **Change OS** from the drop-down list. - -During this process, the ECS is in **Changing OS** state. diff --git a/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_reinstall_an_ecs_os.rst b/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_reinstall_an_ecs_os.rst deleted file mode 100644 index 77689296..00000000 --- a/ecs/umn/result/faqs/os_management/how_long_does_it_take_to_reinstall_an_ecs_os.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0101604512.html - -.. _en-us_topic_0101604512: - -How Long Does It Take to Reinstall an ECS OS? -============================================= - -Typically, the process of reinstalling the OS of an ECS takes about 1 to 2 minutes. Stop the ECS, click **More** in the **Operation** column, and select **Reinstall OS** in the drop-down list. - -During this process, the ECS is in **Reinstalling OS** state. diff --git a/ecs/umn/result/faqs/os_management/index.rst b/ecs/umn/result/faqs/os_management/index.rst deleted file mode 100644 index bc9950e1..00000000 --- a/ecs/umn/result/faqs/os_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0018124788: - -============= -OS Management -============= - -.. toctree:: - :maxdepth: 1 - - can_i_install_or_upgrade_the_os_of_an_ecs - can_i_change_the_os_of_an_ecs - how_long_does_it_take_to_change_an_ecs_os - can_i_select_another_os_during_ecs_os_reinstallation - how_long_does_it_take_to_reinstall_an_ecs_os - do_ecss_support_gui diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_obtain_the_key_pair_used_by_an_ecs.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_obtain_the_key_pair_used_by_an_ecs.rst deleted file mode 100644 index aae25b46..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_obtain_the_key_pair_used_by_an_ecs.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: en-us_topic_0081525053.html - -.. _en-us_topic_0081525053: - -How Can I Obtain the Key Pair Used by an ECS? -============================================= - -Symptom -------- - -You have created multiple key pairs, and you are trying to find the key pair to log in to the target ECS. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, select the target ECS. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Obtain the **Key Pair** value. - - The value is the key pair used by the ECS. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_set_the_validity_period_of_the_image_password.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_set_the_validity_period_of_the_image_password.rst deleted file mode 100644 index de4839f1..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/how_can_i_set_the_validity_period_of_the_image_password.rst +++ /dev/null @@ -1,44 +0,0 @@ -:original_name: en-us_topic_0079176727.html - -.. _en-us_topic_0079176727: - -How Can I Set the Validity Period of the Image Password? -======================================================== - -If an ECS cannot be logged in because of expired image password, you can contact the administrator for handling. - -If the ECS can still be logged in, you can perform the following operations to set the password validity period. - -Procedure ---------- - -The following operations use EulerOS 2.2 as an example. - -#. Log in to the ECS. - -#. Run the following command to check the password validity period: - - **vi /etc/login.defs** - - The value of parameter **PASS_MAX_DAYS** is the password validity period. - -#. Run the following command to change the value of parameter **PASS_MAX_DAYS**: - - **chage -M** *99999 user_name* - - *99999* is the password validity period, and *user_name* is the system user, for example, user **root**. - - .. note:: - - You are advised to configure the password validity period as needed and change it at a regular basis. - -#. Run command **vi /etc/login.defs** to verify that the configuration has taken effect. - - .. _en-us_topic_0079176727__fig36880073194742: - - .. figure:: /_static/images/en-us_image_0079177144.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Configuration verification diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/index.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/index.rst deleted file mode 100644 index 3fd066e6..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _en-us_topic_0105215483: - -======================= -Passwords and Key Pairs -======================= - -.. toctree:: - :maxdepth: 1 - - how_can_i_set_the_validity_period_of_the_image_password - how_can_i_obtain_the_key_pair_used_by_an_ecs - what_should_i_do_if_a_key_pair_cannot_be_imported - why_does_the_login_to_my_linux_ecs_using_a_key_file_fail - why_does_a_key_pair_created_using_puttygen.exe_fail_to_be_imported_on_the_management_console - what_is_the_cloudbase-init_account_in_windows_ecss_used_for - what_should_i_do_if_cloud-init_does_not_work_after_python_is_upgraded diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/what_is_the_cloudbase-init_account_in_windows_ecss_used_for.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/what_is_the_cloudbase-init_account_in_windows_ecss_used_for.rst deleted file mode 100644 index cf4f8f62..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/what_is_the_cloudbase-init_account_in_windows_ecss_used_for.rst +++ /dev/null @@ -1,55 +0,0 @@ -:original_name: en-us_topic_0037633087.html - -.. _en-us_topic_0037633087: - -What Is the **cloudbase-init** Account in Windows ECSs Used for? -================================================================ - -Description ------------ - -In Windows ECSs, **cloudbase-init** is the default account of the Cloudbase-Init agent program. It is used to obtain the metadata and execute configurations when the ECS starts. - -.. note:: - - This account is unavailable on Linux ECSs. - -Do not modify or delete this account or uninstall the Cloudbase-Init agent program. Otherwise, you will be unable to insert data to initialize an ECS created using a Windows private image. - -Security Hardening for Randomized **cloudbase-init** Passwords --------------------------------------------------------------- - -In Cloudbase-Init 0.9.10, the security of randomized **cloudbase-init** passwords has been hardened to ensure that the hash values (LM-HASH and NTLM-HASH) of the passwords are different. - -In Windows, the hash passwords are in the format of "Username:RID:LM-HASH value:NT-HASH value". - -For example, in "Administrator:500:C8825DB10F2590EAAAD3B435B51404EE:683020925C5D8569C23AA724774CE9CC:::", - -- Username: **Administrator** -- RID: **500** -- LM-HASH value: **C8825DB10F2590EAAAD3B435B51404EE** -- NT-HASH value: **683020925C5D8569C23AA724774CE9CC** - -Use an image to create two ECSs, ecs01 and ecs02. Then, verify that the hash values of the **cloudbase-init** account for the two ECSs are different. - -- LM-HASH and NTLM-HASH values of the **cloudbase-init** account for ecs01 - - .. _en-us_topic_0037633087__fig311825713493: - - .. figure:: /_static/images/en-us_image_0202311481.gif - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** ecs01 - -- LM-HASH and NTLM-HASH values of the **cloudbase-init** account for ecs02 - - .. _en-us_topic_0037633087__fig19275102321818: - - .. figure:: /_static/images/en-us_image_0202311491.gif - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** ecs02 diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_a_key_pair_cannot_be_imported.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_a_key_pair_cannot_be_imported.rst deleted file mode 100644 index 21360b73..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_a_key_pair_cannot_be_imported.rst +++ /dev/null @@ -1,21 +0,0 @@ -:original_name: en-us_topic_0019883415.html - -.. _en-us_topic_0019883415: - -What Should I Do If a Key Pair Cannot Be Imported? -================================================== - -If you use Internet Explorer 9 to access the management console, the key pair may fail to import. In this case, perform the following steps to modify browser settings and then try again: - -#. Click |image1| in the upper right corner of the browser. -#. Select **Internet Options**. -#. Click the **Security** tab in the displayed dialog box. -#. Click **Internet**. -#. If the security level indicates **Custom**, click **Default Level** to restore to the default settings. -#. Move the scroll bar to set the security level to **Medium** and click **Apply**. -#. Click **Custom Level**. -#. Set **Initialize and script ActiveX controls not marked as safe for scripting** to **Prompt**. -#. Click **Yes**. - -.. |image1| image:: /_static/images/en-us_image_0146087803.png - diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_cloud-init_does_not_work_after_python_is_upgraded.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_cloud-init_does_not_work_after_python_is_upgraded.rst deleted file mode 100644 index c442ecad..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/what_should_i_do_if_cloud-init_does_not_work_after_python_is_upgraded.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: en-us_topic_0118224527.html - -.. _en-us_topic_0118224527: - -What Should I Do If Cloud-Init Does Not Work After Python Is Upgraded? -====================================================================== - -Symptom -------- - -Take an ECS running CentOS 6.8 as an example. After Python was upgraded from 2.6 to 2.7, Cloud-Init did not work. Data, such as the login password, key, and hostname could not be imported to the ECS using Cloud-Init. - -After the **cloud-init -v** command was executed to view the Cloud-Init version, the system displayed errors, as shown in :ref:`Figure 1 `. - -.. _en-us_topic_0118224527__fig311825713493: - -.. figure:: /_static/images/en-us_image_0123386277.jpg - :alt: **Figure 1** Improper running of Cloud-Init - - - **Figure 1** Improper running of Cloud-Init - -Possible Causes ---------------- - -The Python version used by Cloud-Init was incorrect. - -Solution --------- - -Change the Python version used by Cloud-Init to the source version. To do so, change the environment variable value of **/usr/bin/cloud-init** from the default value **#!/usr/bin/python** to **#!/usr/bin/python2.6**. - -.. _en-us_topic_0118224527__fig11465133314219: - -.. figure:: /_static/images/en-us_image_0123417484.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Changing the Python version diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_a_key_pair_created_using_puttygen.exe_fail_to_be_imported_on_the_management_console.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_a_key_pair_created_using_puttygen.exe_fail_to_be_imported_on_the_management_console.rst deleted file mode 100644 index b8ea2131..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_a_key_pair_created_using_puttygen.exe_fail_to_be_imported_on_the_management_console.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0047654687.html - -.. _en-us_topic_0047654687: - -Why Does a Key Pair Created Using **puttygen.exe** Fail to Be Imported on the Management Console? -================================================================================================= - -Symptom -------- - -When you try to import a key pair that you created using **puttygen.exe** on the management console, the system displays a message indicating that the import failed. - -Possible Causes ---------------- - -The format of the public key content does not meet system requirements. - -If you store a public key by clicking **Save public key** of **puttygen.exe**, the format of the public key content will change. Therefore, you cannot import the key on the management console. - -Solution --------- - -Use the locally stored private key and **PuTTY Key Generator** to restore the format of the public key content. Then, import the public key to the management console. - -#. Double-click **puttygen.exe** to switch to the **PuTTY Key Generator** page. - - .. _en-us_topic_0047654687__en-us_topic_0014250631_en-us_topic_0037960038_fig4490538015580: - - .. figure:: /_static/images/en-us_image_0272917695.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** PuTTY Key Generator - -#. Click **Load** and select the private key. - - The system automatically loads the private key and restores the format of the public key content in **PuTTY Key Generator**. The content in the red box in :ref:`Figure 2 ` is the public key whose format meets system requirements. - - .. _en-us_topic_0047654687__fig5530274016810: - - .. figure:: /_static/images/en-us_image_0037982934.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Restoring the format of the public key content - -#. Copy the public key content to a .txt file and save the file in a local directory. - -#. Import the public key to the management console. - - a. Log in to the management console. - b. Click |image1| in the upper left corner and select your region and project. - c. Under **Computing**, click **Elastic Cloud Server**. - d. In the navigation pane on the left, choose **Key Pair**. - e. On the right side of the page, click **Import Key Pair**. - f. Copy the public key content in the .txt file to **Public Key Content** and click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_the_login_to_my_linux_ecs_using_a_key_file_fail.rst b/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_the_login_to_my_linux_ecs_using_a_key_file_fail.rst deleted file mode 100644 index 5c4d5762..00000000 --- a/ecs/umn/result/faqs/passwords_and_key_pairs/why_does_the_login_to_my_linux_ecs_using_a_key_file_fail.rst +++ /dev/null @@ -1,36 +0,0 @@ -:original_name: en-us_topic_0031734664.html - -.. _en-us_topic_0031734664: - -Why Does the Login to My Linux ECS Using a Key File Fail? -========================================================= - -Symptom -------- - -When you use the key file created during your Linux ECS creation to log in to the ECS, the login fails. - -Possible Causes ---------------- - -Possible causes vary depending on the image used to create the Linux ECS. - -- Cause 1: The image that you used to create the Linux ECS is a private image, on which Cloud-Init is not installed. -- Cause 2: Cloud-Init is installed on the image, but you did not obtain the key pair when you created the ECS. - -Solution --------- - -- If the issue is a result of cause 1, proceed as follows: - - If you created a private image without installing Cloud-Init, you cannot customize the ECS configuration. As a result, you can log in to the ECS only using the original image password or key pair. - - The original image password or key pair is the OS password or key pair you configured when you created the private image. - -- If the issue is a result of cause 2, proceed as follows: - - #. Locate the row containing the target ECS, click **More** in the **Operation** column, and select **Restart**. - #. Use the key file to log in to the ECS again and check whether the login is successful. - - - If the login is successful, no further action is required. - - If the login fails, contact customer service for technical support. diff --git a/ecs/umn/result/faqs/resource_management_and_tags/how_can_i_create_and_delete_tags_and_search_for_ecss_by_tag.rst b/ecs/umn/result/faqs/resource_management_and_tags/how_can_i_create_and_delete_tags_and_search_for_ecss_by_tag.rst deleted file mode 100644 index 0d55e891..00000000 --- a/ecs/umn/result/faqs/resource_management_and_tags/how_can_i_create_and_delete_tags_and_search_for_ecss_by_tag.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: en-us_topic_0101604501.html - -.. _en-us_topic_0101604501: - -How Can I Create and Delete Tags and Search for ECSs by Tag? -============================================================ - -Creating a Tag --------------- - -#. Log in to the management console. - -#. Select the region where the ECS is located. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click **Tags** and then **Add Tag**. - -#. Enter the tag key and value, and click **OK**. - -Searching for ECSs by Tag -------------------------- - -#. Log in to the management console. -#. Select the region where the ECS is located. -#. On the **Elastic Cloud Server** page, search for ECSs by tag. -#. In the search bar, select **Tag** and then the tag key and value, and click **OK**. - -Deleting a Tag --------------- - -#. Log in to the management console. -#. Select the region where the ECS is located. -#. Click **Elastic Cloud Server**. -#. Click the name of the target ECS. -#. On the page providing details about the ECS, click **Tags**, locate the row containing the target tag, and click **Delete** in the **Operation** column. diff --git a/ecs/umn/result/faqs/resource_management_and_tags/index.rst b/ecs/umn/result/faqs/resource_management_and_tags/index.rst deleted file mode 100644 index 5c169313..00000000 --- a/ecs/umn/result/faqs/resource_management_and_tags/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0208809315: - -============================ -Resource Management and Tags -============================ - -.. toctree:: - :maxdepth: 1 - - how_can_i_create_and_delete_tags_and_search_for_ecss_by_tag diff --git a/ecs/umn/result/faqs/resource_monitoring/index.rst b/ecs/umn/result/faqs/resource_monitoring/index.rst deleted file mode 100644 index 152ed69e..00000000 --- a/ecs/umn/result/faqs/resource_monitoring/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0208809316: - -=================== -Resource Monitoring -=================== - -.. toctree:: - :maxdepth: 1 - - why_is_my_windows_ecs_running_slowly - why_is_my_linux_ecs_running_slowly diff --git a/ecs/umn/result/faqs/resource_monitoring/why_is_my_linux_ecs_running_slowly.rst b/ecs/umn/result/faqs/resource_monitoring/why_is_my_linux_ecs_running_slowly.rst deleted file mode 100644 index f8f12e8b..00000000 --- a/ecs/umn/result/faqs/resource_monitoring/why_is_my_linux_ecs_running_slowly.rst +++ /dev/null @@ -1,200 +0,0 @@ -:original_name: en-us_topic_0167429329.html - -.. _en-us_topic_0167429329: - -Why Is My Linux ECS Running Slowly? -=================================== - -If your Linux ECS runs slowly or is inaccessible unexpectedly, the bandwidth or vCPU usage of the ECS may be excessively high. If you have created an alarm rule using Cloud Eye, the system automatically sends an alarm to you when the bandwidth or CPU usage reaches the threshold specified in the rule. - -To handle this issue, perform the following operations: - -#. Fault locating - - Identify the processes leading to high bandwidth or CPU usage. - -2. Troubleshooting - - Check whether the processes are malicious and handle the issue accordingly. - - - If the processes are not malicious, optimize their programs or modify ECS specifications. - - If the processes are malicious, use a third-party tool to automatically stop the processes or manually stop them. - -Common Commands ---------------- - -The following uses the CentOS 7.2 64bit OS as an example to describe common commands. The commands may vary depending on Linux OS editions. For details, see the official documentation for the specific OS edition. - -The common commands for checking Linux ECS performance metrics, such as CPU usage are as follows: - -- **ps -aux** -- **ps -ef** -- **top** - -Locating High CPU Usage ------------------------ - -#. Log in to the ECS using VNC. - -#. Run the following command to check the OS running status: - - **top** - - Information similar to the following is displayed. - - |image1| - -#. View the command output. - - - The first line in the command output is "20:56:02 up 37 days, 1 user, load average: 0.00, 0.01, 0.05", indicating that: - - The current system time is 20:56:02; the ECS has been running for 37 days; there is one login user; the last three values indicate the average CPU load in the last 1 minute, 5 minutes, and 15 minutes, respectively. - - - The third line in the command output shows the overall CPU usage. - - - The fourth line in the command output shows the overall memory usage. - - - The lower part of the command output shows the resource usage of each process. - - .. note:: - - a. On the **top** page, enter **q** or press **Ctrl+C** to exit. - - b. Alternatively, click **Input Command** in the upper right corner of the VNC login page, paste or enter commands in the displayed dialog box, and click **Send**. - - c. Common parameters in top commands are as follows: - - **s**: Change the image update frequency. - - **l**: Show or hide the first line for the top information. - - **t**: Show or hide the second line for tasks and the third line for CPUs. - - **m**: Show or hide the fourth line for Mem and the fifth line for Swap. - - **N**: Sort processes by PID in ascending or descending order. - - **P**: Sort processes by CPU usage in ascending or descending order. - - **M**: Sort processes by memory usage in ascending or descending order. - - **h**: Show help for commands. - - **n**: Set the number of processes displayed in the process list. - -#. Run the **ll /proc/**\ *PID*\ **/exe** command to obtain the program file specified by a PID. - - |image2| - -Troubleshooting High CPU Usage ------------------------------- - -If the processes leading to high CPU usage are malicious, run the top command to stop them. If the **kswapd0** process leads to high CPU usage, optimize the program for the process or upgrade the ECS specifications for a larger memory capacity. - -**kswapd0** is a virtual memory management process. When the physical memory becomes insufficient, **kswapd0** runs to allocate disk swap capacity for caching. This uses a large number of CPU resources. - -- For the detected malicious processes - - Quickly stop such processes on the top page. To do so, perform the following operations: - - #. Press the **k** key during the execution of the top command. - - #. Enter the PID of the process to be stopped. - - The PID of the process is the value in the first column of the top command output. For example, to stop the process with PID 52, enter **52** and press **Enter**. - - |image3| - - #. After the operation is successful, information similar to the following is displayed. Press **Enter**. - - |image4| - -- For the **kswapd0** process - - To check the memory usage of a process, perform the following operations: - - #. Run the top command to check the resource usage of the **kswapd0** process. - - #. If the process remains in non-sleeping state for a long period of time, you can preliminarily determine that the system is consistently paging. In such a case, the high CPU usage is caused by insufficient memory. - - |image5| - - #. Run the **vmstat** command to check the virtual memory usage of the system. - - If the **si** and **so** values are large, the system is frequently paging and the physical memory of the system is insufficient. - - - **si**: Volume of data written from the swap partition to the memory per second, which is transferred from the disk to the memory. - - **so**: Volume of data written from the memory to the swap partition per second, which is transferred from the memory to the disk. - - #. Further identify the causes of high memory usage. Run commands, such as **free** and **ps** to check the memory usage of the system and processes in the system. - - #. Restart the application or release the memory when traffic is light. - - To handle this issue, expand the ECS memory. If memory expansion is not allowed, optimize the application and enable hugepage memory. - -Handling High Bandwidth Usage ------------------------------ - -If the high bandwidth usage is caused by normal service access of non-malicious processes, enlarge the bandwidth to handle this issue. If the high bandwidth usage is caused by abnormal service access, for example, malicious access from certain IP addresses, CC attacks on the ECS, or malicious processes, use the traffic monitoring tool **nethogs** to monitor the bandwidth usage of each process in real time and identify faulty processes. - -- Using **nethogs** for troubleshooting - - #. Run the following command to install **nethogs**: - - **yum install nethogs -y** - - After the installation, run the **netgos** command to check bandwidth usage. - - Parameters in the **nethogs** command are as follows: - - - **-d**: Set the update interval in the unit of second. The default value is **1**. - - **-t**: Enable tracing. - - **-c**: Set the number of updates. - - **device**: Set the NIC to be monitored. The default value is **eth0**. - - The following parameters are involved in command execution: - - - **q**: Exit **nethogs**. - - **s**: Sort processes in the process list by TX traffic in ascending or descending order. - - **r**: Sort processes in the process list by RX traffic in ascending or descending order. - - **m**: Switch the display unit in the sequence of KB/s, KB, B, and MB. - - #. Run the following command to check the bandwidth usage of each process on the specified NIC: - - **nethogs** **eth1** - - |image6| - - The parameters in the command output are as follows: - - - **PID**: ID of the process. - - **USER**: user who runs the process. - - **PROGRAM**: IP addresses and port numbers of the process and connection, respectively. The former is for the server and the latter is for the client. - - **DEV**: Network port to which the traffic is destined. - - **SENT**: Volume of data sent by the process per second. - - **RECEIVED**: Volume of data received by the process per second. - - #. Stop malicious programs or blacklist malicious IP addresses. - - To stop a malicious process, run the **kill** *PID* command. - - To blacklist a malicious IP address or limit its rate, use iptables. - -.. |image1| image:: /_static/images/en-us_image_0166736726.png - :class: imgResize - -.. |image2| image:: /_static/images/en-us_image_0166945975.png - :class: imgResize - -.. |image3| image:: /_static/images/en-us_image_0166947771.png - :class: imgResize - -.. |image4| image:: /_static/images/en-us_image_0166947775.png - :class: imgResize - -.. |image5| image:: /_static/images/en-us_image_0167110971.png - :class: imgResize - -.. |image6| image:: /_static/images/en-us_image_0167295759.png - :class: imgResize - diff --git a/ecs/umn/result/faqs/resource_monitoring/why_is_my_windows_ecs_running_slowly.rst b/ecs/umn/result/faqs/resource_monitoring/why_is_my_windows_ecs_running_slowly.rst deleted file mode 100644 index af83fbf9..00000000 --- a/ecs/umn/result/faqs/resource_monitoring/why_is_my_windows_ecs_running_slowly.rst +++ /dev/null @@ -1,95 +0,0 @@ -:original_name: en-us_topic_0167429328.html - -.. _en-us_topic_0167429328: - -Why Is My Windows ECS Running Slowly? -===================================== - -If your Windows ECS runs slowly or is inaccessible unexpectedly, the bandwidth or vCPU usage of the ECS may be excessively high. If you have created an alarm rule using Cloud Eye, the system automatically sends an alarm to you when the bandwidth or CPU usage reaches the threshold specified in the rule. - -To handle this issue, perform the following operations: - -#. Fault locating - - Identify the processes leading to high bandwidth or CPU usage. - - Windows offer multiple tools to locate faults, including Task Manager, Performance Monitor, Resource Monitor, Process Explorer, Xperf (supported by versions later than Windows Server 2008), and full memory dump analysis. - -2. Troubleshooting - - Check whether the processes are malicious and handle the issue accordingly. - - - If the processes are not malicious, optimize them or modify ECS specifications. - - If the processes are malicious, stop these processes manually or use a third-party tool to stop them automatically. - -Fault Locating --------------- - -#. Log in to the ECS using VNC available on the management console. - -#. Start the **Run** dialog box, and then enter **perfmon -res**. - - .. _en-us_topic_0167429328__en-us_topic_0166311836_fig18932134871212: - - .. figure:: /_static/images/en-us_image_0281771106.png - :alt: **Figure 1** Starting the Resource Monitor - - - **Figure 1** Starting the Resource Monitor - -#. On the **Resource Monitor** page, click the **CPU** or **Network** tab to view the CPU or bandwidth usage. - - .. _en-us_topic_0167429328__en-us_topic_0166311836_fig42857506323: - - .. figure:: /_static/images/en-us_image_0281773972.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Resource Monitor - -#. Obtain the IDs and names of the processes with high CPU or bandwidth usage. - -#. On the remote login page, click **Ctrl+Alt+Del** to start the **Windows Task Manager**. - - Alternatively, start the **Run** dialog box and enter **taskmgr** to start the **Windows Task Manager**. - - The following describes how to display PIDs in **Windows Task Manager**, locate a process, and check whether it is malicious. - - a. Click the **Details** tab. - - b. Click **PID** to sort the data. - - c. Right-click the process with high CPU or bandwidth usage and choose **Open File Location** from the shortcut menu. - - d. Check whether the process is malicious. - - .. _en-us_topic_0167429328__en-us_topic_0166311836_fig138318464320: - - .. figure:: /_static/images/en-us_image_0281775402.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Checking the process - -Troubleshooting ---------------- - -Before the troubleshooting, check whether the process leading to the high CPU or bandwidth usage is malicious, and then take measures accordingly. - -**Suggestions for non-malicious processes** - -#. If your ECS runs Windows Server 2008 or 2012, ensure that the available memory is 2 GB or larger. -#. Check whether Windows Update is running on the backend. -#. Check whether the antivirus software is running scan tasks on the backend. -#. Check whether any applications requiring high CPU or bandwidth are running on the ECS. If so, modify ECS specifications or enlarge bandwidth. -#. If the ECS configuration meets the application requirements, deploy applications separately. For example, deploy the database and applications separately. - -**Suggestions for malicious processes** - -If the high CPU or bandwidth usage is caused by viruses or Trojan horses, manually stop the affected processes. You are advised to troubleshoot the issue as follows: - -#. Use the commercial-edition antivirus software or install `Microsoft Safety Scanner `__ to scan for viruses in security mode. -#. Install the latest patches for Windows. -#. Run **MSconfig** to disable all drivers that are not delivered with Microsoft and check whether the fault is rectified. For details, see `How to perform a clean boot in Windows `__. diff --git a/ecs/umn/result/getting_started/creating_an_ecs/index.rst b/ecs/umn/result/getting_started/creating_an_ecs/index.rst deleted file mode 100644 index c363b4ab..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0021831611: - -=============== -Creating an ECS -=============== - -.. toctree:: - :maxdepth: 1 - - overview - step_1_configure_basic_settings - step_2_configure_network - step_3_configure_advanced_settings - step_4_confirm diff --git a/ecs/umn/result/getting_started/creating_an_ecs/overview.rst b/ecs/umn/result/getting_started/creating_an_ecs/overview.rst deleted file mode 100644 index c2f36221..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/overview.rst +++ /dev/null @@ -1,18 +0,0 @@ -:original_name: en-us_topic_0163572588.html - -.. _en-us_topic_0163572588: - -Overview -======== - -Scenarios ---------- - -ECSs are more cost-effective than physical servers. Within minutes, you can obtain ECS resources from the public cloud. ECS resources are flexible and on-demand. This section describes how to create an ECS on the management console. - -**Creation process:** - -- :ref:`Step 1: Configure Basic Settings ` -- :ref:`Step 2: Configure Network ` -- :ref:`Step 3: Configure Advanced Settings ` -- :ref:`Step 4: Confirm ` diff --git a/ecs/umn/result/getting_started/creating_an_ecs/step_1_configure_basic_settings.rst b/ecs/umn/result/getting_started/creating_an_ecs/step_1_configure_basic_settings.rst deleted file mode 100644 index 8d3999d1..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/step_1_configure_basic_settings.rst +++ /dev/null @@ -1,166 +0,0 @@ -:original_name: en-us_topic_0163572589.html - -.. _en-us_topic_0163572589: - -Step 1: Configure Basic Settings -================================ - -Accessing the ECS Creation Page -------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click **Create ECS**. - - The page for creating ECSs is displayed. - - .. note:: - - SAP High-Performance Analytic Appliance (HANA) is a high-performance real-time data computing platform based on memory computing technologies. The public cloud provides high-performance IaaS services that comply with SAP HANA requirements. These services help you rapidly request for SAP HANA resources (such as applying for HANA ECSs and public IP addresses) and install and configure SAP HANA, therefore improving your operation efficiency, reducing operation costs, and enhancing your experience. - - HANA ECSs are dedicated for SAP HANA. If you want to deploy SAP HANA on cloud servers, create HANA ECSs. - - For more information about HANA ECS application scenarios and creation methods, see *SAP HANA User Guide*. - -Performing Basic Configurations -------------------------------- - -#. Select an AZ. - - An AZ is a physical location that uses independent power supply and networks. AZs in the same region can communicate with each other over an intranet. - - - To enhance application availability, create ECSs in different AZs. - - To shorten network latency, create ECSs in the same AZ. - - .. note:: - - Random AZ allocation is available on the console when you create an ECS. The system will use a hash algorithm to select a default AZ based on your universally unique identifier (UUID). - - The released ECS types and flavors vary depending on AZs. To view all supported ECS types and flavors on the cloud service platform, set **AZ** to **Random**. Then, the system automatically allocates an AZ according to your selected ECS flavor. - - For example, S3 ECSs are available only in AZ 1; S2 ECSs are available in AZ 2 and AZ 3 and have been sold out in AZ 1. If you set **AZ** to **Random**, you can view both S3 and S2 ECSs. If you create an S3 ECS, the system automatically allocates it to AZ 1. If you create an S2 ECS, the system randomly allocates it to AZ 2 or AZ 3. - -#. Set **DeH**. - - This configuration is optional. This parameter is available only when you click **Create ECS** on the **Dedicated Host** page. It is unavailable when you click **Create ECS** on the **Elastic Cloud Server** page. - - DeH refers to physical server resources dedicated for a specified user. You can deploy ECSs on DeHs for better isolation, security, and performance of your ECSs. You can continue using your existing server software licenses of ECSs on DeHs to reduce costs. For more details, see *Dedicated Host User Guide*. - - .. note:: - - If you select a SUSE-SAP public image when creating an ECS on a DeH, you will be billed for the license. - -#. Set **Specifications**. - - The public cloud provides various ECS types for different application scenarios. You can choose from existing ECS types and flavors in the list. Alternatively, you can enter a flavor (such as c3) or specify vCPUs and memory size to search for the flavor suited to your needs. - - **Latest generation** shows the types and flavors of newly released ECSs, and **All generations** show the types and flavors of all ECSs provided by the public cloud. - - .. note:: - - - Before selecting an ECS type, learn the introduction and notes on each type of ECSs. For details, see :ref:`ECS Types `. - - - **Local Disk**: specifies the local storage of the physical server where the ECS is deployed. Only Hard Disk Driver (HDD) disks are supported. If the ECS of the selected type (such as **Disk-intensive**) uses local disks, the system automatically attaches the local disks to the ECS and displays the information of the local disks. - - For example, if **Local Disk** is **3x1800 GiB (HDD)**, three HDDs are attached to the ECS and the capacity of each HDD is 1800 GiB. - -#. Select an image. - - - Public image - - A public image is a standard, widely used image. It contains an OS and preinstalled public applications and is available to all users. You can configure the runtime environment or software in the public image as needed. - - If you select a SUSE-SAP public image, you will be billed for the license. - - For more information about public images, see `Public Images Introduction `__. - - - Private image - - A private image is an image available only to the user who created it. It contains an OS, preinstalled public applications, and the user's private applications. Using a customized private image, you can create ECSs tailored to your needs in batches. - - You can also select an encrypted image. For details, see *Image Management Service User Guide*. - - .. note:: - - - If you use a full-ECS image to create an ECS, the EVS disks associated with the full-ECS image do not support the function of creating disks using a data disk image. - - - If a full-ECS image is in **Normal** state and the system displays message "Available in AZ\ *x*", the full-ECS image can be used to create ECSs in this AZ only, and the encryption attributes of the system and data disks of the created ECSs are the same as those of the system and data disks specified in the full-ECS image. Additionally, the SCSI, sharing attribute, and data encryption settings of the system and data disks cannot be modified during ECS creation. - - - If a full-ECS image is in **Normal** state but the system does not display message "Available in AZ\ *x*", the full-ECS image can be used to create ECSs in the entire region, and the encryption attributes of the system and data disks of the created ECSs are the same as those of the system and data disks specified in the full-ECS image. Additionally, the data encryption settings of the system disk, and the SCSI, sharing attribute, and data encryption settings of data disks can be modified during ECS creation. - - - To ensure that NIC multi-queue is enabled on an ECS created using a private image, configure NIC multi-queue when creating such a private image. NIC multi-queue routes NIC interrupt requests among multiple vCPUs for higher network PPS and bandwidth. - - For details, see "How Do I Set NIC Multi-Queue Feature of an Image?" - - - Shared image - - A shared image is a private image shared by another user. - -#. (Optional) Set **License Type**. - - Specifies a license type for using an OS or software. This parameter is displayed only when the selected image is billed. - - - Using License from the System - - Allows you to use the license provided by the public cloud platform. Obtaining the authorization of such a license is billed. - - - Bring your own license (BYOL) - - Allows you to use your existing OS license. In such a case, you do not need to apply for a license again. - - For more details, see :ref:`License Type `. - -#. Set **System Disk** and **Data Disk** if required. - - - System disk - - For the disk types supported by an ECS, see :ref:`EVS Disks `. - - - If the image based on which an ECS is created is not encrypted, the system disk of the ECS is not encrypted. If the image based on which an ECS is created is encrypted, the system disk of the ECS is automatically encrypted. For details, see :ref:`(Optional) Encryption-related parameters `. - - **Encryption**: indicates that the system disk is encrypted if you select this option. For details, see :ref:`(Optional) Encryption-related parameters `. - - For a P1 or P2 ECS, the system disk must be greater than or equal to 15 GB. It is recommended that the system disk be greater than 40 GB. A disk size must be an integer multiple of 10, for example, 60 GB or 70 GB. Otherwise, the system automatically rounds the value down, for example, 60 GB for value **68**. - - - Data disk - - You can create multiple data disks for an ECS and enable required functions for each data disk. When creating an ECS, you can add up to 24 disks with customized sizes to it. After the ECS is created, you can add up to 60 disks to it. - - Click |image2| and set the following functions if required: - - - **SCSI**: indicates that the device type of the data disk is SCSI if you select this option. For more information about SCSI disks and the ECSs that can be attached with SCSI disks, see :ref:`EVS Disks `. - - - **Share**: indicates that the EVS disk is sharable if you select this option. Such an EVS disk can be attached to multiple ECSs. - - - **Encryption**: indicates that the data disk is encrypted if you select this option. For details, see :ref:`(Optional) Encryption-related parameters `. - - - **Create Disk from Data Disk Image**: If you have created a data disk image on the **Image Management Service** page, when using a Windows or Linux image to create an ECS, you can use the data disk image to create data disks for the ECS. - - Click **Create Disk from Data Disk Image**. In the dialog box that is displayed, select your data disk image. - - .. note:: - - - One data disk image can be used for one data disk only. - - When you use a data disk image to create a disk, **SCSI**, **Encryption**, and **Share** are unavailable. - - For instructions about how to create a data disk image, see *Image Management Service User Guide*. - - - .. _en-us_topic_0163572589__en-us_topic_0144542112_li3286101316615: - - (Optional) Encryption-related parameters - - To enable encryption, click **Create Xrole** to assign KMS access permissions to EVS. If you have rights granting permission, assign the KMS access permissions to EVS. If you do not have the permission, contact the user having the security administrator rights to assign the KMS access permissions. For more details, see :ref:`Can All Users Use the Encryption Feature? ` - - - **Encryption**: indicates that the EVS disk has been encrypted. - - **Create Xrole**: assigns KMS access permissions to EVS to obtain KMS keys. After the permissions are assigned, follow-up operations do not require assigning permissions again. - - **KMS Key Name**: specifies the name of the key used by the encrypted EVS disk. You can select an existing key, or click **Create KMS Key** and create a new one on the KMS console. The default value is **evs/default**. - - **Xrole Name: EVSAccessKMS**: specifies that permissions have been assigned to EVS to obtain KMS keys for encrypting or decrypting EVS disks. - - **KMS Key ID**: specifies the ID of the key used by the encrypted data disk. - -#. Click **Next: Configure Network**. - -.. |image1| image:: /_static/images/en-us_image_0171575801.png - -.. |image2| image:: /_static/images/en-us_image_0000001208978003.png - diff --git a/ecs/umn/result/getting_started/creating_an_ecs/step_2_configure_network.rst b/ecs/umn/result/getting_started/creating_an_ecs/step_2_configure_network.rst deleted file mode 100644 index 93a06c33..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/step_2_configure_network.rst +++ /dev/null @@ -1,76 +0,0 @@ -:original_name: en-us_topic_0163572590.html - -.. _en-us_topic_0163572590: - -Step 2: Configure Network -========================= - -Network Configurations ----------------------- - -#. Set **Network** by selecting an available VPC and subnet from the drop-down list and specifying a private IP address assignment mode. - - VPC provides a dedicated network for your ECS. A VPC can contain subnets for further isolation. You can configure security groups per subnet to control access to cloud resources. - - You can select an existing VPC or create a new one. - - For more information about VPC, see *Virtual Private Cloud User Guide*. - - .. note:: - - - Ensure that DHCP is enabled in the VPC to which the ECS belongs. - - When you use VPC for the first time, the system automatically creates a VPC for you, including the security group and NIC. - -#. (Optional) Add an extension NIC. You can add multiple extension NICs to an ECS and specify IP addresses for them (including primary NICs). - - .. note:: - - If you specify an IP address for a NIC when creating multiple ECSs in a batch: - - - This IP address serves as the start IP address. - - Ensure that the IP addresses required by the NICs are within the subnet, consecutive, and available. - - The subnet with the specified IP address cannot overlap with other subnets. - - - **MTU Settings**: This parameter is optional. - - If your ECS is of M2 or large-memory type, you can click **MTU Settings** to configure the maximum transmission unit (MTU) for a to-be-added extension NIC for improving network performance. An MTU can only be a number, ranging from 1280 to 8888. - -#. Set **Security Group** by selecting an available security group from the drop-down list or creating a new one. - - A security group controls ECS access within or between security groups by defining access rules. This enhances ECS security. - - When creating an ECS, you can select multiple (recommended not more than five) security groups. In such a case, the access rules of all the selected security groups apply on the ECS. - - .. note:: - - Before initializing an ECS, ensure that the security group rules for the outbound direction meet the following requirements: - - - **Protocol**: **TCP** - - **Port Range**: **80** - - **Remote End**: **169.254.0.0/16** - - If you use the default security group rules for the outbound direction, the preceding requirements are met, and the ECS can be initialized. The default security group rules for the outbound direction are as follows: - - - **Protocol**: **ANY** - - **Port Range**: **ANY** - - **Remote End**: **0.0.0.0/16** - -#. Set **EIP**. - - An EIP is a static public IP address bound to an ECS in a VPC. Using the EIP, the ECS provides services externally. - - The following options are provided: - - - Do not use - - Without an EIP, the ECS cannot access the Internet and is used in the private network or cluster only. - - - Auto assign - - The system automatically assigns an EIP for the ECS. The EIP provides a dedicated bandwidth that is configurable. - - - Specify - - An existing EIP is assigned for the ECS. When using an existing EIP, you are not allowed to create ECSs in a batch. - -#. Click **Next: Configure Advanced Settings**. diff --git a/ecs/umn/result/getting_started/creating_an_ecs/step_3_configure_advanced_settings.rst b/ecs/umn/result/getting_started/creating_an_ecs/step_3_configure_advanced_settings.rst deleted file mode 100644 index 4ad0300e..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/step_3_configure_advanced_settings.rst +++ /dev/null @@ -1,69 +0,0 @@ -:original_name: en-us_topic_0163572591.html - -.. _en-us_topic_0163572591: - -Step 3: Configure Advanced Settings -=================================== - -Advanced Settings ------------------ - -#. Set **ECS Name**. - - The name can be customized but can contain only letters, digits, underscores (_), hyphens (-), and periods (.). - - If you want to create multiple ECSs at a time, the system automatically sequences these ECSs. - - The **ECS Name** set in this step will be the initial host name in the ECS OS. - - .. note:: - - Consecutive periods (.) or hyphens (-) will be replaced with the first character to prevent unknown issues. - -#. (Optional) Specify the description of the ECS. - -#. Set **Login Mode**. - - **Key pair**: allows you to use a key pair for login authentication. You can select an existing key pair, or click **Create Key Pair** and create a desired one. - - .. note:: - - If you use an existing key pair, make sure that you have saved the key file locally. Otherwise, logging in to the ECS will fail. - -#. Set **ECS Group**. - - An ECS group applies the anti-affinity policy to the ECSs in it so that the ECSs are automatically allocated to different hosts. This configuration is optional. For instructions about how to create an ECS group, see :ref:`Managing ECS Groups `. - - .. note:: - - An existing ECS attached with a local disk cannot be added to an ECS group. To use ECS group functions, select an ECS group when creating an ECS. - -#. To use functions listed in **Advanced Options**, select **Configure now**. Otherwise, do not select it. - - - User Data - - You can specify the user data. The user data will be automatically passed to the ECS when the ECS starts for the first time. This configuration is optional. - - For example, if you activate user **root** permission by passing a script, you can log in to the ECS as user **root**. - - For details, see :ref:`Passing User Data to ECSs `. - - - Tag - - Tagging an ECS to facilitate ECS identification and management. This configuration is optional. You can add up to 10 tags to an ECS. - - .. note:: - - Tags added during ECS creation will also be added to the created EIP and EVS disks (including the system disk and data disks) of the ECS. If the ECS uses an existing EIP, the tags will not be added to the EIP. - - After creating the ECS, you can view the tags on the pages providing details about the ECS, EIP, and EVS disks. - - For detailed operations, see :ref:`Overview `. - - - Agency - - This configuration is optional. When your ECS resources need to be shared with other accounts, or your ECS is delegated to professional personnel or team for management, the tenant administrator creates an agency in IAM and grants the ECS management permissions to the personnel or team. The delegated account can log in to the cloud system and switch to your account to manage resources. You do not need to share security credentials (such as passwords) with other accounts, ensuring the security of your account. - - If you have created an agency in IAM, you can select the agency from the drop-down list and obtain specified operation permissions. For instructions about how to create an agency, see *Identity and Access Management User Guide*. - -#. Click **Next: Confirm**. diff --git a/ecs/umn/result/getting_started/creating_an_ecs/step_4_confirm.rst b/ecs/umn/result/getting_started/creating_an_ecs/step_4_confirm.rst deleted file mode 100644 index ae8cf284..00000000 --- a/ecs/umn/result/getting_started/creating_an_ecs/step_4_confirm.rst +++ /dev/null @@ -1,30 +0,0 @@ -:original_name: en-us_topic_0163572592.html - -.. _en-us_topic_0163572592: - -Step 4: Confirm -=============== - -Confirming the Order --------------------- - -#. On the **Confirm** page, view details about the ECS configuration. - - To learn more about the price, click **Pricing details**. - -#. Set the number of ECSs to be created. - - After the configuration, click **Price Calculator** to view the ECS configuration fee. - -#. Confirm the configuration and click **Create Now**. - -Follow-up Procedure -------------------- - -- After an ECS with an EIP bound is created, the system automatically generates a reverse domain name in the format of "ecs-xx-xx-xx-xx.compute.xxx.com" for each EIP by default. In the format, "xx-xx-xx-xx" indicates the EIP, and "xxx" indicates the domain name of the cloud service provider. You can use the reverse domain name to access the ECS. - - Use one of the following commands to obtain the default reverse domain name of an EIP: - - - ping -a *EIP* - - nslookup [-qt=ptr] *EIP* - - dig -x *EIP* diff --git a/ecs/umn/result/getting_started/index.rst b/ecs/umn/result/getting_started/index.rst deleted file mode 100644 index 363b7739..00000000 --- a/ecs/umn/result/getting_started/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0013771105: - -=============== -Getting Started -=============== - -.. toctree:: - :maxdepth: 1 - - creating_an_ecs/index - logging_in_to_an_ecs - initializing_evs_data_disks/index diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/index.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/index.rst deleted file mode 100644 index dd1aee3b..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0030831989: - -=========================== -Initializing EVS Data Disks -=========================== - -.. toctree:: - :maxdepth: 1 - - scenarios_and_disk_partitions - initializing_a_windows_data_disk_windows_server_2008 - initializing_a_windows_data_disk_windows_server_2016 - initializing_a_linux_data_disk_fdisk - initializing_a_linux_data_disk_parted diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_fdisk.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_fdisk.rst deleted file mode 100644 index 74418d11..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_fdisk.rst +++ /dev/null @@ -1,353 +0,0 @@ -:original_name: en-us_topic_0085634797.html - -.. _en-us_topic_0085634797: - -Initializing a Linux Data Disk (fdisk) -====================================== - -Scenarios ---------- - -This section uses CentOS 7.4 64bit to describe how to initialize a data disk attached to a server running Linux and use fdisk to partition the data disk. - -The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. In Linux, if you choose to use the GPT partition style, the fdisk partitioning tool cannot be used. Use the parted partitioning tool instead. For details about disk partition styles, see :ref:`Scenarios and Disk Partitions `. - -The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS. - -Prerequisites -------------- - -- A data disk has been attached to a server and has not been initialized. -- You have logged in to the server. - - - For how to log in to an ECS, see the *Elastic Cloud Server User Guide*. - - For how to log in to a BMS, see the *Bare Metal Server User Guide*. - -Creating and Mounting a Partition ---------------------------------- - -The following example shows you how a new primary partition can be created on a new data disk that has been attached to a server. The primary partition will be created using fdisk, and MBR is the default partition style. Furthermore, the partition will be formatted using the ext4 file system, mounted on **/mnt/sdc**, and configured with automatic mounting at system start. - -#. Run the following command to query information about the new data disk: - - **fdisk -l** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# fdisk -l - - Disk /dev/vda: 42.9 GB, 42949672960 bytes, 83886080 sectors - Units = sectors of 1 * 512 = 512 bytes - Sector size (logical/physical): 512 bytes / 512 bytes - I/O size (minimum/optimal): 512 bytes / 512 bytes - Disk label type: dos - Disk identifier: 0x000bcb4e - - Device Boot Start End Blocks Id System - /dev/vda1 * 2048 83886079 41942016 83 Linux - - Disk /dev/vdb: 107.4 GB, 107374182400 bytes, 209715200 sectors - Units = sectors of 1 * 512 = 512 bytes - Sector size (logical/physical): 512 bytes / 512 bytes - I/O size (minimum/optimal): 512 bytes / 512 bytes - - In the command output, the server contains two disks. **/dev/vda** is the system disk, and **/dev/vdb** is the new data disk. - -#. Run the following command to enter fdisk to partition the new data disk: - - **fdisk** *New data disk* - - In this example, run the following command: - - **fdisk /dev/vdb** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# fdisk /dev/vdb - Welcome to fdisk (util-linux 2.23.2). - - Changes will remain in memory only, until you decide to write them. - Be careful before using the write command. - - Device does not contain a recognized partition table - Building a new DOS disklabel with disk identifier 0x38717fc1. - - Command (m for help): - -#. Enter **n** and press **Enter** to create a new partition. - - Information similar to the following is displayed: - - .. code-block:: - - Command (m for help): n - Partition type: - p primary (0 primary, 0 extended, 4 free) - e extended - - There are two types of disk partitions: - - - Choosing **p** creates a primary partition. - - Choosing **e** creates an extended partition. - - .. note:: - - If the MBR partition style is used, a maximum of 4 primary partitions, or 3 primary partitions and 1 extended partition can be created. The extended partition cannot be used directly and must be divided into logical partitions before use. - - Disk partitions created using GPT are not categorized. - -#. In this example, a primary partition is created. Therefore, enter **p** and press **Enter** to create a primary partition. - - Information similar to the following is displayed: - - .. code-block:: - - Select (default p): p - Partition number (1-4, default 1): - - **Partition number** indicates the serial number of the primary partition. The value ranges from **1** to **4**. - -#. Enter the serial number of the primary partition and press **Enter**. Primary partition number **1** is used in this example. One usually starts with partition number **1** when partitioning an empty disk. - - Information similar to the following is displayed: - - .. code-block:: - - Partition number (1-4, default 1): 1 - First sector (2048-209715199, default 2048): - - **First sector** indicates the start sector. The value ranges from **2048** to **209715199**, and the default value is **2048**. - -#. Select the default start sector **2048** and press **Enter**. - - The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector. - - Information similar to the following is displayed: - - .. code-block:: - - First sector (2048-209715199, default 2048): - Using default value 2048 - Last sector, +sectors or +size{K,M,G} (2048-209715199, default 209715199): - - **Last sector** indicates the end sector. The value ranges from **2048** to **209715199**, and the default value is **209715199**. - -#. Select the default end sector **209715199** and press **Enter**. - - The system displays the start and end sectors of the partition's available space. You can customize the value within this range or use the default value. The start sector must be smaller than the partition's end sector. - - Information similar to the following is displayed: - - .. code-block:: - - Last sector, +sectors or +size{K,M,G} (2048-209715199, default 209715199): - Using default value 209715199 - Partition 1 of type Linux and of size 100 GiB is set - - Command (m for help): - - A primary partition has been created for the new data disk. - -#. Enter **p** and press **Enter** to view details about the new partition. - - Information similar to the following is displayed: - - .. code-block:: - - Command (m for help): p - - Disk /dev/vdb: 107.4 GB, 107374182400 bytes, 209715200 sectors - Units = sectors of 1 * 512 = 512 bytes - Sector size (logical/physical): 512 bytes / 512 bytes - I/O size (minimum/optimal): 512 bytes / 512 bytes - Disk label type: dos - Disk identifier: 0x38717fc1 - - Device Boot Start End Blocks Id System - /dev/vdb1 2048 209715199 104856576 83 Linux - - Command (m for help): - - Details about the **/dev/vdb1** partition are displayed. - -#. Enter **w** and press **Enter** to write the changes to the partition table. - - Information similar to the following is displayed: - - .. code-block:: - - Command (m for help): w - The partition table has been altered! - - Calling ioctl() to re-read partition table. - Syncing disks. - - The partition is created. - - .. note:: - - In case that you want to discard the changes made before, you can exit fdisk by entering **q**. - -#. Run the following command to synchronize the new partition table to the OS: - - **partprobe** - -#. Run the following command to set the file system format for the new partition: - - **mkfs** **-t** *File system format* **/dev/vdb1** - - In this example, run the following command to set the **ext4** file system for the new partition: - - **mkfs -t ext4 /dev/vdb1** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb1 - mke2fs 1.42.9 (28-Dec-2013) - Filesystem label= - OS type: Linux - Block size=4096 (log=2) - Fragment size=4096 (log=2) - Stride=0 blocks, Stripe width=0 blocks - 6553600 inodes, 26214144 blocks - 1310707 blocks (5.00%) reserved for the super user - First data block=0 - Maximum filesystem blocks=2174746624 - 800 block groups - 32768 blocks per group, 32768 fragments per group - 8192 inodes per group - Superblock backups stored on blocks: - 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, - 4096000, 7962624, 11239424, 20480000, 23887872 - - Allocating group tables: done - Writing inode tables: done - Creating journal (32768 blocks): done - Writing superblocks and filesystem accounting information: done - - The formatting takes a period of time. Observe the system running status and do not exit. - - .. important:: - - The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements. - -#. Run the following command to create a mount point: - - **mkdir** *Mount point* - - In this example, run the following command to create the **/mnt/sdc** mount point: - - **mkdir /mnt/sdc** - -#. Run the following command to mount the new partition on the created mount point: - - **mount** *Disk partition* *Mount point* - - In this example, run the following command to mount the new partition **/dev/vdb1** on **/mnt/sdc**: - - **mount /dev/vdb1 /mnt/sdc** - -#. Run the following command to view the mount result: - - **df -TH** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# df -TH - Filesystem Type Size Used Avail Use% Mounted on - /dev/vda1 ext4 43G 1.9G 39G 5% / - devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev - tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm - tmpfs tmpfs 2.0G 9.1M 2.0G 1% /run - tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup - tmpfs tmpfs 398M 0 398M 0% /run/user/0 - /dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc - - New partition **/dev/vdb1** is mounted on **/mnt/sdc**. - - .. note:: - - If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the **/etc/fstab** file. For details, see :ref:`Setting Automatic Mounting at System Start `. - -.. _en-us_topic_0085634797__en-us_topic_0044524669_section15839912195453: - -Setting Automatic Mounting at System Start ------------------------------------------- - -Modify the **fstab** file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data. - -The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the **fstab** file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart. - -.. note:: - - UUID is the unique character string for disk partitions in a Linux system. - -#. Run the following command to query the partition UUID: - - **blkid** *Disk partition* - - In this example, run the following command to query the UUID of the **/dev/vdb1** partition: - - **blkid /dev/vdb1** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# blkid /dev/vdb1 - /dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4" - - The UUID of the **/dev/vdb1** partition is displayed. - -#. Run the following command to open the **fstab** file using the vi editor: - - **vi /etc/fstab** - -#. Press **i** to enter the editing mode. - -#. Move the cursor to the end of the file and press **Enter**. Then, add the following information: - - .. code-block:: - - UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2 - -#. Press **Esc**, enter **:wq**, and press **Enter**. - - The system saves the configurations and exits the vi editor. - -#. Perform the following operations to verify the automatic mounting function: - - a. Run the following command to unmount the partition: - - **umount** *Disk partition* - - In this example, run the following command: - - **umount /dev/vdb1** - - b. Run the following command to reload all the content in the **/etc/fstab** file: - - **mount -a** - - c. Run the following command to query the file system mounting information: - - **mount** **\|** **grep** *Mount point* - - In this example, run the following command: - - **mount** **\|** **grep** **/mnt/sdc** - - If information similar to the following is displayed, the automatic mounting function takes effect: - - .. code-block:: - - root@ecs-test-0001 ~]# mount | grep /mnt/sdc - /dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered) diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_parted.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_parted.rst deleted file mode 100644 index a9cb0c89..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_linux_data_disk_parted.rst +++ /dev/null @@ -1,335 +0,0 @@ -:original_name: en-us_topic_0085634798.html - -.. _en-us_topic_0085634798: - -Initializing a Linux Data Disk (parted) -======================================= - -Scenarios ---------- - -This section uses CentOS 7.4 64bit to describe how to initialize a data disk attached to a server running Linux and use parted to partition the data disk. - -The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. In Linux, if you choose to use the GPT partition style, the fdisk partitioning tool cannot be used. Use the parted partitioning tool instead. For details about disk partition styles, see :ref:`Scenarios and Disk Partitions `. - -The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS. - -Prerequisites -------------- - -- A data disk has been attached to a server and has not been initialized. -- You have logged in to the server. - - - For how to log in to an ECS, see the *Elastic Cloud Server User Guide*. - - For how to log in to a BMS, see the *Bare Metal Server User Guide*. - -Creating and Mounting a Partition ---------------------------------- - -The following example shows you how a new partition can be created on a new data disk that has been attached to a server. The partition will be created using parted, and GPT is used as the partition style. Furthermore, the partition will be formatted using the ext4 file system, mounted on **/mnt/sdc**, and configured automatic mounting at system start. - -#. Run the following command to query information about the new data disk: - - **lsblk** - - Information similar to the following is displayed: - - .. code-block:: - - root@ecs-test-0001 ~]# lsblk - NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT - vda 253:0 0 40G 0 disk - └─vda1 253:1 0 40G 0 part / - vdb 253:16 0 100G 0 disk - - In the command output, the server contains two disks. **/dev/vda** is the system disk, and **/dev/vdb** is the new data disk. - -#. Run the following command to enter parted to partition the new data disk: - - **parted** *New data disk* - - In this example, run the following command: - - **parted /dev/vdb** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# parted /dev/vdb - GNU Parted 3.1 - Using /dev/vdb - Welcome to GNU Parted! Type 'help' to view a list of commands. - (parted) - -#. Enter **p** and press **Enter** to view the current disk partition style. - - Information similar to the following is displayed: - - .. code-block:: - - (parted) p - Error: /dev/vdb: unrecognised disk label - Model: Virtio Block Device (virtblk) - Disk /dev/vdb: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: unknown - Disk Flags: - (parted) - - In the command output, the **Partition Table** value is **unknown**, indicating that no partition style is set for the new disk. - -#. Run the following command to set the disk partition style: - - **mklabel** *Disk partition style* - - In this example, run the following command to set the partition style to GPT: (Disk partition styles can be MBR or GPT.) - - **mklabel gpt** - - .. important:: - - The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB. - - If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk. - -#. Enter **p** and press **Enter** to view the disk partition style. - - Information similar to the following is displayed: - - .. code-block:: - - (parted) mklabel gpt - (parted) p - Model: Virtio Block Device (virtblk) - Disk /dev/vdb: 107GB - Sector size (logical/physical): 512B/512B - Partition Table: gpt - Disk Flags: - - Number Start End Size File system Name Flags - - (parted) - - In the command output, the **Partition Table** value is **gpt**, indicating that the disk partition style is GPT. - -#. Enter **unit s** and press **Enter** to set the measurement unit of the disk to sector. - -#. Run the following command and press **Enter**: - - **mkpart** *Partition name Start sector* *End sector* - - In this example, run the following command: - - **mkpart test 2048s 100%** - - In this example, one partition is created for the new data disk. Variable *2048s* indicates the disk start sector, and variable *100%* indicates the disk end sector. The two values are used for reference only. You can determine the number of partitions and the partition size based on your service requirements. - - Information similar to the following is displayed: - - .. code-block:: - - (parted) mkpart opt 2048s 100% - (parted) - -#. Enter **p** and press **Enter** to view details about the new partition. - - Information similar to the following is displayed: - - .. code-block:: - - (parted) p - Model: Virtio Block Device (virtblk) - Disk /dev/vdb: 209715200s - Sector size (logical/physical): 512B/512B - Partition Table: gpt - Disk Flags: - - Number Start End Size File system Name Flags - 1 2048s 209713151s 209711104s test - - (parted) - -#. Enter **q** and press **Enter** to exit parted. - - Information similar to the following is displayed: - - .. code-block:: - - (parted) q - Information: You may need to update /etc/fstab. - - You can set automatic disk mounting by updating the **/etc/fstab** file. Before updating the file, set the file system format for the partition and mount the partition on the mount point. - -#. Run the following command to view the disk partition information: - - **lsblk** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# lsblk - NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT - vda 253:0 0 40G 0 disk - └─vda1 253:1 0 40G 0 part / - vdb 253:16 0 100G 0 disk - └─vdb1 253:17 0 100G 0 part - - In the command output, **/dev/vdb1** is the partition you created. - -#. Run the following command to set the file system format for the new partition: - - **mkfs** **-t** *File system format* **/dev/vdb1** - - In this example, run the following command to set the **ext4** file system for the new partition: - - **mkfs -t ext4 /dev/vdb1** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# mkfs -t ext4 /dev/vdb1 - mke2fs 1.42.9 (28-Dec-2013) - Filesystem label= - OS type: Linux - Block size=4096 (log=2) - Fragment size=4096 (log=2) - Stride=0 blocks, Stripe width=0 blocks - 6553600 inodes, 26213888 blocks - 1310694 blocks (5.00%) reserved for the super user - First data block=0 - Maximum filesystem blocks=2174746624 - 800 block groups - 32768 blocks per group, 32768 fragments per group - 8192 inodes per group - Superblock backups stored on blocks: - 32768, 98304, 163840, 229376, 294912, 819200, 884736, 1605632, 2654208, - 4096000, 7962624, 11239424, 20480000, 23887872 - - Allocating group tables: done - Writing inode tables: done - Creating journal (32768 blocks): done - Writing superblocks and filesystem accounting information: done - - The formatting takes a period of time. Observe the system running status and do not exit. - - .. important:: - - The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements. - -#. Run the following command to create a mount point: - - **mkdir** *Mount point* - - In this example, run the following command to create the **/mnt/sdc** mount point: - - **mkdir /mnt/sdc** - -#. Run the following command to mount the new partition on the created mount point: - - **mount** *Disk partition* *Mount point* - - In this example, run the following command to mount the new partition **/dev/vdb1** on **/mnt/sdc**: - - **mount /dev/vdb1 /mnt/sdc** - -#. Run the following command to view the mount result: - - **df -TH** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# df -TH - Filesystem Type Size Used Avail Use% Mounted on - /dev/vda1 ext4 43G 1.9G 39G 5% / - devtmpfs devtmpfs 2.0G 0 2.0G 0% /dev - tmpfs tmpfs 2.0G 0 2.0G 0% /dev/shm - tmpfs tmpfs 2.0G 9.0M 2.0G 1% /run - tmpfs tmpfs 2.0G 0 2.0G 0% /sys/fs/cgroup - tmpfs tmpfs 398M 0 398M 0% /run/user/0 - /dev/vdb1 ext4 106G 63M 101G 1% /mnt/sdc - - New partition **/dev/vdb1** is mounted on **/mnt/sdc**. - - .. note:: - - If the server is restarted, the mounting will become invalid. You can set automatic mounting for partitions at system start by modifying the **/etc/fstab** file. For details, see :ref:`Setting Automatic Mounting at System Start `. - -.. _en-us_topic_0085634798__en-us_topic_0084935709_section15839912195453: - -Setting Automatic Mounting at System Start ------------------------------------------- - -Modify the **fstab** file to set automatic disk mounting at server start. You can also set automatic mounting for the servers containing data. This operation will not affect the existing data. - -The following procedure shows how to set automatic disk mounting at server start by using UUIDs to identify disks in the **fstab** file. You are advised not to use device names to identify disks in the file because a device name may change (for example, from /dev/vdb1 to /dev/vdb2) during the server stop or start, resulting in improper server running after restart. - -.. note:: - - UUID is the unique character string for disk partitions in a Linux system. - -#. Run the following command to query the partition UUID: - - **blkid** *Disk partition* - - In this example, run the following command to query the UUID of the **/dev/vdb1** partition: - - **blkid /dev/vdb1** - - Information similar to the following is displayed: - - .. code-block:: - - [root@ecs-test-0001 ~]# blkid /dev/vdb1 - /dev/vdb1: UUID="0b3040e2-1367-4abb-841d-ddb0b92693df" TYPE="ext4" - - The UUID of the **/dev/vdb1** partition is displayed. - -#. Run the following command to open the **fstab** file using the vi editor: - - **vi /etc/fstab** - -#. Press **i** to enter the editing mode. - -#. Move the cursor to the end of the file and press **Enter**. Then, add the following information: - - .. code-block:: - - UUID=0b3040e2-1367-4abb-841d-ddb0b92693df /mnt/sdc ext4 defaults 0 2 - -#. Press **Esc**, enter **:wq**, and press **Enter**. - - The system saves the configurations and exits the vi editor. - -#. Perform the following operations to verify the automatic mounting function: - - a. Run the following command to unmount the partition: - - **umount** *Disk partition* - - In this example, run the following command: - - **umount /dev/vdb1** - - b. Run the following command to reload all the content in the **/etc/fstab** file: - - **mount -a** - - c. Run the following command to query the file system mounting information: - - **mount** **\|** **grep** *Mount point* - - In this example, run the following command: - - **mount** **\|** **grep** **/mnt/sdc** - - If information similar to the following is displayed, the automatic mounting function takes effect: - - .. code-block:: - - root@ecs-test-0001 ~]# mount | grep /mnt/sdc - /dev/vdb1 on /mnt/sdc type ext4 (rw,relatime,data=ordered) diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2008.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2008.rst deleted file mode 100644 index 3b698586..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2008.rst +++ /dev/null @@ -1,173 +0,0 @@ -:original_name: en-us_topic_0085634796.html - -.. _en-us_topic_0085634796: - -Initializing a Windows Data Disk (Windows Server 2008) -====================================================== - -Scenarios ---------- - -This section uses Windows Server 2008 R2 Enterprise 64bit to describe how to initialize a data disk attached to a server running Windows. - -The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. For details about disk partition styles, see :ref:`Scenarios and Disk Partitions `. - -The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS. - -Prerequisites -------------- - -- A data disk has been attached to a server and has not been initialized. -- You have logged in to the server. - - - For how to log in to an ECS, see the *Elastic Cloud Server User Guide*. - - For how to log in to a BMS, see the *Bare Metal Server User Guide*. - -Procedure ---------- - -#. On the desktop of the server, right-click **Computer** and choose **Manage** from the shortcut menu. - - The **Server Manager** window is displayed. - -#. In the navigation tree, choose **Storage** > **Disk Management**. - - The **Disk Management** window is displayed. - - - If :ref:`Figure 1 ` is displayed, the new disk is offline. Go to :ref:`3 `. - - If :ref:`Figure 4 ` is displayed, the **Initialize Disk** window is prompted. Go to :ref:`5 `. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig40496387105554: - - .. figure:: /_static/images/en-us_image_0095024494.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Disk Management - -#. .. _en-us_topic_0085634796__en-us_topic_0044524740_li33296033102625: - - Disks are displayed in the right pane. In the **Disk 1** area, right-click **Offline** and choose **Online** from the shortcut menu to online the disk. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig102484362217: - - .. figure:: /_static/images/en-us_image_0132359404.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Online the disk - - .. note:: - - If the disk is offline, you need to online the disk before initializing it. - -#. After making the disk online, the disk status changes from **Offline** to **Not Initialized**. Right-click the disk status and choose **Initialize Disk** from the shortcut menu, as shown in :ref:`Figure 3 `. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig409808111224: - - .. figure:: /_static/images/en-us_image_0132360430.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Initialize Disk - -#. .. _en-us_topic_0085634796__en-us_topic_0044524740_li34991214122212: - - In the **Initialize Disk** dialog box, select the target disk, click **MBR (Master Boot Record)** or **GPT (GUID Partition Table)**, and click **OK**, as shown in :ref:`Figure 4 `. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig68332918241: - - .. figure:: /_static/images/en-us_image_0097597141.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Unallocated space - - .. important:: - - The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB. - - If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk. - -#. Right-click at the unallocated space and choose **New Simple Volume** from the shortcut menu, as shown in :ref:`Figure 5 `. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig1945583522619: - - .. figure:: /_static/images/en-us_image_0097597143.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** New Simple Volume - -#. On the displayed **New Simple Volume Wizard** window, click **Next**. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig1388010596281: - - .. figure:: /_static/images/en-us_image_0097597145.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** New Simple Volume Wizard - -#. Specify the volume size and click **Next**. The default value is the maximum size. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig311184311294: - - .. figure:: /_static/images/en-us_image_0097597147.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Specify Volume Size - -#. Assign the driver letter and click **Next**. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig1400313143015: - - .. figure:: /_static/images/en-us_image_0097597149.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Assign Driver Letter or Path - -#. Select **Format this volume with the following settings**, set parameters based on the actual requirements, and select **Perform a quick format**. Then, click **Next**. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig19840335173018: - - .. figure:: /_static/images/en-us_image_0097597151.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Format Partition - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig183312171318: - - .. figure:: /_static/images/en-us_image_0097597153.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 10** Completing the partition creation - - .. important:: - - The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements. - -#. Click **Finish**. Wait for the initialization to complete. When the volume status changes to **Healthy**, the initialization has finished successfully, as shown in :ref:`Figure 11 `. - - .. _en-us_topic_0085634796__en-us_topic_0044524740_fig14464150329: - - .. figure:: /_static/images/en-us_image_0097597155.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 11** Disk initialization succeeded diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2016.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2016.rst deleted file mode 100644 index 9b71ba65..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/initializing_a_windows_data_disk_windows_server_2016.rst +++ /dev/null @@ -1,187 +0,0 @@ -:original_name: en-us_topic_0117490178.html - -.. _en-us_topic_0117490178: - -Initializing a Windows Data Disk (Windows Server 2016) -====================================================== - -Scenarios ---------- - -This section uses Windows Server 2016 Standard 64bit to describe how to initialize a data disk attached to a server running Windows. - -The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Therefore, use the GPT partition style if your disk capacity is larger than 2 TB. For details about disk partition styles, see :ref:`Scenarios and Disk Partitions `. - -The method for initializing a disk varies depending on the OS running on the server. This document is used for reference only. For the detailed operations and differences, see the product documents of the corresponding OS. - -Prerequisites -------------- - -- A data disk has been attached to a server and has not been initialized. -- You have logged in to the server. - - - For how to log in to an ECS, see the *Elastic Cloud Server User Guide*. - - For how to log in to a BMS, see the *Bare Metal Server User Guide*. - -Procedure ---------- - -#. On the desktop of the server, click the start icon in the lower left corner. - - The **Windows Server** window is displayed. - -#. Click **Server Manager**. - - The **Server Manager** window is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig128445136715: - - .. figure:: /_static/images/en-us_image_0132368216.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Server Manager - -#. In the upper right corner, choose **Tools** > **Computer Management**. - - The **Computer Management** window is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig11577433192617: - - .. figure:: /_static/images/en-us_image_0175083503.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Computer Management - -#. Choose **Storage** > **Disk Management**. - - Disks are displayed in the right pane. If there is a disk that is not initialized, the system will prompt you with the **Initialize Disk** dialog box. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig11358119588: - - .. figure:: /_static/images/en-us_image_0175083504.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Disk list - -#. In the **Initialize Disk** dialog box, the to-be-initialized disk is selected. Select a disk partition style and click **OK**. In this example, **GPT (GUID Partition Table)** is selected. - - The **Computer Management** window is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig68332918241: - - .. figure:: /_static/images/en-us_image_0175083507.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Computer Management (Windows Server 2016) - - .. important:: - - The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB. - - If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk. - -#. Right-click at the unallocated disk space and choose **New Simple Volume** from the shortcut menu. - - The **New Simple Volume Wizard** window is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig19509202633615: - - .. figure:: /_static/images/en-us_image_0175083508.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** New Simple Volume Wizard (Windows Server 2016) - -#. Follow the prompts and click **Next**. - - The **Specify Volume Size** page is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig209619215384: - - .. figure:: /_static/images/en-us_image_0175083509.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Specify Volume Size (Windows Server 2016) - -#. Specify the volume size and click **Next**. The system selects the maximum volume size by default. You can specify the volume size as required. In this example, the default setting is used. - - The **Assign Drive Letter or Path** page is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig631143204114: - - .. figure:: /_static/images/en-us_image_0175083510.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Assign Driver Letter or Path (Windows Server 2016) - -#. Assign a drive letter or path to your partition and click **Next**. The system assigns drive letter D by default. In this example, the default setting is used. - - The **Format Partition** page is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig1400313143015: - - .. figure:: /_static/images/en-us_image_0175083511.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Format Partition (Windows Server 2016) - -#. Specify format settings and click **Next**. The system selects the NTFS file system by default. You can specify the file system type as required. In this example, the default setting is used. - - The **Completing the New Simple Volume Wizard** page is displayed. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig380162213463: - - .. figure:: /_static/images/en-us_image_0175083512.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Completing the New Simple Volume Wizard (Windows Server 2016) - - .. important:: - - The partition sizes supported by file systems vary. Therefore, you are advised to choose an appropriate file system based on your service requirements. - -#. Click **Finish**. - - Wait for the initialization to complete. When the volume status changes to **Healthy**, the initialization has finished successfully, as shown in :ref:`Figure 10 `. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig14464150329: - - .. figure:: /_static/images/en-us_image_0175083513.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 10** Disk initialization succeeded (Windows Server 2016) - -#. After the volume is created, click |image1| on the task bar and check whether a new volume appears in **This PC**. In this example, New Volume (D:) is the new volume. - - If New Volume (D:) appears, the disk is successfully initialized and no further action is required. - - .. _en-us_topic_0117490178__en-us_topic_0115255433_fig4958111374510: - - .. figure:: /_static/images/en-us_image_0175083515.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 11** This PC (Windows Server 2016) - -.. |image1| image:: /_static/images/en-us_image_0238263336.png - diff --git a/ecs/umn/result/getting_started/initializing_evs_data_disks/scenarios_and_disk_partitions.rst b/ecs/umn/result/getting_started/initializing_evs_data_disks/scenarios_and_disk_partitions.rst deleted file mode 100644 index b844b8e2..00000000 --- a/ecs/umn/result/getting_started/initializing_evs_data_disks/scenarios_and_disk_partitions.rst +++ /dev/null @@ -1,55 +0,0 @@ -:original_name: en-us_topic_0030831623.html - -.. _en-us_topic_0030831623: - -Scenarios and Disk Partitions -============================= - -If you have added a data disk during ECS creation, you must initialize the data disk after logging in to the ECS. - -Scenarios ---------- - -After a disk is attached to a server, you need to log in to the server to initialize the disk, that is, format the disk. You must initialize a disk before accessing it. - -- System disk - - A system disk does not require manual initialization because it is automatically created and initialized upon server creation. The default disk partition style is master boot record (MBR). - -- Data disk - - - If a data disk is created along with a server, it will be automatically attached to the server. - - If a data disk is created separately, you need to manually attach it to a server. - - In both cases, you must initialize the data disk before using it. Choose a proper disk partition style based on your service plan. - -Disk Partition Styles ---------------------- - -:ref:`Table 1 ` lists the common disk partition styles. In Linux, different disk partition styles require different partitioning tools. - -.. _en-us_topic_0030831623__en-us_topic_0085245975_table2729705994129: - -.. table:: **Table 1** Disk partition styles - - +----------------------------+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------+ - | Disk Partition Style | Maximum Disk Capacity Supported | Maximum Number of Partitions Supported | Linux Partitioning Tool | - +============================+=================================+============================================================================================================================================================================================================================================================================+=========================+ - | Master Boot Record (MBR) | 2 TB | - 4 primary partitions | - fdisk | - | | | - 3 primary partitions and 1 extended partition | - parted | - | | | | | - | | | With MBR, one may create several primary partitions and an extended partition. An extended partition must be divided into several logical partitions before use. For example, if 6 partitions need to be created, you can create the partitions in the following two ways: | | - | | | | | - | | | - 3 primary partitions and 1 extended partition, with the extended partition divided into 3 logical partitions | | - | | | - 1 primary partition and 1 extended partition, with the extended partition divided into 5 logical partitions | | - +----------------------------+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------+ - | GUID Partition Table (GPT) | 18 EB | Unlimited | parted | - | | | | | - | | 1 EB = 1048576 TB | Disk partitions created using GPT are not categorized. | | - +----------------------------+---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------------------+ - -.. important:: - - The maximum disk capacity supported by MBR is 2 TB, and that supported by GPT is 18 EB. Because a data disk currently supports up to 32 TB, use the GPT partition style if your disk capacity is larger than 2 TB. - - If you change the disk partition style after the disk has been used, the data on the disk will be cleared. Therefore, select a proper disk partition style when initializing the disk. diff --git a/ecs/umn/result/getting_started/logging_in_to_an_ecs.rst b/ecs/umn/result/getting_started/logging_in_to_an_ecs.rst deleted file mode 100644 index 1bae6f14..00000000 --- a/ecs/umn/result/getting_started/logging_in_to_an_ecs.rst +++ /dev/null @@ -1,71 +0,0 @@ -:original_name: en-us_topic_0092494193.html - -.. _en-us_topic_0092494193: - -Logging In to an ECS -==================== - -Logging In to a Windows ECS ---------------------------- - -You can log in to a Windows ECS using either VNC or MSTSC provided on the management console. - -.. _en-us_topic_0092494193__en-us_topic_0144542149_fig297212219553: - -.. figure:: /_static/images/en-us_image_0201719710.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Windows ECS login modes - -#. Obtain the password. - - Use the password obtaining function provided by the management console to decrypt the key file to obtain a password. - - For details, see :ref:`Obtaining the Password for Logging In to a Windows ECS `. - -#. Select a login method and log in to the ECS. - - - Management console (VNC) - - For details, see :ref:`Login Using VNC `. - - - Remote desktop connection (MSTSC) - - For details, see :ref:`Login Using MSTSC `. - -Logging In to a Linux ECS -------------------------- - -You can log in to a Linux ECS using either VNC or SSH key provided on the management console. - -.. _en-us_topic_0092494193__en-us_topic_0144542149_fig51588342172524: - -.. figure:: /_static/images/en-us_image_0201719715.png - :alt: **Figure 2** Linux ECS login modes - :figclass: vsd - - - **Figure 2** Linux ECS login modes - -#. Select a login method and log in to the ECS. - - - VNC - - For details, see :ref:`Login Using VNC `. - - - SSH key - - When you log in to the ECS using the SSH key, bind an EIP to the ECS. - - For details, see :ref:`Login Using an SSH Key `. - -Follow-up Procedure -------------------- - -- If you have added a data disk during ECS creation, you must initialize the data disk after logging in to the ECS. - - For details, see :ref:`Scenarios and Disk Partitions `. - -- Certain ECSs require the installation of a driver after you log in to them. For details about available ECS types as well as their functions and usage, see "Notes" in :ref:`ECS Types `. diff --git a/ecs/umn/result/glossary.rst b/ecs/umn/result/glossary.rst deleted file mode 100644 index ae6708ab..00000000 --- a/ecs/umn/result/glossary.rst +++ /dev/null @@ -1,8 +0,0 @@ -:original_name: en-us_topic_0047898078.html - -.. _en-us_topic_0047898078: - -Glossary -======== - -For details about the terms involved in this document, see `Glossary `__. diff --git a/ecs/umn/result/images/creating_an_image.rst b/ecs/umn/result/images/creating_an_image.rst deleted file mode 100644 index 51a352be..00000000 --- a/ecs/umn/result/images/creating_an_image.rst +++ /dev/null @@ -1,35 +0,0 @@ -:original_name: en-us_topic_0101604508.html - -.. _en-us_topic_0101604508: - -Creating an Image -================= - -Scenarios ---------- - -You can use an existing ECS to create a system disk image, data disk image, and full-ECS image. - -- System disk image: contains an OS and application software for running services. You can use a system disk image to create ECSs and migrate your services to the cloud. -- Data disk image: contains only service data. You can create a data disk image from an ECS data disk. You can also use a data disk image to create EVS disks and migrate your service data to the cloud. -- Full-ECS image: contains all the data of an ECS, including the data on the data disks attached to the ECS. A full-ECS image can be used to rapidly create ECSs with service data. - -You can use a private image to change the OS. For instructions about how to create a private image, see *Image Management Service User Guide*. - -Procedure ---------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select your region and project. -#. Under **Computing**, click **Elastic Cloud Server**. -#. Locate the row that contains the target ECS. Click **More** in the **Operation** column and select **Manage Image/Disk > Create Image**. -#. Configure image information as prompted. - - - **Source**: **ECS** - - **ECS**: Retain default settings. - - **Name**: Customize your image name. - -#. Click **Create Now**. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/images/index.rst b/ecs/umn/result/images/index.rst deleted file mode 100644 index fdab2491..00000000 --- a/ecs/umn/result/images/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0177457774: - -====== -Images -====== - -.. toctree:: - :maxdepth: 1 - - overview - creating_an_image diff --git a/ecs/umn/result/images/overview.rst b/ecs/umn/result/images/overview.rst deleted file mode 100644 index fc3e0759..00000000 --- a/ecs/umn/result/images/overview.rst +++ /dev/null @@ -1,53 +0,0 @@ -:original_name: en-us_topic_0177457773.html - -.. _en-us_topic_0177457773: - -Overview -======== - -Image ------ - -An image is an ECS or BMS template that contains an OS or service data and may also contain proprietary software and application software, such as database software. Images can be public, private, or shared. - -Image Management Service (IMS) allows you to easily create and manage images. You can create an ECS using a public image, private image, or shared image. You can also use an existing ECS or external image file to create a private image. - -Public Image ------------- - -A public image is a standard, widely used image that contains a common OS, such as Ubuntu, CentOS, or Debian, and preinstalled public applications. This image is available to all users. Select your desired public image. Alternatively, create a private image based on a public image to copy an existing ECS or rapidly create ECSs in a batch. You can customize a public image by configuring the application environment and software. - -Private Image -------------- - -A private image contains an OS or service data, preinstalled public applications, and private applications. It is available only to the user who created it. - -.. table:: **Table 1** Private image types - - +-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Image Type | Description | - +===================+======================================================================================================================================================+ - | System disk image | Contains an OS and application software for running services. You can use a system disk image to create ECSs and migrate your services to the cloud. | - +-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data disk image | Contains only service data. You can use a data disk image to create EVS disks and migrate your service data to the cloud. | - +-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Full-ECS image | Contains an OS, application software, and data for running services. A full-ECS image contains the system disk and all data disks attached to it. | - +-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -If you plan to use a private image to change the OS, ensure that the private image is available. For instructions about how to create a private image, see *Image Management Service User Guide*. - -- If the image of a specified ECS is required, make sure that a private image has been created using this ECS. -- If a local image file is required, make sure that the image file has been imported to the cloud platform and registered as a private image. -- If a private image from another region is required, make sure that the image has been copied. -- If a private image from another user account is required, make sure that the image has been shared with you. - -Shared Image ------------- - -A shared image is a private image shared by another user and can be used as your own private image. - -- Images can be shared within a region only. -- Each image can be shared to a maximum of 128 tenants. -- You can stop sharing images anytime without notifying the recipient. -- You can delete shared image anytime without notifying the recipient. -- Full-ECS images cannot be shared. diff --git a/ecs/umn/result/index.rst b/ecs/umn/result/index.rst deleted file mode 100644 index af1c6678..00000000 --- a/ecs/umn/result/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -========== -Main Index -========== - -.. toctree:: - :maxdepth: 1 - - service_overview/index - getting_started/index - instances/index - images/index - evs_disks/index - cbr/index - passwords_and_key_pairs/index - nics/index - security/index - eips/index - resources_and_tags/index - monitoring/index - cts/index - troubleshooting/index - faqs/index - change_history - glossary diff --git a/ecs/umn/result/instances/index.rst b/ecs/umn/result/instances/index.rst deleted file mode 100644 index 9c26b94e..00000000 --- a/ecs/umn/result/instances/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _en-us_topic_0013771097: - -========= -Instances -========= - -.. toctree:: - :maxdepth: 1 - - viewing_ecs_information/index - logging_in_to_a_windows_ecs/index - logging_in_to_a_linux_ecs/index - managing_ecss/index - modifying_ecs_vcpu_and_memory_specifications/index - migrating_an_ecs - obtaining_metadata_and_passing_user_data/index - optional_configuring_mapping_between_hostnames_and_ip_addresses - optional_installing_a_driver_and_toolkit/index diff --git a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/index.rst b/ecs/umn/result/instances/logging_in_to_a_linux_ecs/index.rst deleted file mode 100644 index 2031c6bc..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0030831990: - -========================= -Logging In to a Linux ECS -========================= - -.. toctree:: - :maxdepth: 1 - - login_overview - login_using_vnc - login_using_an_ssh_key - login_using_an_ssh_password diff --git a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_overview.rst b/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_overview.rst deleted file mode 100644 index 9a5f31dd..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_overview.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: en-us_topic_0013771089.html - -.. _en-us_topic_0013771089: - -Login Overview -============== - -Constraints ------------ - -- Only a running ECS can be logged in. -- For ECSs created using public images, login usernames, passwords, and constraints vary depending on OSs running on the ECSs. For details, see `Public Images Introduction `__. - -Login Modes ------------ - -Select a login mode as required and log in to the target ECS. - -.. table:: **Table 1** Linux ECS login modes - - +-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ - | ECS OS | Local OS | Connection Method | Requirement | - +=================+=================+=========================================================================================================================================+==================================+ - | Linux | Windows | Use a remote login tool, such as PuTTY or Xshell. | The target ECS has an EIP bound. | - | | | | | - | | | - Password-authenticated: :ref:`Logging In to the Linux ECS from a Local Windows Server ` | | - | | | - Key-pair-authenticated: :ref:`Logging In to the Linux ECS from Local Windows ` | | - +-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ - | | Linux | Run commands. | | - | | | | | - | | | - Password-authenticated: :ref:`Logging In to the Linux ECS from a Local Linux Server ` | | - | | | - Key-pair-authenticated: :ref:`Logging In to the Linux ECS from Local Linux ` | | - +-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ - | | Windows | Use the remote login function available on the management console. | No EIP is required. | - | | | | | - | | | :ref:`Login Using VNC ` | | - +-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------+----------------------------------+ diff --git a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_key.rst b/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_key.rst deleted file mode 100644 index 74a3fc25..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_key.rst +++ /dev/null @@ -1,147 +0,0 @@ -:original_name: en-us_topic_0017955380.html - -.. _en-us_topic_0017955380: - -Login Using an SSH Key -====================== - -Scenarios ---------- - -This section describes how to remotely log in to a Linux ECS using an SSH key pair from Windows and Linux, respectively. - -Prerequisites -------------- - -- You have obtained the private key file used during ECS creation. -- You have bound an EIP to the ECS. For details, see :ref:`Viewing Details About an ECS `. - -- You have configured the inbound rules of the security group. For details, see :ref:`Configuring Security Group Rules `. -- The network connection between the login tool (PuTTY) and the target ECS is normal. For example, the default port 22 is not blocked by the firewall. - -.. _en-us_topic_0017955380__section47918167111724: - -Logging In to the Linux ECS from Local Windows ----------------------------------------------- - -To log in to the Linux ECS from local Windows, perform the operations described in this section. - -**Method 1: Use PuTTY to log in to the ECS.** - -The following operations use PuTTY as an example. Before logging in to the ECS using PuTTY, make sure that the private key file has been converted to .ppk format. - -#. Check whether the private key file has been converted to .ppk format. - - - If yes, go to step :ref:`7 `. - - If no, go to step :ref:`2 `. - -#. .. _en-us_topic_0017955380__li8851985111724: - - Visit the following website and download PuTTY and PuTTYgen: - - https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html - - .. note:: - - PuTTYgen is a key generator, which is used to create a key pair that consists of a public key and a private key for PuTTY. - -#. Run PuTTYgen. - -#. In the **Actions** pane, click **Load** and import the private key file that you stored during ECS creation. - - Ensure that the format of **All files (*.*)** is selected. - -#. Click **Save private key**. - -#. .. _en-us_topic_0017955380__li56738001111724: - - Save the converted private key, for example, **kp-123.ppk**, to the local computer. - -#. .. _en-us_topic_0017955380__li40879966111724: - - Double-click **PUTTY.EXE**. The **PuTTY Configuration** page is displayed. - -#. Choose **Session** and enter the EIP of the ECS under **Host Name (or IP address)**. - - .. _en-us_topic_0017955380__fig3739272820239: - - .. figure:: /_static/images/en-us_image_0000001082643605.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Configuring the EIP - -#. Choose **Connection** > **Data**. Enter the image username in **Auto-login username**. - - .. note:: - - - If a public image is used, see `Public Images Introduction `__ for the image username. - - If a private image is used, use the username of the private image. - -#. Choose **Connection** > **SSH** > **Auth**. In the last configuration item **Private key file for authentication**, click **Browse** and select the private key converted in step :ref:`6 `. - -#. Click **Open**. - - Log in to the ECS. - -**Method 2: Use Xshell to log in to the ECS.** - -#. Start the Xshell tool. - -#. Run the following command using the EIP to remotely log in to the ECS through SSH: - - **ssh** *Username*\ **@**\ *EIP* - - .. note:: - - - If a public image is used, see `Public Images Introduction `__ for the image username. - - If a private image is used, use the username of the private image. - -#. (Optional) If the system displays the **SSH Security Warning** dialog box, click **Accept & Save**. - - .. _en-us_topic_0017955380__fig680319562495: - - .. figure:: /_static/images/en-us_image_0178475901.png - :alt: **Figure 2** SSH Security Warning - - - **Figure 2** SSH Security Warning - -#. Select **Public Key** and click **Browse** beside the user key text box. - -#. In the user key dialog box, click **Import**. - -#. Select the locally stored key file and click **Open**. - -#. Click **OK** to log in to the ECS. - -.. _en-us_topic_0017955380__section3666784111724: - -Logging In to the Linux ECS from Local Linux --------------------------------------------- - -To log in to the Linux ECS from local Linux, perform the operations described in this section. The following operations use private key file **kp-123.pem** as an example to log in to the ECS. The name of your private key file may differ. - -#. On the Linux CLI, run the following command to change operation permissions: - - **chmod 400 /**\ *path*\ **/kp-123.pem** - - .. note:: - - In the preceding command, *path* refers to the path where the key file is saved. - -#. Run the following command to log in to the ECS: - - **ssh -i /**\ *path*\ **/kp-123.pem** *Default username*\ **@**\ *EIP* - - For example, if the default username is **root** and the EIP is **123.123.123.123**, run the following command: - - **ssh -i /path/kp-123.pem root@123.123.123.123** - - .. note:: - - In the preceding command: - - - *path* refers to the path under which the key file is stored. - - *EIP* is the EIP bound to the ECS. diff --git a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_password.rst b/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_password.rst deleted file mode 100644 index b1380caa..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_an_ssh_password.rst +++ /dev/null @@ -1,131 +0,0 @@ -:original_name: en-us_topic_0017955633.html - -.. _en-us_topic_0017955633: - -Login Using an SSH Password -=========================== - -Scenarios ---------- - -This section describes how to remotely log in to a Linux ECS using an SSH password from Windows and Linux, respectively. - -.. important:: - - Logging in to a Linux ECS using SSH password authentication is disabled by default. If you require password authentication, configure it after logging in to the ECS. To ensure system security, reset the common user password for logging in to the Linux ECS after configuring SSH password authentication. - -Prerequisites -------------- - -- The target ECS is running. -- You have bound an EIP to the ECS. For details, see :ref:`Binding an EIP `. - -- Access to port 22 is allowed in the inbound direction of the security group to which the ECS belongs. For details, see :ref:`Configuring Security Group Rules `. -- The network connection between the login tool (PuTTY) and the target ECS is normal. For example, the default port 22 is not blocked by the firewall. -- You have obtained the SSH login permission and reset the common user password for logging in to the Linux ECS. For details, see :ref:`Configuring the Login Permission Using SSH Password Authentication `. - -.. _en-us_topic_0017955633__section6207684794951: - -Configuring the Login Permission Using SSH Password Authentication ------------------------------------------------------------------- - -**Assigning the remote login permission using SSH key authentication** - -#. Use the SSH key to log in to the Linux ECS. For details, see :ref:`Login Using an SSH Key `. - -#. Run the following command to change the value of **PasswordAuthentication** in **/etc/ssh/sshd_config** to **yes**: - - **sudo vi /etc/ssh/sshd_config** - - .. note:: - - For the ECSs running the SUSE or OpenSUSE OSs, ensure that the values of **PasswordAuthentication**, **ChallengeResponseAuthentication**, and **UsePAM** in **/etc/ssh/sshd_config** are all **yes**. - -#. Run the following command to change the **ssh_pwauth** value to **1** or **true** in **/etc/cloud/cloud.cfg**: - - **sudo vi /etc/cloud/cloud.cfg** - -#. Run the following command to reload the sshd service: - - **sudo service sshd reload** - -**To ensure system security, reset the common user password for logging in to the Linux ECS.** - -#. Run the following command to reset the ECS password: - - If the ECS username is **linux**, run the following command: - - **sudo passwd linux** - - .. note:: - - To remotely log in to an ECS as user **root**, perform the following operations: - - a. Run the following command to change the **disable_root** value to **0** or **false** and the **ssh_pwauth** value to **1** or **true** in **/etc/cloud/cloud.cfg**: - - **sudo vi /etc/cloud/cloud.cfg** - - b. Run the following command to set the user **root** password: - - **sudo passwd root** - -#. Enter the new password as prompted and press **Enter**. - -#. Confirm the password and press **Enter**. - -#. Verify that the information displayed is similar to the following, indicating that the password has been reset: - - .. code-block:: - - passwd: all authentication tokens updated successfully. - -.. _en-us_topic_0017955633__section62068112020: - -Logging In to the Linux ECS from a Local Windows Server -------------------------------------------------------- - -To log in to the Linux ECS from a local Windows server, perform the operations described in this section. - -The following operations use PuTTY as an example to log in to the ECS. - -#. Visit the following website and download PuTTY and PuTTYgen: - - https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html - -#. Run PuTTY. - -#. Click **Session**. - - a. **Host Name (or IP address)**: EIP bound to the ECS - - b. **Port**: **22** - - c. **Connection type**: **SSH** - - d. **Saved Sessions**: Task name, which can be clicked for remote connection when you use PuTTY next time - - .. _en-us_topic_0017955633__fig74247114018: - - .. figure:: /_static/images/en-us_image_0159943784.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Session - -#. Click **Window**. Then, select **UTF-8** for **Received data assumed to be in which character set:** in **Translation**. - -#. Click **Open**. - - If you log in to the ECS for the first time, PuTTY displays a security warning dialog box, asking you whether to accept the ECS security certificate. Click **Yes** to save the certificate to your local registry. - -#. After the SSH connection to the ECS is set up, enter the username and password as prompted to log in to the ECS. - -.. _en-us_topic_0017955633__section20811823174313: - -Logging In to the Linux ECS from a Local Linux Server ------------------------------------------------------ - -To log in to the Linux ECS from a local Linux server, run the following command: - -**ssh** *EIP bound to the ECS* diff --git a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_vnc.rst b/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_vnc.rst deleted file mode 100644 index ed818d29..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_linux_ecs/login_using_vnc.rst +++ /dev/null @@ -1,354 +0,0 @@ -:original_name: en-us_topic_0093263550.html - -.. _en-us_topic_0093263550: - -Login Using VNC -=============== - -Scenarios ---------- - -This section describes how to use VNC provided on the management console to log in to an ECS. This function applies to emergency O&M. In other scenarios, you are advised to log in to ECSs using SSH or MSTSC. - -For instructions about how to copy and paste data on VNC pages after the ECS login, see :ref:`Follow-up Procedure `. - -.. note:: - - Before using remote login (VNC) provided on the management console to log in to a Linux ECS authenticated using a key pair, log in to the ECS :ref:`using an SSH key ` and set a login password. - -Constraints ------------ - -- The remote login function is implemented using customized ports. Therefore, before attempting to log in remotely, ensure that the port to be used is not blocked by the firewall. For example, if the remote login link is xxx:8002, ensure that port 8002 is not blocked by the firewall. -- If the client OS uses a local proxy and the firewall port cannot be configured on the local proxy, disable the proxy mode and then try logging in remotely. - -Login Notes ------------ - -#. When you log in to the ECS using VNC, four types of keyboards will be used, as described in :ref:`Table 1 `. - - .. _en-us_topic_0093263550__en-us_topic_0027268511_en-us_topic_0039525621_table10692372181721: - - .. table:: **Table 1** Keyboard types - - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Keyboard Type | Description | Keyboard Language | - +=======================================+=============================================================================================================================================================================================================================================================================================+====================================================================================================================================================================================================================================================================================================================================+ - | Physical keyboard | Used by the terminal and allows terminal data input. | Selected by users locally. | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input method keyboard on the terminal | Used for logging in to the management console from a terminal, such as a computer. The keyboard input method of the terminal must comply with the physical keyboard language type. In this way, the entered data can be correctly transferred from the physical keyboard to the VNC client. | Selected by users locally. | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | VNC keyboard | Used for VNC logins. The VNC keyboard input method must comply with the physical keyboard language type. In this way, the entered data can be correctly transferred from the VNC client to the ECS OS. | Can be configured through the management console. | - | | | | - | | .. note:: | For instructions about how to select a VNC keyboard language, see :ref:`Logging In to an ECS Using an English Keyboard ` and :ref:`Logging In to an ECS Using a Non-English Keyboard `. | - | | | | - | | The English keyboard is used by default. The system also supports other keyboard languages. | | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ECS OS keyboard | Input method keyboard configured in the ECS OS. Ensure that this input method complies with the physical keyboard language type for correct response to the entered data transferred from the VNC client. | Configured by users locally. | - | | | | - | | .. note:: | For instructions about how to change an ECS OS keyboard language, see :ref:`Changing the OS Keyboard Language `. | - | | | | - | | - The default OS keyboard language of an ECS created using a public image is English. For additional information, see `Public Images Introduction `__. | | - | | - The OS keyboard language of an ECS created using a private image is customized. | | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. When you log in to the ECS using VNC, ensure that your configured keyboard language is correct. - - The entered data is as expected only if the input method keyboard on the terminal, the VNC keyboard, and the ECS OS keyboard languages are the same as the physical keyboard language. For details about language configuration in the four types of keyboards, see :ref:`Table 2 `. - - .. _en-us_topic_0093263550__en-us_topic_0027268511_en-us_topic_0039525621_table31240733181814: - - .. table:: **Table 2** Language configuration in the four types of keyboards - - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | Physical Keyboard | Input Method Keyboard on the Terminal | VNC Keyboard | ECS OS Keyboard | Supported or Not | - +===================+=======================================+==============+=================+==================+ - | English | English | English | English | Yes | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | German | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | German | English | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | German | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - | | | | German | Yes | - +-------------------+---------------------------------------+--------------+-----------------+------------------+ - -#. If the password used when you create the ECS is entered using the English keyboard, you must use the English keyboard to enter the password when logging in to the ECS later. - -.. _en-us_topic_0093263550__en-us_topic_0027268511_section46750509111459: - -Logging In to an ECS Using an English Keyboard ----------------------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name and click |image2| for search. - -#. Locate the row containing the ECS and click **Remote Login** in the **Operation** column. - -#. .. _en-us_topic_0093263550__en-us_topic_0027268511_li17715715111459: - - In the displayed **Configure Keyboard Layout for Remote Login** dialog box, select the English keyboard. - - .. _en-us_topic_0093263550__en-us_topic_0027268511_fig25223713111459: - - .. figure:: /_static/images/en-us_image_0030874270.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Keyboard layout configuration - -#. Click **Remote Login**. - -#. (Optional) If you have changed the system language, in the dialog box that is displayed, click **Start Remote Login**. - - .. _en-us_topic_0093263550__en-us_topic_0027268511_fig54376817111459: - - .. figure:: /_static/images/en-us_image_0030874271.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Remote Login - -#. (Optional) When the system displays "Press CTRL+ALT+DELETE to log on", click **Send CtrlAltDel** in the upper part of the remote login page to log in to the ECS. - - .. _en-us_topic_0093263550__fig51941916112020: - - .. figure:: /_static/images/en-us_image_0201100229.png - :alt: **Figure 3** Send CtrlAltDel - - - **Figure 3** Send CtrlAltDel - -#. (Optional) If you need your cursor to be displayed on the remote login page, click **Local Cursor**. - - .. _en-us_topic_0093263550__en-us_topic_0027268511_fig3022163194924: - - .. figure:: /_static/images/en-us_image_0093469181.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Local Cursor - -#. Enter the ECS password as prompted. - -.. _en-us_topic_0093263550__en-us_topic_0027268511_section5982347111459: - -Logging In to an ECS Using a Non-English Keyboard -------------------------------------------------- - -#. Log in to the management console. - -#. Click |image3| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name, IP address, or ID, and click |image4| for search. - -#. Locate the row containing the ECS and click **Remote Login** in the **Operation** column. - -#. In the displayed **Configure Keyboard Layout for Remote Login** dialog box, select the English keyboard. - - .. _en-us_topic_0093263550__en-us_topic_0093263550_en-us_topic_0027268511_fig25223713111459: - - .. figure:: /_static/images/en-us_image_0030874270.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Keyboard layout configuration - -7. Click **Remote Login**. - -8. (Optional) If you have changed the system language, in the dialog box that is displayed, click **Start Remote Login**. - - .. _en-us_topic_0093263550__en-us_topic_0093263550_en-us_topic_0027268511_fig54376817111459: - - .. figure:: /_static/images/en-us_image_0030874271.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Remote Login - -9. (Optional) When the system displays "Press CTRL+ALT+DELETE to log on", click **Send CtrlAltDel** in the upper part of the remote login page to log in to the ECS. - - .. _en-us_topic_0093263550__en-us_topic_0027290684_fig22996848191913: - - .. figure:: /_static/images/en-us_image_0201103161.png - :alt: **Figure 7** Send CtrlAltDel - - - **Figure 7** Send CtrlAltDel - -10. (Optional) If you need your cursor to be displayed on the remote login page, click **Local Cursor**. - - .. _en-us_topic_0093263550__en-us_topic_0093263550_en-us_topic_0027268511_fig3022163194924: - - .. figure:: /_static/images/en-us_image_0093469181.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Local Cursor - -11. Enter the ECS password as prompted. - - - When logging in to the ECS using VNC for the first time, use the English keyboard to enter the password. After you have logged in to the ECS, see :ref:`Changing the OS Keyboard Language ` to change the keyboard language of the ECS OS. You can then select the keyboard language and enter the password the next time you log in. - - If you have changed the keyboard language of the ECS OS, ensure that the keyboard language in use, the keyboard language selected in step :ref:`6 `, and the changed OS keyboard language are all the same. - -.. _en-us_topic_0093263550__en-us_topic_0027268511_section66962382111459: - -Changing the OS Keyboard Language ---------------------------------- - -If the ECS is running Linux, run the following command: - -**loadkeys** *keymapfile* - -The *keymapfile* parameter indicates the name of the file containing the mappings between the keys and displayed characters. - -For example, if the name of a German keyboard mapping file is **de**, run the **loadkeys de** command. - -Configuration Example ---------------------- - -**Scenarios** - -If you attempt to log in to an ECS created using a public image for the first time, the languages of the four types of keyboards before the configuration are as follows (**Before configuration** row in :ref:`Table 3 `): - -- Physical keyboard: German -- Input method keyboard on the terminal: English -- VNC keyboard: English -- ECS OS keyboard: English - -In this case, you must change the languages of the other three types of keyboards to the same language as the physical keyboard for expected data entering. For details, see the **Solution 1** row in :ref:`Table 3 `. - -.. _en-us_topic_0093263550__en-us_topic_0027268511_en-us_topic_0039525621_table18256759113132: - -.. table:: **Table 3** Languages in the four types of keyboards - - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | - | Physical Keyboard | Input Method Keyboard on the Terminal | VNC Keyboard | ECS OS Keyboard | - +======================+===================+=======================================+==============+=================+ - | Before configuration | German | English | English | English | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | Solution 1 | German | German | German | German | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | Solution 2 | English | English | English | English | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - -**Procedure** - -#. .. _en-us_topic_0093263550__en-us_topic_0027268511_en-us_topic_0039525621_li55865773114331: - - Locally configure the language, for example, German, in the input method keyboard on the terminal. - -#. Set the VNC keyboard language to English. - - .. note:: - - When you log in to the ECS using VNC for the first time, the default ECS OS keyboard language is English. Therefore, you must set the VNC keyboard language to English. - -#. Log in to the ECS and change the ECS OS language to German. - - For details, see :ref:`Changing the OS Keyboard Language `. - -#. .. _en-us_topic_0093263550__en-us_topic_0027268511_en-us_topic_0039525621_li62706781115148: - - Change the VNC keyboard language to German. - - For details, see :ref:`Logging In to an ECS Using a Non-English Keyboard `. - -To set the languages on the four types of keyboards to all be the same, perform :ref:`1 ` to :ref:`4 `. - -.. note:: - - During the configuration, if English characters cannot be entered using the current physical keyboard, use the English soft keyboard to modify the configuration described in the **Solution 2** row of :ref:`Table 3 `. In such a case, you only need to use the English soft keyboard to enter characters. - - - To enable the Windows English soft keyboard, choose **Start** > **Run**, enter **osk**, and press **Enter**. - - The method of enabling the Linux English soft keyboard varies depending on the OS version and is not described in this document. - -.. _en-us_topic_0093263550__section322133015286: - -Follow-up Procedure -------------------- - -Local commands can be copied to an ECS. To do so, perform the following operations: - -#. Log in to the ECS using VNC. - -#. Click **Input Commands** in the upper right corner of the page. - - .. _en-us_topic_0093263550__en-us_topic_0093263548_fig18993162320449: - - .. figure:: /_static/images/en-us_image_0109039483.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Input Commands - -#. Press **Ctrl+C** to copy data from the local computer. - -#. Press **Ctrl+V** to paste the local data to the **Copy Commands** window. - -#. Click **Send**. - - Send the copied data to the CLI. - -.. note:: - - There is a low probability that data is lost when you use Input Commands on the VNC page of a GUI-based Linux ECS. This is because the number of ECS vCPUs fails to meet GUI requirements. In such a case, it is a good practice to send a maximum of 5 characters at a time or switch from GUI to CLI (also called text interface), and then use the command input function. - -Helpful Links -------------- - -For FAQs about VNC-based ECS logins, see the following links: - -- :ref:`What Browser Version Is Required to Remotely Log In to an ECS? ` -- :ref:`What Should I Do If I Cannot Use the German Keyboard to Enter Characters When I Log In to a Linux ECS Using VNC? ` -- :ref:`Why Cannot I Use the MAC Keyboard to Enter Lowercase Characters When I Log In to an ECS Using VNC? ` -- :ref:`What Should I Do If the Page Does not Respond After I Log In to an ECS Using VNC and Do Not Perform Any Operation for a Long Period of Time? ` -- :ref:`What Should I Do If I Cannot View Data After Logging In to an ECS Using VNC? ` -- :ref:`Why Are Characters Entered Through VNC Still Incorrect After the Keyboard Language Is Switched? ` -- :ref:`Why Does a Blank Screen Appear While the System Displays a Message Indicating Successful Authentication After I Attempted to Log In to an ECS Using VNC? ` - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0128851444.png - -.. |image3| image:: /_static/images/en-us_image_0210779229.png - -.. |image4| image:: /_static/images/en-us_image_0128851405.png - diff --git a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/index.rst b/ecs/umn/result/instances/logging_in_to_a_windows_ecs/index.rst deleted file mode 100644 index d37fec77..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0030888079: - -=========================== -Logging In to a Windows ECS -=========================== - -.. toctree:: - :maxdepth: 1 - - login_overview - login_using_vnc - login_using_mstsc - logging_in_to_a_windows_ecs_from_a_linux_computer diff --git a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/logging_in_to_a_windows_ecs_from_a_linux_computer.rst b/ecs/umn/result/instances/logging_in_to_a_windows_ecs/logging_in_to_a_windows_ecs_from_a_linux_computer.rst deleted file mode 100644 index ec299d72..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/logging_in_to_a_windows_ecs_from_a_linux_computer.rst +++ /dev/null @@ -1,86 +0,0 @@ -:original_name: en-us_topic_0275383051.html - -.. _en-us_topic_0275383051: - -Logging In to a Windows ECS from a Linux Computer -================================================= - -Scenarios ---------- - -This section describes how to log in to a Windows ECS from a Linux computer. - -Prerequisites -------------- - -- The target ECS is running. -- You have bound an EIP to the ECS. - -- Access to port 3389 is allowed in the inbound direction of the security group to which the ECS belongs. -- Data can be exchanged between the login tool and the target ECS. For example, the default port 3389 is not blocked by the firewall. -- RDP has been enabled on the target ECS. By default, RDP has been enabled on the ECSs created using a public image. For instructions about how to enable RDP, see :ref:`Enabling RDP `. - -Procedure ---------- - -To log in to a Windows ECS from a local Linux computer, use a remote access tool, such as rdesktop. - -#. Run the following command to check whether rdesktop has been installed on the ECS: - - **rdesktop** - - If the message "command not found" is displayed, rdesktop is not installed. In such a case, obtain the rdesktop installation package at the `official rdesktop website `__. - -#. Run the following command to log in to the ECS: - - **rdesktop -u** *Username* **-p** *Password* **-g** *Resolution* *EIP* - - For example, run **rdesktop -u administrator -p password -g 1024*720 121.xx.xx.xx**. - - .. table:: **Table 1** Parameters in the remote login command - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+=======================================================================================================================================================================================================+ - | -u | Username, which defaults to **Administrator** for Windows ECSs | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | -p | Password for logging in to the Windows ECS | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | -f | Full screen by default, which can be switched using **Ctrl+Alt+Enter** | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | -g | Resolution, which uses an asterisk (*) to separate numbers. This parameter is optional. If it is not specified, the remote desktop is displayed in full screen by default, for example, **1024*720**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EIP | EIP of the Windows ECS to be remotely logged in. Replace it with the EIP bound to your Windows ECS. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0275383051__section65216898112059: - -Enabling RDP ------------- - -When you log in to an ECS for the first time, log in to it using VNC, enable RDP, and access the ECS using MSTSC. - -.. note:: - - By default, RDP has been enabled on the ECSs created using a public image. - -#. Log in to the Windows ECS using VNC. - - For details, see :ref:`Login Using VNC `. - -#. Click **Start** in the task bar and choose **Control Panel** > **System and Security** > **System** > **Remote settings**. - - The **System Properties** dialog box is displayed. - - .. _en-us_topic_0275383051__en-us_topic_0017955381_fig276023113838: - - .. figure:: /_static/images/en-us_image_0049287308.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** System Properties - -#. Click the **Remote** tab and select **Allow remote connections to this computer**. - -#. Click **OK**. diff --git a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_overview.rst b/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_overview.rst deleted file mode 100644 index 74b02a2b..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_overview.rst +++ /dev/null @@ -1,46 +0,0 @@ -:original_name: en-us_topic_0092494943.html - -.. _en-us_topic_0092494943: - -Login Overview -============== - -Constraints ------------ - -- Only a running ECS can be logged in. - -- Login usernames, passwords, and constraints vary depending on OSs running on the ECSs created using a public image. For details, see `Public Images Introduction `__. - -- If an ECS uses key pair authentication, use the password obtaining function available on the management console to decrypt the private key used during ECS creation to obtain a password. - -- Certain G series of ECSs do not support remote login provided by the management console. If you need to remotely log in to the ECSs, install the VNC server on them. For details, see :ref:`GPU-accelerated ECSs `. You are suggested to log in to the ECSs using MSTSC. - -- If you log in to a GPU-accelerated ECS using MSTSC, GPU acceleration will fail. This is because MSTSC replaces the WDDM GPU driver with a non-accelerated remote desktop display driver. In such a case, you must use other methods to log in to the ECS, such as VNC. If the remote login function available on the management console fails to meet your service requirements, you must install a suitable remote login tool on the ECS, such as TightVNC. - - To download TightVNC, log in at https://www.tightvnc.com/download.php. - -Login Modes ------------ - -Select a login mode as required and log in to the target ECS. - -.. table:: **Table 1** Windows login modes - - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | ECS OS | Local OS | Connection Method | Requirement | - +=================+=================+=============================================================================================================================================================+======================================+ - | Windows | Windows | Use MSTSC. | The target ECS has had an EIP bound. | - | | | | | - | | | Click **Start** on the local computer. In the **Search programs and files** text box, enter **mstsc** to open the **Remote Desktop Connection** dialog box. | | - | | | | | - | | | For details, see :ref:`Login Using MSTSC `. | | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | | Linux | Install a remote connection tool, for example, rdesktop. | | - | | | | | - | | | For details, see :ref:`Logging In to a Windows ECS from a Linux Computer `. | | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ - | | Windows | Through the management console. | No EIP is required. | - | | | | | - | | | For details, see :ref:`Login Using VNC `. | | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------+ diff --git a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_mstsc.rst b/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_mstsc.rst deleted file mode 100644 index 6d8073e9..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_mstsc.rst +++ /dev/null @@ -1,132 +0,0 @@ -:original_name: en-us_topic_0017955381.html - -.. _en-us_topic_0017955381: - -Login Using MSTSC -================= - -Scenarios ---------- - -This section describes how to use the remote login tool MSTSC to log in to a Windows ECS from a local computer. - -Prerequisites -------------- - -- The target ECS is running. -- You have obtained the password for logging in to the Windows ECS. For details, see :ref:`Obtaining the Password for Logging In to a Windows ECS `. -- You have bound an EIP to the ECS. For details, see :ref:`Binding an EIP `. - -- Access to port 3389 is allowed in the inbound direction of the security group to which the ECS belongs. For details, see :ref:`Configuring Security Group Rules `. -- The network connection between the login tool and the target ECS is normal. For example, the default port 3389 is not blocked by the firewall. -- RDP has been enabled on the target ECS. By default, RDP has been enabled on the ECSs created using a public image. For instructions about how to enable RDP, see :ref:`Enabling RDP `. - -Logging In to a Windows ECS Using MSTSC ---------------------------------------- - -If your local server runs Windows, you can use the remote desktop connection tool MSTSC delivered with the Windows OS to log in to a Windows ECS. - -#. Click the start menu on the local server. - -#. In the **Search programs and files** text box, enter **mstsc**. - -#. In the **Remote Desktop Connection** dialog box, click **Show Options**. - - .. _en-us_topic_0017955381__en-us_topic_0027290684_fig22996848191913: - - .. figure:: /_static/images/en-us_image_0295941039.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Show Options - -#. Enter the EIP and username (**Administrator** by default) of the target ECS. - - .. note:: - - If you do not want to enter the username and password in follow-up logins, select **Allow me to save credentials**. - - .. _en-us_topic_0017955381__fig61897111106: - - .. figure:: /_static/images/en-us_image_0295941040.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Remote Desktop Connection - -#. (Optional) To use local server resources in a remote session, configure parameters on the **Local Resources** tab. - - To copy data from the local server to your ECS, select **Clipboard**. - - .. _en-us_topic_0017955381__fig5308424112111: - - .. figure:: /_static/images/en-us_image_0295941041.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Clipboard - - To copy files from the local server to your ECS, click **More** and select your desired disks. - - .. _en-us_topic_0017955381__fig2016145215213: - - .. figure:: /_static/images/en-us_image_0295940977.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Drives - -#. (Optional) Click the **Display** tab and then adjust the size of the remote desktop. - - .. _en-us_topic_0017955381__fig45767599405: - - .. figure:: /_static/images/en-us_image_0295940978.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Adjusting the size of the desktop - -#. Click **OK** and enter the login password as prompted to log in to the ECS. - - To ensure system security, change the login password after you log in to the ECS for the first time. - -#. (Optional) After logging in to the ECS using RDP, handle the issue that local files larger than 2 GB cannot be copied to a remote Windows ECS. - - For details, see `troubleshooting cases `__. - -.. _en-us_topic_0017955381__section65216898112059: - -Enabling RDP ------------- - -When you log in to an ECS for the first time, log in to it using VNC, enable RDP, and access the ECS using MSTSC. - -.. note:: - - By default, RDP has been enabled on the ECSs created using a public image. - -#. Log in to the Windows ECS using VNC. - - For details, see :ref:`Login Using VNC `. - -#. Click **Start** in the task bar and choose **Control Panel** > **System and Security** > **System** > **Remote settings**. - - The **System Properties** dialog box is displayed. - - .. _en-us_topic_0017955381__fig276023113838: - - .. figure:: /_static/images/en-us_image_0049287308.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** System Properties - -#. Click the **Remote** tab and select **Allow remote connections to this computer**. - -#. Click **OK**. diff --git a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_vnc.rst b/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_vnc.rst deleted file mode 100644 index 0e877a70..00000000 --- a/ecs/umn/result/instances/logging_in_to_a_windows_ecs/login_using_vnc.rst +++ /dev/null @@ -1,326 +0,0 @@ -:original_name: en-us_topic_0027268511.html - -.. _en-us_topic_0027268511: - -Login Using VNC -=============== - -Scenarios ---------- - -This section describes how to use VNC provided on the management console to log in to an ECS. This function applies to emergency O&M. In other scenarios, you are advised to log in to ECSs using SSH or MSTSC. - -Constraints ------------ - -- The remote login function is implemented using customized ports. Therefore, before attempting to log in remotely, ensure that the port to be used is not blocked by the firewall. For example, if the remote login link is xxx:8002, ensure that port 8002 is not blocked by the firewall. -- If the client OS uses a local proxy and the firewall port cannot be configured on the local proxy, disable the proxy mode and then try logging in remotely. -- Certain G series of ECSs do not support remote login provided by the management console. If you need to remotely log in to the ECSs, install the VNC server on them. For details, see :ref:`GPU-accelerated ECSs `. You are suggested to log in to the ECSs using MSTSC. - -Login Notes ------------ - -#. When you log in to the ECS using VNC, four types of keyboards will be used. These are described in :ref:`Table 1 `. - - .. _en-us_topic_0027268511__en-us_topic_0039525621_table10692372181721: - - .. table:: **Table 1** Keyboard types - - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Keyboard Type | Description | Keyboard Language | - +=======================================+=============================================================================================================================================================================================================================================================================================+============================================================================================================================================================================================================================================================================================+ - | Physical keyboard | Used by the terminal and allows terminal data input. | Selected by users locally. | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input method keyboard on the terminal | Used for logging in to the management console from a terminal, such as a computer. The keyboard input method of the terminal must comply with the physical keyboard language type. In this way, the entered data can be correctly transferred from the physical keyboard to the VNC client. | Selected by users locally. | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | VNC keyboard | Used for VNC logins. The VNC keyboard input method must comply with the physical keyboard language type. In this way, the entered data can be correctly transferred from the VNC client to the ECS OS. | Can be configured through the management console. | - | | | | - | | .. note:: | For instructions about how to select a VNC keyboard language, see :ref:`Log In to a Windows ECS Using an English Keyboard ` and :ref:`Log In to a Windows ECS Using a Non-English Keyboard `. | - | | | | - | | The English keyboard is used by default. The system also supports other keyboard languages. | | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ECS OS keyboard | Input method keyboard configured in the ECS OS. Ensure that this input method complies with the physical keyboard language type for correct response to the entered data transferred from the VNC client. | Configured by users locally. | - | | | | - | | .. note:: | For instructions about how to change an ECS OS keyboard language, see :ref:`Changing the OS Keyboard Language `. | - | | | | - | | - The default OS keyboard language of an ECS created using a public image is English. For additional information, see `Public Images Introduction `__. | | - | | - The OS keyboard language of an ECS created using a private image is customized. | | - +---------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. When you log in to the ECS using VNC, ensure that your configured keyboard language is correct. - - The entered data is as expected only if the input method keyboard on the terminal, the VNC keyboard, and the ECS OS keyboard languages are the same as the physical keyboard language. For details about language configuration in the four types of keyboards, see :ref:`Table 2 `. - - .. _en-us_topic_0027268511__en-us_topic_0039525621_table31240733181814: - - .. table:: **Table 2** Language configuration in the four types of keyboards - - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | Physical Keyboard | Input Method Keyboard on the Terminal | VNC Keyboard | ECS OS Keyboard | Permission | - +===================+=======================================+==============+=================+============+ - | English | English | English | English | Yes | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | German | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | German | English | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | German | English | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | German | English | No | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - | | | | German | Yes | - +-------------------+---------------------------------------+--------------+-----------------+------------+ - -#. If the password used when you create the ECS is entered using the English keyboard, you must use the English keyboard to enter the password when logging in to the ECS later. - -.. _en-us_topic_0027268511__section46750509111459: - -Log In to a Windows ECS Using an English Keyboard -------------------------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Obtain the password for logging in to the ECS. - - Before logging in to the ECS, you must have the login password. - - For instructions about how to obtain the password for logging in to a Windows ECS, see :ref:`Obtaining the Password for Logging In to a Windows ECS `. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name and click |image2| for search. - -#. Locate the row containing the ECS and click **Remote Login** in the **Operation** column. - -#. .. _en-us_topic_0027268511__li17715715111459: - - In the displayed **Configure Keyboard Layout for Remote Login** dialog box, select the English keyboard. - - .. _en-us_topic_0027268511__fig25223713111459: - - .. figure:: /_static/images/en-us_image_0030874270.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Keyboard layout configuration - -#. Click **Remote Login**. - -#. (Optional) If you have changed the system language, in the dialog box that is displayed, click **Remote Login**. - - .. _en-us_topic_0027268511__fig54376817111459: - - .. figure:: /_static/images/en-us_image_0030874271.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Remote Login - -#. (Optional) When the system displays "Press CTRL+ALT+DELETE to log on", click **Send CtrlAltDel** in the upper part of the remote login page to log in to the ECS. - - .. _en-us_topic_0027268511__en-us_topic_0027290684_fig22996848191913: - - .. figure:: /_static/images/en-us_image_0042322120.png - :alt: **Figure 3** Send CtrlAltDel - - - **Figure 3** Send CtrlAltDel - -#. (Optional) If you need your cursor to be displayed on the remote login page, click **Local Cursor**. - - .. _en-us_topic_0027268511__fig3022163194924: - - .. figure:: /_static/images/en-us_image_0036068239.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Local Cursor - -#. Enter the ECS password as prompted. - -.. _en-us_topic_0027268511__section5982347111459: - -Log In to a Windows ECS Using a Non-English Keyboard ----------------------------------------------------- - -#. Log in to the management console. - -#. Click |image3| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Obtain the password for logging in to the ECS. - - Before logging in to the ECS, you must have the login password. - - For instructions about how to obtain the password for logging in to a Windows ECS, see :ref:`Obtaining the Password for Logging In to a Windows ECS `. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name, IP address, or ID, and click |image4| for search. - -#. Locate the row containing the ECS and click **Remote Login** in the **Operation** column. - -#. In the displayed **Configure Keyboard Layout for Remote Login** dialog box, select the keyboard that suits your language. - - - When logging in to the ECS using VNC for the first time, select the default English keyboard. The ECS OS uses the English keyboard by default. - - If you have changed the keyboard language of the ECS OS, select the keyboard language to which you have changed. - - .. _en-us_topic_0027268511__fig46762780111459: - - .. figure:: /_static/images/en-us_image_0030874270.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Keyboard layout configuration - -8. Click **Remote Login**. - -9. (Optional) If you have changed the system language, in the dialog box that is displayed, click **Remote Login**. - - .. _en-us_topic_0027268511__en-us_topic_0027268511_fig54376817111459: - - .. figure:: /_static/images/en-us_image_0030874271.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Remote Login - -10. (Optional) When the system displays "Press CTRL+ALT+DELETE to log on", click **Send CtrlAltDel** in the upper part of the remote login page to log in to the ECS. - - .. _en-us_topic_0027268511__en-us_topic_0027290684_fig22996848191913_1: - - .. figure:: /_static/images/en-us_image_0042322120.png - :alt: **Figure 7** Send CtrlAltDel - - - **Figure 7** Send CtrlAltDel - -11. (Optional) If you need your cursor to be displayed on the remote login page, click **Local Cursor**. - - .. _en-us_topic_0027268511__en-us_topic_0027268511_fig3022163194924: - - .. figure:: /_static/images/en-us_image_0036068239.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Local Cursor - -12. Enter the ECS password as prompted. - - - When logging in to the ECS using VNC for the first time, use the English keyboard to enter the password. After you have logged in to the ECS, see :ref:`Changing the OS Keyboard Language ` to change the keyboard language of the ECS OS. You can then select the keyboard language and enter the password the next time you log in. - - If you have changed the keyboard language of the ECS OS, ensure that the keyboard language in use, the keyboard language selected in step :ref:`7 `, and the changed OS keyboard language are all the same. - -.. _en-us_topic_0027268511__section66962382111459: - -Changing the OS Keyboard Language ---------------------------------- - -Switch the input method or open the soft keyboard before entering characters. To do so, click the function menu icon and select **soft keyboard** and keyboard layout. - -Configuration Example ---------------------- - -**Scenarios** - -If you attempt to log in to an ECS created using a public image for the first time, the languages of the four types of keyboards before the configuration are as follows (**Before configuration** row in :ref:`Table 3 `): - -- Physical keyboard: German -- Input method keyboard on the terminal: English -- VNC keyboard: English -- ECS OS keyboard: English - -In this case, you must change the languages of the other three types of keyboards to the same language as the physical keyboard for expected data entering. For details, see the **Solution 1** row in :ref:`Table 3 `. - -.. _en-us_topic_0027268511__en-us_topic_0039525621_table18256759113132: - -.. table:: **Table 3** Languages in the four types of keyboards - - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | - | Physical Keyboard | Input Method Keyboard on the Terminal | VNC Keyboard | ECS OS Keyboard | - +======================+===================+=======================================+==============+=================+ - | Before configuration | German | English | English | English | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | Solution 1 | German | German | German | German | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - | Solution 2 | English | English | English | English | - +----------------------+-------------------+---------------------------------------+--------------+-----------------+ - -**Procedure** - -#. .. _en-us_topic_0027268511__en-us_topic_0039525621_li55865773114331: - - Locally configure the language, for example, German, in the input method keyboard on the terminal. - -#. Set the VNC keyboard language to English. - - .. note:: - - When you log in to the ECS using VNC for the first time, the default ECS OS keyboard language is English. Therefore, you must set the VNC keyboard language to English. - -#. Log in to the ECS and change the ECS OS language to German. - - For details, see :ref:`Changing the OS Keyboard Language `. - -#. .. _en-us_topic_0027268511__en-us_topic_0039525621_li62706781115148: - - Change the VNC keyboard language to German. - - For details, see :ref:`Log In to a Windows ECS Using a Non-English Keyboard `. - -To set the languages on the four types of keyboards to all be the same, repeat steps :ref:`1 ` to :ref:`4 `. - -.. note:: - - During the configuration, if English characters cannot be entered using the current physical keyboard, use the English soft keyboard to modify the configuration described in the **Solution 2** row of :ref:`Table 3 `. In such a case, you only need to use the English soft keyboard to enter characters. - - - To enable the Windows English soft keyboard, choose **Start** > **Run**, enter **osk**, and press **Enter**. - - The method of enabling the Linux English soft keyboard varies depending on the OS version and is not described in this document. - -Helpful Links -------------- - -For FAQs about VNC-based ECS logins, see the following links: - -- :ref:`What Browser Version Is Required to Remotely Log In to an ECS? ` -- :ref:`What Should I Do If I Cannot Use the German Keyboard to Enter Characters When I Log In to a Linux ECS Using VNC? ` -- :ref:`Why Cannot I Use the MAC Keyboard to Enter Lowercase Characters When I Log In to an ECS Using VNC? ` -- :ref:`What Should I Do If the Page Does not Respond After I Log In to an ECS Using VNC and Do Not Perform Any Operation for a Long Period of Time? ` -- :ref:`What Should I Do If I Cannot View Data After Logging In to an ECS Using VNC? ` -- :ref:`Why Are Characters Entered Through VNC Still Incorrect After the Keyboard Language Is Switched? ` -- :ref:`Why Does a Blank Screen Appear While the System Displays a Message Indicating Successful Authentication After I Attempted to Log In to an ECS Using VNC? ` - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0030874266.png - -.. |image3| image:: /_static/images/en-us_image_0210779229.png - -.. |image4| image:: /_static/images/en-us_image_0030874275.png - diff --git a/ecs/umn/result/instances/managing_ecss/changing_an_ecs_name.rst b/ecs/umn/result/instances/managing_ecss/changing_an_ecs_name.rst deleted file mode 100644 index 940525a5..00000000 --- a/ecs/umn/result/instances/managing_ecss/changing_an_ecs_name.rst +++ /dev/null @@ -1,56 +0,0 @@ -:original_name: en-us_topic_0142266317.html - -.. _en-us_topic_0142266317: - -Changing an ECS Name -==================== - -Scenarios ---------- - -The name of a created ECS can be changed to meet your service requirements. - -Multiple ECS names can be changed in a batch. After the change, the ECS names are the same. - -Procedure for a Single ECS --------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the name of the target ECS. - -#. On the page providing details about the ECS, click |image2| following the ECS name. Then, change the name as prompted. - - **Allow duplicate ECS name**: allows ECS names to be duplicate. If **Allow duplicate ECS name** is not selected and the target name is the same as an existing ECS name, the system displays a message indicating that the name has been used and you need to change another name. - -#. Click **OK**. - -Procedure for Batch Operations ------------------------------- - -#. Log in to the management console. - -#. Click |image3| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Select the target ECSs. - -#. Click **More** in the upper part of the ECS list and select **Change ECS Name** from the drop-down list. - -#. Enter the new name. - -#. Click **OK**. - - If you change ECS names in a batch, the new ECS names are the same, for example, all are **ecs-test**. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0142359884.png - -.. |image3| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/managing_ecss/changing_the_os.rst b/ecs/umn/result/instances/managing_ecss/changing_the_os.rst deleted file mode 100644 index c14eefdc..00000000 --- a/ecs/umn/result/instances/managing_ecss/changing_the_os.rst +++ /dev/null @@ -1,149 +0,0 @@ -:original_name: en-us_topic_0031523135.html - -.. _en-us_topic_0031523135: - -Changing the OS -=============== - -Scenarios ---------- - -Changing an ECS OS will change the system disk attached to the ECS. After the changing, the system disk ID of the ECS will be changed, and the original system disk will be deleted. - -If the OS running on an ECS cannot meet service requirements, change the ECS OS. - -The public cloud supports changing between image types (public images, private images, and shared images) and between OSs. You can change your OS by changing your ECS image. - -Constraints ------------ - -- The EVS disk quota must be greater than 0. -- H2 ECSs do not support OS change. -- If an ECS OS is to be changed using a full-ECS image, the ECS system disk can be encrypted. - -Notes ------ - -- After the OS is changed, the original OS is not retained, and the original system disk is deleted, including the data in all partitions of the system disk. -- Back up data before changing the OS. For details, see . -- Changing the OS does not affect data in data disks. -- After the OS is changed, your service running environment must be deployed in the new OS again. -- After the OS is changed, the ECS will be automatically started. -- After the OS is changed, the system disk type of the ECS cannot be changed. -- After the OS is changed, the IP and MAC addresses of the ECS remain unchanged. -- After the OS is changed, customized configurations, such as DNS and hostname of the original OS will be reset and require reconfiguration. -- It takes about 10 to 20 minutes to change the OS. During this process, the ECS is in **Changing OS** state. -- Do not perform any operations on the ECS immediately after its OS is changed. Wait for several minutes until the system successfully injects the password or key. Otherwise, the injection may fail, and the ECS cannot be logged in to. -- After the OS is changed, the password for logging in to the ECS is reset. To retrieve the password, perform the following operations: - - - For a Linux ECS, log in to it using the key and set a new password. For instructions about how to log in to an ECS using a key pair, see :ref:`Login Using an SSH Key `. - - For a Windows ECS, retrieve the password by following the instructions provided in :ref:`Obtaining the Password for Logging In to a Windows ECS `. - -- The system disk capacity of an ECS with OS changed may change because the system disk capacity specified by the image of the changed OS may be changed. -- You can choose to encrypt the system disk of an ECS during OS change. - -Notes on Change Between Different OSs -------------------------------------- - -Change between different OSs indicates that the OS is changed between Windows and Linux. - -- To change Windows to Linux, install an NTFS partition tool, such as NTFS-3G for data reading and writing on the Windows ECS. -- To change Linux to Windows, install software, such as Ext2Read or Ext2Fsd to identify ext3 or ext4. - - .. note:: - - You are not advised to change Linux to Window on the cloud platform. The reason is as follows: If there are LVM partitions on the Linux ECS, these partitions may fail after the OS is changed to Windows. - -Prerequisites -------------- - -- The target ECS is stopped. -- The target ECS has a system disk attached. -- Necessary data has been backed up. (Changing the OS clears the data in all partitions of the system disk, including the system partition.) -- If the original ECS uses password authentication while the new ECS uses key pair authentication, ensure that a key pair is available. -- If a private image is required for changing the ECS OS, create the desired private image by following the instructions provided in *Image Management Service User Guide*. - - - If an ECS image is required, make sure that a private image has been created using the ECS. - - If a local image file is required, make sure that the image file has been imported to the cloud platform and registered as a private image. - - If a private image from another region is required, make sure that the image has been copied. - - If a private image from another user account is required, make sure that the image has been shared with you. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. .. _en-us_topic_0031523135__en-us_topic_0031523135_en-us_topic_0024911405_li45082966143628: - - Under **Computing**, click **Elastic Cloud Server**. - -#. Locate the row containing the target ECS. Click **More** in the **Operation** column and select **Manage Image/Disk** > **Change OS**. - - Only stopped ECSs support OS changing. If the ECS is not stopped, stop it before proceeding with changing. - -#. Modify related ECS parameters, such as **Image Type** and **Image**, based on service requirements. - - For more details, see :ref:`Creating an ECS `. - -#. (Optional) Select the **Encryption** option to encrypt the system disk during OS change. - - To enable encryption, click **Create Xrole** to assign KMS access permissions to EVS. If you have rights granting permission, assign the KMS access permissions to EVS. If you do not have the permission, contact the user having the security administrator rights to assign the KMS access permissions. For more details, see :ref:`Can All Users Use the Encryption Feature? ` - - Encryption parameters are as follows: - - - **Encryption**: indicates that the EVS disk has been encrypted. - - **Create Xrole**: assigns KMS access permissions to EVS to obtain KMS keys. After the permissions are assigned, follow-up operations do not require assigning permissions again. - - **KMS Key Name**: specifies the name of the key used by the encrypted EVS disk. You can select an existing key, or click **Create KMS Key** and create a new one on the KMS console. The default value is **evs/default**. - - **Xrole Name: EVSAccessKMS**: specifies that permissions have been assigned to EVS to obtain KMS keys for encrypting or decrypting EVS disks. - - **KMS Key ID**: specifies the ID of the key used by the encrypted data disk. - -#. (Optional) Select a **License Type** (**Use license from the system** or **Bring your own license (BYOL)**) if the changed OS running on your ECS is billed. For more details, see :ref:`License Type `. - - The following OSs are billed: - - - SUSE Linux Enterprise Server - - Oracle Enterprise Linux - - Red Hat Enterprise Linux - -#. Configure the login mode. - - If the target ECS uses key pair authentication, you can replace the original key pair. - -#. Click **OK**. - -#. .. _en-us_topic_0031523135__en-us_topic_0031523135_en-us_topic_0024911405_li45992498111556: - - On the **Change ECS OS** page, confirm the specifications, and click **Submit Application**. - - After the application is submitted, the ECS status changes to **Changing OS**. The OS changing has been completed when **Changing OS** disappears. - - .. note:: - - A temporary ECS is created during the OS changing process. After the process is complete, this ECS will be automatically deleted. - -Follow-up Procedure -------------------- - -- If the OSs before and after the OS change are both Linux, and automatic partition mounting upon system startup has been enabled for the data disk, the data disk partition mounting information will be lost after the OS is changed. In such a case, you need to update the **/etc/fstab** configuration. - - #. Write the new partition information into **/etc/fstab**. - - It is a good practice to back up the **/etc/fstab** file before writing data into it. - - To enable automatic partition mounting upon system startup, see :ref:`Initializing a Linux Data Disk (fdisk) `. - - #. Mount the partition so that you can use the data disk. - - **mount** *Disk partition* *Device name* - - #. Check the mount result. - - **df -TH** - -- If the OS change is unsuccessful, perform steps :ref:`3 ` to :ref:`10 ` again to retry changing the OS again. -- If the second OS change attempt is unsuccessful, contact customer service for manual recovery at the backend. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/managing_ecss/changing_the_time_zone_for_an_ecs.rst b/ecs/umn/result/instances/managing_ecss/changing_the_time_zone_for_an_ecs.rst deleted file mode 100644 index d00b080e..00000000 --- a/ecs/umn/result/instances/managing_ecss/changing_the_time_zone_for_an_ecs.rst +++ /dev/null @@ -1,119 +0,0 @@ -:original_name: en-us_topic_0040630518.html - -.. _en-us_topic_0040630518: - -Changing the Time Zone for an ECS -================================= - -Scenarios ---------- - -The default time zone for an ECS is the one you selected when creating the image that was used to create the ECS. This section describes how to change the time zone for an ECS to the local one or to another time zone in your network. - -After you log in to your ECS, if you find that the time on the ECS is different from the local time, change the time zone for the ECS so that the time on the ECS is the same as the local time. - -For Linux ECSs --------------- - -The process of changing the time zone for a Linux ECS depends on the OS. In this section, the CentOS 6.x 64bit OS is used to demonstrate how to change the time zone for a Linux ECS. - -#. Log in to the ECS. - -#. Run the following command to switch to user **root**: - - **su - root** - -#. Run the following command to obtain the time zones supported by the ECS: - - **ls /usr/share/zoneinfo/** - - In the terminal display, the **/user/share/zoneinfo** directory contains a hierarchy of time zone data files. Use the directory structure to obtain your desired time zone file. - - The directory structure shown in **/user/share/zoneinfo** includes both time zones and directories. The directories contain time zone files for specific cities. Locate the time zone for the city in which the ECS is located. - - For example: - - - If you are to use the time zone for Shanghai, China, run the **ls /usr/share/zoneinfo/Asia** command to obtain the directory **/usr/share/zoneinfo/Asia/Shanghai**. - - If you are to use the time zone for Paris, France, run the **ls /usr/share/zoneinfo/Europe** command to obtain the directory **/usr/share/zoneinfo/Europe/Paris**. - -#. Set the target time zone. - - a. Run the following command to open the **/etc/sysconfig/clock** file: - - **vim /etc/sysconfig/clock** - - b. Locate the **ZONE** entry and change its value to the name of the desired time zone file. - - For example: - - - If the target time zone is for Shanghai, China, change the **ZONE** entry value as follows: - - ZONE="Asia/Shanghai" - - - If the target time zone is for Paris, France, change the **ZONE** entry value as follows: - - ZONE="Europe/Paris" - -#. Press **Esc**. Then, run the following command to save and exit the **/etc/sysconfig/clock** file: - - **:wq** - -#. Run the following command to check whether the **/etc/localtime** file is available on the ECS: - - **ls /etc/localtime** - - - If the file is available, go to step :ref:`7 `. - - If the file is not available, go to step :ref:`8 `. - -#. .. _en-us_topic_0040630518__li35115782151653: - - Run the following command to delete the existing **/etc/localtime** file: - - **rm /etc/localtime** - -#. .. _en-us_topic_0040630518__li564938451108: - - Run the following command to create a symbolic link between **/etc/localtime** and your time zone file so that the ECS can find this time zone file when it references the local time: - - **ln -sf /usr/share/zoneinfo/A\ sia/Shanghai** **/etc/localtime** - -#. Run the following command to restart the ECS so that all services and applications running on the ECS use the new time zone: - - **reboot** - -#. Log in to the ECS again and run the following command as user **root** to check whether the time zone has been changed: - - **ls -lh /etc/localtime** - - The following information is displayed: - - .. code-block:: - - # ls -lh /etc/localtime - lrwxrwxrwx 1 root root 33 Nov 27 11:01 /etc/localtime -> /usr/share/zoneinfo/Asia/Shanghai - -For Windows ECSs ----------------- - -#. Log in to the ECS. - -#. Click the time display on the far right side of the task bar located at the bottom of your screen. In the dialog box that is displayed, click **Change date and time settings**. - - The **Date and Time** page is displayed. - - .. _en-us_topic_0040630518__fig3371712915: - - .. figure:: /_static/images/en-us_image_0224317546.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Date and Time - -#. Click **Change time zone**. - - The **Time Zone Settings** page is displayed. - -#. In the **Set the time zone** pane, choose the target time zone from the **Time zone** drop-down list. - -#. Click **OK**. diff --git a/ecs/umn/result/instances/managing_ecss/index.rst b/ecs/umn/result/instances/managing_ecss/index.rst deleted file mode 100644 index d8502bfc..00000000 --- a/ecs/umn/result/instances/managing_ecss/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _en-us_topic_0176502615: - -============= -Managing ECSs -============= - -.. toctree:: - :maxdepth: 1 - - changing_an_ecs_name - reinstalling_the_os - changing_the_os - managing_ecs_groups - changing_the_time_zone_for_an_ecs - obtaining_ecs_console_logs diff --git a/ecs/umn/result/instances/managing_ecss/managing_ecs_groups.rst b/ecs/umn/result/instances/managing_ecss/managing_ecs_groups.rst deleted file mode 100644 index 95cc6571..00000000 --- a/ecs/umn/result/instances/managing_ecss/managing_ecs_groups.rst +++ /dev/null @@ -1,45 +0,0 @@ -:original_name: en-us_topic_0032980085.html - -.. _en-us_topic_0032980085: - -Managing ECS Groups -=================== - -Scenarios ---------- - -An ECS group allows you to create ECSs on different physical servers, thereby improving service reliability. This function does not apply to existing ECSs. You cannot add existing ECSs to an ECS group. - -Notes ------ - -An existing ECS cannot be added to an ECS group. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the navigation pane on the left, choose **ECS Group**. - -#. On the **ECS Group** page, click **Create ECS Group**. - -#. Enter the name of the target ECS group. - - The **Anti-affinity** policy is used by default. - -#. Click **OK**. - -Follow-up Procedure -------------------- - -Add an ECS to an ECS group only when creating the ECS. - -To do so, expand **Advanced Options** and select the target ECS group. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/managing_ecss/obtaining_ecs_console_logs.rst b/ecs/umn/result/instances/managing_ecss/obtaining_ecs_console_logs.rst deleted file mode 100644 index 1425e36d..00000000 --- a/ecs/umn/result/instances/managing_ecss/obtaining_ecs_console_logs.rst +++ /dev/null @@ -1,163 +0,0 @@ -:original_name: en-us_topic_0057711189.html - -.. _en-us_topic_0057711189: - -Obtaining ECS Console Logs -========================== - -Scenarios ---------- - -When an ECS cannot start or run properly, you can download and view ECS console logs for troubleshooting, for example, checking whether the kernel and service configuration are correct. - -The ECS console logs record ECS operations, such as ECS starting, stopping, restarting, or forcibly restarting. Through the management console, you can obtain the ECS logs within one hour. - -Notes ------ - -- The system does not record the logs for forcible ECS stopping. -- The system supports viewing console logs for the ECSs running the following OSs: - - - Red Hat Enterprise Linux 6.x series - - Red Hat Enterprise Linux 7.x series - - CentOS 6.x series - - CentOS 7.x series - - Ubuntu 14.x series - - Ubuntu 16.x series - - SUSE 11.x series - - SUSE 12.x series - - OpenSUSE 13.x series - - OpenSUSE 42.x series - - Debine 16.x series - - Fedora series - - Freebsd series - - CoreOS series - -- The ECSs running Windows do not support console logs. -- The system can save up to 100 KB log files. - -Procedure ---------- - -#. Log in to the ECS. - -#. Check and modify the grub file. - - The configuration method varies depending on the OS. - - .. note:: - - To prevent impact on the start of the recovery mode, you are advised to modify only the item used for the default start. - - - For CentOS and Red Hat 6, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub/menu.lst** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system), add **console=ttyS0** to its end, and delete parameter **rhgb quiet**. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For CentOS 7, Red Hat 7, and Ubuntu 14, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub2/grub.cfg** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system), add **console=ttyS0** to its end, and delete parameter **rhgb quiet**. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For SUSE Linux 11, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub/menu.1st** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system) and add **console=ttyS0** to its end. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For SUSE Linux 12, openSUSE 13, and openSUSE 42, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub2/grub.cfg** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system) and add **console=ttyS0** to its end. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For Debian and Ubuntu 16, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub/grub.cfg** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system) and add **console=ttyS0** to its end. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For Fedora, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/grub2/grub.cfg** - - b. Locate the row that contains **linux**, **linux16**, or **kernel** (depending on the system) and add **console=ttyS0** to its end. If **console=ttyS0** already exists, you do not need to add it. Save the change and exit. - - - For FreeBSD, perform the following steps: - - a. Run the following command to open the configuration file: - - **vi /boot/loader.conf** - - b. Add **console="comconsole"**. If **console="comconsole"** already exists, you do not need to add it. Save the change and exit. - - - For CoreOS, perform the following steps: - - a. Run the following command to check whether **ttyS0** has been configured: - - **cat /proc/cmdline \| grep ttyS0** - - - If yes, **ttyS0** has been configured. - - If no, **ttyS0** has not been configured. Go to :ref:`2.b `. - - b. .. _en-us_topic_0057711189__en-us_topic_0057450886_li29451607172853: - - Run the following command to open the configuration file to be edited: - - **vi /usr/share/oem/grub.cfg** - - .. note:: - - If the **/usr/share/oem/grub.cfg** configuration file does not exist, manually create the file. - - c. Add **set linux_append="console=ttyS0"**. If **set linux_append="console=ttyS0"** already exists, you do not need to add it. Save the change and exit. - -#. On the **Elastic Cloud Server** page, click **Restart**. - -#. Obtain ECS console logs. - - a. Log in to the management console. - - b. Click |image1| in the upper left corner and select your region and project. - - c. Under **Computing**, click **Elastic Cloud Server**. - - d. On the **Elastic Cloud Server** page, click the name of the target ECS. - - e. On the page providing details about the ECS, click the **Console Logs** tab. - - f. Choose the number of lines to be displayed for a log from the **Displayed Lines** drop-down list. - - g. Click **Query**. - - View details of the displayed log. - - .. note:: - - After you click **Query**, the system will not automatically update the displayed log. To view the latest log, click **Query** again. - - h. (Optional) Click **Download** to download the information of the displayed log. - - Downloaded log files are in .txt format. - -Related Links -------------- - -:ref:`Why Does the System Display a Question Mark When I Attempt to Obtain Console Logs? ` - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/managing_ecss/reinstalling_the_os.rst b/ecs/umn/result/instances/managing_ecss/reinstalling_the_os.rst deleted file mode 100644 index b7963e38..00000000 --- a/ecs/umn/result/instances/managing_ecss/reinstalling_the_os.rst +++ /dev/null @@ -1,100 +0,0 @@ -:original_name: en-us_topic_0024911405.html - -.. _en-us_topic_0024911405: - -Reinstalling the OS -=================== - -Scenarios ---------- - -If the OS of an ECS fails to start or requires optimization, reinstall the OS. - -Notes ------ - -- After the OS is reinstalled, the IP and MAC addresses of the ECS remain unchanged. -- Reinstalling the OS clears the data in all partitions of the EVS system disk, including the system partition. Therefore, back up data before reinstalling the OS. -- Reinstalling the OS does not affect data disks. -- Do not perform any operations on the ECS immediately after its OS is reinstalled. Wait for several minutes until the system successfully injects the password or key. Otherwise, the injection may fail, and the ECS cannot be logged in to. -- After the OS is reinstalled, the password for logging in to the ECS will be reset. To retrieve the password, perform the following operations: - - - For a Linux ECS, log in to it using the key and set a new password. For instructions about how to log in to an ECS using a key pair, see :ref:`Login Using an SSH Key `. - - For a Windows ECS, retrieve the password by following the instructions provided in :ref:`Obtaining the Password for Logging In to a Windows ECS `. - -- You can choose to encrypt the system disk of an ECS during OS reinstallation. - -Constraints ------------ - -- The EVS disk quota must be greater than 0. -- If the target ECS is created using a private image, ensure that the private image is available. -- H2 ECSs do not support OS reinstallation. -- If an ECS OS is to be reinstalled using a full-ECS image, the ECS system disk can be encrypted. - -Prerequisites -------------- - -- The target ECS is stopped. -- The target ECS has a system disk attached. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. .. _en-us_topic_0024911405__li20776247143354: - - Under **Computing**, click **Elastic Cloud Server**. - -#. Locate the row containing the target ECS. Click **More** in the **Operation** column and select **Manage Image/Disk** > **Reinstall OS**. - - Only stopped ECSs support OS reinstallation. If the ECS is not stopped, stop it before proceeding with reinstallation. - -#. (Optional) Select the **Encryption** option to encrypt the system disk during OS reinstallation. - - To enable encryption, click **Create Xrole** to assign KMS access permissions to EVS. If you have rights granting permission, assign the KMS access permissions to EVS. If you do not have the permission, contact the user having the security administrator rights to assign the KMS access permissions. For more details, see :ref:`Can All Users Use the Encryption Feature? ` - - Encryption parameters are as follows: - - - **Encryption**: indicates that the EVS disk has been encrypted. - - **Create Xrole**: assigns KMS access permissions to EVS to obtain KMS keys. After the permissions are assigned, follow-up operations do not require assigning permissions again. - - **KMS Key Name**: specifies the name of the key used by the encrypted EVS disk. You can select an existing key, or click **Create KMS Key** and create a new one on the KMS console. The default value is **evs/default**. - - **Xrole Name: EVSAccessKMS**: specifies that permissions have been assigned to EVS to obtain KMS keys for encrypting or decrypting EVS disks. - - **KMS Key ID**: specifies the ID of the key used by the encrypted data disk. - -#. (Optional) Select a **License Type** (**Use license from the system** or **Bring your own license (BYOL)**) if the reinstalled OS running on your ECS is billed. For more details, see :ref:`License Type `. - - The following OSs are billed: - - - SUSE Linux Enterprise Server - - Oracle Enterprise Linux - - Red Hat Enterprise Linux - -#. Configure the login mode. - - If the target ECS uses key pair authentication, you can replace the original key pair. - -#. Click **OK**. - -#. .. _en-us_topic_0024911405__li31062819143541: - - On the **ECS OS Reinstallation** page, confirm the OS specifications, and click **Submit Application**. - - After the request is submitted, the ECS status changes to **Reinstalling**. The reinstallation has been completed when the ECS status changes to **Running**. - - .. note:: - - A temporary ECS is created during the reinstallation process. After reinstallation, this ECS will be automatically deleted. Do not perform any operation on the temporary ECS during the reinstallation process. - -Follow-up Procedure -------------------- - -If the reinstallation is unsuccessful, perform steps :ref:`3 ` to :ref:`9 ` again to retry reinstalling the OS again. - -If the second reinstallation attempt is unsuccessful, contact customer service for manual recovery at the backend. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/migrating_an_ecs.rst b/ecs/umn/result/instances/migrating_an_ecs.rst deleted file mode 100644 index 653db43e..00000000 --- a/ecs/umn/result/instances/migrating_an_ecs.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0133365988.html - -.. _en-us_topic_0133365988: - -Migrating an ECS -================ - -Scenarios ---------- - -ECSs can be migrated between DeHs and public resource pools. - -- An ECS created on a DeH can be migrated to another DeH. -- An ECS created on a DeH can be migrated to a public resource pool. -- An ECS deployed in a public resource pool can be migrated to a DeH. - -Notes ------ - -- Only a stopped ECS can be migrated. -- CBR and CSBS backups are not affected by cold migrations. -- ECS IDs remain unchanged after a cold migration. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, select the target ECS. - -#. Click **Migrate ECS** in the **Operation** column. - -#. In the **Migrate ECS** dialog box, migrate the ECS as prompted. - - - If you want to migrate the ECS to a DeH, select a DeH from the list. - - If you want to migrate the ECS to another DeH, select **Migrated** **To another DeH**. - - If you want to migrate the ECS from a DeH to a public resource pool, select **Migrated** **Out of DeH**. - -#. Click **OK**. - - The ECS is migrated as required. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/general_operations_for_modifying_specifications.rst b/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/general_operations_for_modifying_specifications.rst deleted file mode 100644 index 9bf3a1a6..00000000 --- a/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/general_operations_for_modifying_specifications.rst +++ /dev/null @@ -1,122 +0,0 @@ -:original_name: en-us_topic_0013771092.html - -.. _en-us_topic_0013771092: - -General Operations for Modifying Specifications -=============================================== - -Scenarios ---------- - -If ECS specifications do not meet service requirements, you can modify the ECS specifications, including vCPUs and memory. Certain ECSs allow you to change their types when you modify their specifications. - -- For instructions about how to modify the specifications of other ECSs, for example, between KVM ECSs, see this section. - -Background ----------- - -To obtain the virtualization type of an ECS, perform the following operations: - -#. On the page providing details about the ECS, view the ECS specifications. - - .. _en-us_topic_0013771092__fig14561414141716: - - .. figure:: /_static/images/en-us_image_0121090576.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Viewing ECS specifications - -#. Check the specifications tables in :ref:`ECS Types ` for the virtualization type. - -Notes ------ - -- If ECS specifications are downgraded, the ECS performance will deteriorate. -- Certain ECSs do not support specifications modification currently. For details about available ECS types as well as their functions and usage, see "Notes" in :ref:`ECS Types `. -- When the disk status is **Expanding**, you are not allowed to modify the specifications of the ECS where the disk is attached. -- Before modifying the specifications of a Windows ECS, modify the SAN policy by following the instructions provided in :ref:`Why Does a Disk Attached to a Windows ECS Go Offline? ` to prevent disks from going offline after the specifications are modified. -- Before modifying specifications, make sure that the ECS has been stopped. - -Step 1: Modify Specifications ------------------------------ - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, view the status of the target ECS. - - If the ECS is not in **Stopped** state, click **More** in the **Operation** column and select **Stop**. - -#. Click **More** in the **Operation** column and select **Modify Specifications**. - - The **Modify ECS Specifications** page is displayed. - -#. Select the new ECS type, vCPUs, and memory as prompted. - -#. (Optional) Set **DeH**. - - If the ECS is created on a DeH, the system allows you to change the DeH. - - To do so, select the target DeH from the drop-down list. If no DeH is available in the drop-down list, remaining DeH resources are insufficient and cannot be used to create the ECS with specifications modified. - -#. Click **Next**. - -#. On the **Modify ECS Specifications** page, confirm the modified vCPU and memory specifications and click **Submit**. - -#. Check whether the specifications have been modified. - - After modifying the specifications, you can check whether the specifications have been modified in **Failures**. - - a. Check whether **Failures** is displayed on the management console. For details, see :ref:`Viewing Failures `. - - - If yes, go to step :ref:`10.b `. - - If no, the specifications have been modified. - - b. .. _en-us_topic_0013771092__li6253192246: - - Click **Failures**. Then, in the **Failures** dialog box, click **Operation Failures** and check whether the task is contained in the list by **Name/ID**, **Operated At**, or **Task**. - - - If yes, the specifications modification failed. See :ref:`Follow-up Procedure ` for failure causes. - - If no, the specifications have been modified. - -Step 2: Check Disk Attachment ------------------------------ - -After specifications are modified, disk attachment may fail. Therefore, check disk attachment after specifications modification. If disks are properly attached, the specifications modification is successful. - -- Windows ECS - - For details, see :ref:`Why Do the Disks of a Windows ECS Go Offline After I Modify the ECS Specifications? ` - -- Linux ECS - - For details, see :ref:`Why Does the Disk Attachment of a Linux ECS Fail After I Modify the ECS Specifications? ` - -.. _en-us_topic_0013771092__section9461027528: - -Follow-up Procedure -------------------- - -Perform the following operations in the event of a specifications modification failure: - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Cloud Trace Service**. - -#. In the navigation pane on the left, choose **Trace List**. - -#. In the **Trace Name** column, locate the **resizeServer** event by resource ID. - - The resource ID is the ID of the ECS on which the specifications modification failed. - -#. Click **View Trace** in the **Operation** column to view the failure cause. - - If the fault cannot be rectified based on logs, contact customer service. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/index.rst b/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/index.rst deleted file mode 100644 index 137e0f8f..00000000 --- a/ecs/umn/result/instances/modifying_ecs_vcpu_and_memory_specifications/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0030828258: - -============================================ -Modifying ECS vCPU and Memory Specifications -============================================ - -.. toctree:: - :maxdepth: 1 - - general_operations_for_modifying_specifications diff --git a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/index.rst b/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/index.rst deleted file mode 100644 index 87fe7bb7..00000000 --- a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0140313879: - -======================================== -Obtaining Metadata and Passing User Data -======================================== - -.. toctree:: - :maxdepth: 1 - - obtaining_metadata - passing_user_data_to_ecss diff --git a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/obtaining_metadata.rst b/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/obtaining_metadata.rst deleted file mode 100644 index 122ecf91..00000000 --- a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/obtaining_metadata.rst +++ /dev/null @@ -1,509 +0,0 @@ -:original_name: en-us_topic_0042400609.html - -.. _en-us_topic_0042400609: - -Obtaining Metadata -================== - -Scenarios ---------- - -ECS metadata includes basic information of an ECS on the cloud platform, such as the ECS ID, hostname, and network information. ECS metadata can be obtained using either OpenStack or EC2 compatible APIs, as shown in :ref:`Table 1 `. The following describes the URI and methods of using the supported ECS metadata. - -Notes ------ - -If the metadata contains sensitive data, take appropriate measures to protect the sensitive data, for example, controlling access permissions and encrypting the data. - -Perform the following configuration on the firewall: - -- Windows - - If you need to assign permissions to only the administrator to access custom data, enable the firewall as an administrator and run the following commands in PowerShell: - - **PS C:\>$RejectPrincipal = New-Object -TypeName System.Security.Principal.NTAccount ("Everyone")** - - **PS C:\>$RejectPrincipalSID = $RejectPrincipal.Translate([System.Security.Principal.SecurityIdentifier]).Value** - - **PS C:\>$ExceptPrincipal = New-Object -TypeName System.Security.Principal.NTAccount ("Administrator")** - - **PS C:\>$ExceptPrincipalSID = $ExceptPrincipal.Translate([System.Security.Principal.SecurityIdentifier]).Value** - - **PS C:\>$PrincipalSDDL = "O:LSD:(D;;CC;;;$ExceptPrincipalSID)(A;;CC;;;$RejectPrincipalSID)"** - - **PS C:\>New-NetFirewallRule -DisplayName "Reject metadata service for $($RejectPrincipal.Value), exception: $($ExceptPrincipal.Value)" -Action block -Direction out -Protocol TCP -RemoteAddress 169.254.169.254 -LocalUser $PrincipalSDDL** - -- Linux - - If you need to assign permissions to only user **root** to access custom data, run the following command as user **root**: - - **iptables --append OUTPUT --proto tcp --destination 169.254.169.254 --match owner ! --uid-owner root --jump REJECT** - -ECS Metadata Types ------------------- - -:ref:`Table 1 ` does not contain metadata items ami-id, ami-launch-index, ami-manifest-path, block-device-mapping/, instance-action, instance-id and reservation-id. These metadata items are not compatible with EC2 and are not recommended. - -.. _en-us_topic_0042400609__table273552371680: - -.. table:: **Table 1** ECS metadata types - - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Metadata Type | Metadata Item | Description | - +=======================+========================================+======================================================================================================================================================================================================+ - | OpenStack | /meta_data.json | Displays ECS metadata. | - | | | | - | | | For the key fields in the ECS metadata, see :ref:`Table 2 `. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OpenStack | /password | Displays the password for logging in to an ECS. | - | | | | - | | | This metadata is used by Cloudbase-Init to store ciphertext passwords during initialization of key-pair-authenticated Windows ECSs. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OpenStack | /user_data | Displays ECS user data. | - | | | | - | | | This metadata allows you to specify scripts and configuration files for initializing ECSs. For details, see :ref:`Passing User Data to ECSs `. | - | | | | - | | | For password-authenticated Linux ECSs, this metadata is used to save password injection scripts. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OpenStack | /network_data.json | Displays ECS network information. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | OpenStack | /securitykey | Obtains temporary AKs and SKs. | - | | | | - | | | Before enabling an ECS to obtain a temporary AK and SK, make sure that the **op_svc_ecs** account has been authorized on IAM and that the desired ECS resources have been authorized for management. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/hostname | Displays the name of the host accommodating an ECS. | - | | | | - | | | To remove the suffix **.novalocal** from an ECS, see: | - | | | | - | | | :ref:`Is an ECS Hostname with Suffix .novalocal Normal? ` | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/local-hostname | The meaning of this field is the same as that of hostname. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/public-hostname | The meaning of this field is the same as that of hostname. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/instance-type | Displays an ECS flavor. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/local-ipv4 | Displays the fixed IP address of an ECS. | - | | | | - | | | If there are multiple NICs, only the IP address of the primary NIC is displayed. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/placement/availability-zone | Displays the AZ accommodating an ECS. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/public-ipv4 | Displays the EIP bound to an ECS. | - | | | | - | | | If there are multiple NICs, only the EIP of the primary NIC is displayed. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/public-keys/0/openssh-key | Displays the public key of an ECS. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /user-data | Displays ECS user data. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | EC2 | /meta-data/security-groups | Displays the security group to which an ECS belongs. | - +-----------------------+----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0042400609__table2373623012315: - -.. table:: **Table 2** Metadata key fields - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================+ - | uuid | String | Specifies an ECS ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------+ - | availability_zone | String | Specifies the AZ where an ECS locates. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------+ - | meta | Dict | Specifies the metadata information, including the image name, image ID, and VPC ID. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------+ - | hostname | String | Specifies the name of the host accommodating an ECS. | - | | | | - | | | To remove the suffix **.novalocal** from an ECS, see: | - | | | | - | | | :ref:`Is an ECS Hostname with Suffix .novalocal Normal? ` | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------+ - -Prerequisites -------------- - -- The target ECS has been logged in. -- Security group rules in the outbound direction meet the following requirements: - - - **Protocol**: **TCP** - - **Port**: **80** - - **Destination**: **169.254.0.0/16** - - .. note:: - - If you use the default security group rules for the outbound direction, the preceding requirements are met. Then, the metadata can be accessed. Default security group rules for the outbound direction are as follows: - - - **Protocol**: **All** - - **Port**: **All** - - **Destination**: **0.0.0.0/0** - -Metadata (OpenStack Metadata API) ---------------------------------- - -Displays ECS metadata. - -- URI - - /169.254.169.254/openstack/latest/meta_data.json - -- Usage method - - Supports GET requests. - -- Example - - To use cURL to view Linux ECS metadata, run the following command: - - **curl http://169.254.169.254/openstack/latest/meta_data.json** - - To use Invoke-RestMethod to view Windows ECS metadata, run the following command: - - **Invoke-RestMethod http://169.254.169.254/openstack/latest/meta_data.json \| ConvertTo-Json** - - .. code-block:: - - { - "random_seed": "rEocCViRS+dNwlYdGIxJHUp+00poeUsAdBFkbPbYQTmpNwpoEb43k9z+96TyrekNKS+iLYDdRNy4kKGoNPEVBCc05Hg1TcDblAPfJwgJS1okqEtlcofUhKmL3K0fto+5KXEDU3GNuGwyZXjdVb9HQWU+E1jztAJjjqsahnU+g/tawABTVySLBKlAT8fMGax1mTGgArucn/WzDcy19DGioKPE7F8ILtSQ4Ww3VClK5VYB/h0x+4r7IVHrPmYX/bi1Yhm3Dc4rRYNaTjdOV5gUOsbO3oAeQkmKwQ/NO0N8qw5Ya4l8ZUW4tMav4mOsRySOOB35v0bvaJc6p+50DTbWNeX5A2MLiEhTP3vsPrmvk4LRF7CLz2J2TGIM14OoVBw7LARwmv9cz532zHki/c8tlhRzLmOTXh/wL36zFW10DeuReUGmxth7IGNmRMQKV6+miI78jm/KMPpgAdK3vwYF/GcelOFJD2HghMUUCeMbwYnvijLTejuBpwhJMNiHA/NvlEsxJDxqBCoss/Jfe+yCmUFyxovJ+L8oNkTzkmtCNzw3Ra0hiKchGhqK3BIeToV/kVx5DdF081xrEA+qyoM6CVyfJtEoz1zlRRyoo9bJ65Eg6JJd8dj1UCVsDqRY1pIjgzE/Mzsw6AaaCVhaMJL7u7YMVdyKzA6z65Xtvujz0Vo=", - "uuid": "ca9e8b7c-f2be-4b6d-a639-f10b4d994d04", - "availability_zone": "lt-test-1c", - "hostname": "ecs-ddd4-l00349281.novalocal", - "launch_index": 0, - "meta": { - "metering.image_id": "3a64bd37-955e-40cd-ab9e-129db56bc05d", - "metering.imagetype": "gold", - "metering.resourcespeccode": "s3.medium.1.linux", - "image_name": "CentOS 7.6 64bit", - "os_bit": "64", - "vpc_id": "3b6c201f-aeb3-4bce-b841-64756e66cb49", - "metering.resourcetype": "1", - "cascaded.instance_extrainfo": "pcibridge:2", - "os_type": "Linux", - "charging_mode": "0" - }, - "project_id": "6e8b0c94265645f39c5abbe63c4113c6", - "name": "ecs-ddd4-l00349281" - } - -User Data (OpenStack Metadata API) ----------------------------------- - -Displays ECS user data. The value is configured only when you create an ECS. It cannot be changed after the configuration. - -- URI - - /169.254.169.254/openstack/latest/user_data - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/openstack/latest/user_data** - - Windows: - - **Invoke-RestMethod** **http://169.254.169.254/openstack/latest/user_data** - - .. code-block:: - - ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA== - - .. note:: - - If user data was not passed to the ECS during ECS creation, the query result is 404. - - .. _en-us_topic_0042400609__fig124601338153316: - - .. figure:: /_static/images/en-us_image_0166755236.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** 404 Not Found - -Network Data (OpenStack Metadata API) -------------------------------------- - -Displays information about all NICs attached to an ECS, including their DNS server addresses, network bandwidth, IDs, private IP addresses, EIPs, and MAC addresses. - -- URI - - /openstack/latest/network_data.json - -- Usage method - - Supports GET requests. - -- Example - - .. note:: - - **instance_max_bandwidth** and **instance_min_bandwidth** are in the unit of Mbit/s. If the value is **-1**, the bandwidth is not limited. - - Linux: - - **curl http://169.254.169.254/openstack/latest/network_data.json** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/openstack/latest/network_data.json \| ConvertTo-Json** - - .. code-block:: - - { - "services": [{ - "type": "dns", - "address": "xxx.xx.x.x" - }, - { - "type": "dns", - "address": "100.1 - 25.21.250" - }], - "networks": [{ - "network_id": "67dc10ce-441f-4592-9a80-cc709f6436e7", - "type": "i - pv4_dhcp", - "link": "tap68a9272d-71", - "id": "network0" - }], - "links": [{ - "type": "cascading", - "vif_id": "68a9272d-7152-4ae7-a138-3ef53af669e7", - "ethernet_mac_address": "fa:16:3e:f7:c1:47", - "id": "tap68a9272d-71", - "mtu": null - - }], - "qos":{ - "instance_max_bandwidth": 1200, - "instance_min_bandwidth": 4000 - } - } - -Security Key (OpenStack Metadata API) -------------------------------------- - -Obtains temporary AKs and SKs. - -.. note:: - - - If an ECS needs to obtain a temporary AK and SK, go to the ECS details page, and configure **Agency** for the ECS in the **Management Information** area so that the ECS is authorized on IAM. - - The validity period of a temporary AK and SK is one hour. The temporary AK and SK are updated 10 minutes ahead of the expiration time. During the 10 minutes, both the new and old temporary AKs and SKs can be used. - - When using temporary AKs and SKs, add **'X-Security-Token':{securitytoken}** in the message header. **securitytoken** is the value returned when a call is made to the API. - -- URI - - /openstack/latest/securitykey - -- Usage method - - Supports GET requests. - -- Examples - - Linux: - - **curl http://169.254.169.254/openstack/latest/securitykey** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/openstack/latest/securitykey** - -User Data (EC2 Compatible API) ------------------------------- - -Displays ECS user data. The value is configured only when you create an ECS. It cannot be changed after the configuration. - -- URI - - /169.254.169.254/latest/user-data - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/user-data** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/user-data** - - .. code-block:: - - ICAgICAgDQoiQSBjbG91ZCBkb2VzIG5vdCBrbm93IHdoeSBpdCBtb3ZlcyBpbiBqdXN0IHN1Y2ggYSBkaXJlY3Rpb24gYW5kIGF0IHN1Y2ggYSBzcGVlZC4uLkl0IGZlZWxzIGFuIGltcHVsc2lvbi4uLnRoaXMgaXMgdGhlIHBsYWNlIHRvIGdvIG5vdy4gQnV0IHRoZSBza3kga25vd3MgdGhlIHJlYXNvbnMgYW5kIHRoZSBwYXR0ZXJucyBiZWhpbmQgYWxsIGNsb3VkcywgYW5kIHlvdSB3aWxsIGtub3csIHRvbywgd2hlbiB5b3UgbGlmdCB5b3Vyc2VsZiBoaWdoIGVub3VnaCB0byBzZWUgYmV5b25kIGhvcml6b25zLiINCg0KLVJpY2hhcmQgQmFjaA== - -Hostname (EC2 Compatible API) ------------------------------ - -Displays the name of the host accommodating an ECS. The .novalocal suffix will be added later. - -- URI - - /169.254.169.254/latest/meta-data/hostname - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/hostname** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/hostname** - - .. code-block:: - - vm-test.novalocal - -Instance Type (EC2 Compatible API) ----------------------------------- - -Displays an ECS flavor. - -- URI - - /169.254.169.254/latest/meta-data/instance-type - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/instance-type** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/instance-type** - - .. code-block:: - - s3.medium.1 - -Local IPv4 (EC2 Compatible API) -------------------------------- - -Displays the fixed IP address of an ECS. If there are multiple NICs, only the IP address of the primary NIC is displayed. - -- URI - - /169.254.169.254/latest/meta-data/local-ipv4 - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/local-ipv4** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/local-ipv4** - - .. code-block:: - - 192.1.1.2 - -Availability Zone (EC2 Compatible API) --------------------------------------- - -Displays the AZ accommodating an ECS. - -- URI - - /169.254.169.254/latest/meta-data/placement/availability-zone - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/placement/availability-zone** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/placement/availability-zone** - - .. code-block:: - - az1.dc1 - -Public IPv4 (EC2 Compatible API) --------------------------------- - -Displays the EIP bound to an ECS. If there are multiple NICs, only the EIP of the primary NIC is displayed. - -- URI - - /169.254.169.254/latest/meta-data/public-ipv4 - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/public-ipv4** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/public-ipv4** - - .. code-block:: - - 46.1.1.2 - -Public Keys (EC2 Compatible API) --------------------------------- - -Displays the public key of an ECS. - -- URI - - /169.254.169.254/latest/meta-data/public-keys/0/openssh-key - -- Usage method - - Supports GET requests. - -- Example - - Linux: - - **curl http://169.254.169.254/latest/meta-data/public-keys/0/openssh-key** - - Windows: - - **Invoke-RestMethod http://169.254.169.254/latest/meta-data/public-keys/0/openssh-key** - - .. code-block:: - - ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDI5Fw5k8Fgzajn1zJwLoV3+wMP+6CyvsSiIc/hioggSnYu/AD0Yqm8vVO0kWlun1rFbdO+QUZKyVr/OPUjQSw4SRh4qsTKf/+eFoWTjplFvd1WCBZzS/WRenxIwR00KkczHSJro763+wYcwKieb4eKRxaQoQvoFgVjLBULXAjH4eKoKTVNtMXAvPP9aMy2SLgsJNtMb9ArfziAiblQynq7UIfLnN3VclzPeiWrqtzjyOp6CPUXnL0lVPTvbLe8sUteBsJZwlL6K4i+Y0lf3ryqnmQgC21yW4Dzu+kwk8FVT2MgWkCwiZd8gQ/+uJzrJFyMfUOBIklOBfuUENIJUhAB Generated-by-Nova - -Helpful Links -------------- - -:ref:`Why Can't My Linux ECS Obtain Metadata? ` diff --git a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/passing_user_data_to_ecss.rst b/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/passing_user_data_to_ecss.rst deleted file mode 100644 index 14f82d93..00000000 --- a/ecs/umn/result/instances/obtaining_metadata_and_passing_user_data/passing_user_data_to_ecss.rst +++ /dev/null @@ -1,416 +0,0 @@ -:original_name: en-us_topic_0032380449.html - -.. _en-us_topic_0032380449: - -Passing User Data to ECSs -========================= - -Scenarios ---------- - -Use the **User Data** function to pass user data to ECSs to: - -- Simplify ECS configuration. -- Initialize the ECS OS configuration. -- Upload your scripts to ECSs during ECS creation. -- Perform other tasks using scripts. - -Use Restrictions ----------------- - -- Linux - - - The image that is used to create ECSs must have Cloud-Init installed. - - - The user data to be specified must be less than or equal to 32 KB. - - If user data is uploaded as text, the data can contain only ASCII characters. If user data is uploaded using a file, the file can contain any characters and the file size cannot exceed 32 KB. - - The image that is used to create ECSs must be a public image, a private image created based on a public image, or a private image with Cloud-Init installed. - - The format of the customized scripts must be supported by Linux ECSs. - - DHCP must be enabled on the VPC network, and port 80 must be enabled for the security group in the outbound direction. - -- Windows - - - The image that is used to create ECSs must have Cloudbase-Init installed. - - The user data to be specified must be less than or equal to 32 KB. - - If user data is uploaded as text, the data can contain only ASCII characters. If user data is uploaded using a file, the file can contain any characters and the file size cannot exceed 32 KB. - - The image that is used to create ECSs must be a public image, a private image created based on a public image, or a private image with Cloudbase-Init installed. - - DHCP must be enabled on the VPC network, and port 80 must be enabled for the security group in the outbound direction. - -Passing User Data ------------------ - -#. Create a user data script, the format of which complies with user data script specifications. For details, see :ref:`Helpful Links `. - -#. When creating an ECS, set **Advanced Options** to **Configure now**, and paste the content of the user data script to the **User Data** text box or upload the user data file. - - .. note:: - - You can pass user data to an ECS as text or as a file. - - Text: Copy the content of the user data script to the text box. - - File: Save the user data script to a text file and then upload the file. - - .. _en-us_topic_0032380449__fig87313493915: - - .. figure:: /_static/images/en-us_image_0237026761.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** User Data - -#. The created ECS automatically runs Cloud-Init/Cloudbase-Init and reads the user data script upon startup. - -User Data Scripts of Linux ECSs -------------------------------- - -Customized user data scripts of Linux ECSs are based on the open-source Cloud-Init architecture. This architecture uses ECS metadata as the data source for automatically configuring the ECSs. The customized script types are compatible with open-source Cloud-Init. For details about Cloud-Init, see http://cloudinit.readthedocs.io/en/latest/topics/format.html. - -- Script execution time: A customized user data script is executed after the time when the status of the target ECS changes to **Running** and before the time when **/etc/init** is executed. - - .. note:: - - By default, the scripts are executed as user **root**. - -- Script type: Both user-data scripts and Cloud-Config data scripts are supported. - - .. table:: **Table 1** Linux ECS script types - - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | - | User-Data Script | Cloud-Config Data Script | - +=======================+==============================================================================================================================================+===========================================================================================================================+ - | Description | Scripts, such as Shell and Python scripts, are used for custom configurations. | Methods pre-defined in Cloud-Init, such as the Yum source and SSH key, are used for configuring certain ECS applications. | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Format | A script must be started with **#!**, for example, **#!/bin/bash** and **#!/usr/bin/env python**. | The first line must be **#cloud-config**, and no space is allowed in front of it. | - | | | | - | | When a script is started for the first time, it will be executed at the rc.local-like level, indicating a low priority in the boot sequence. | | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Constraint | Before Base64 encoding, the size of the script, including the first line, cannot exceed 32 KB. | Before Base64 encoding, the size of the script, including the first line, cannot exceed 32 KB. | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - | Frequency | The script is executed only once when the ECS is started for the first time. | The execution frequency varies according to the applications configured on the ECS. | - +-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------+ - -- How can I view the customized user data passed to a Linux ECS? - - #. Log in to the ECS. - - #. Run the following command to view the customized user data as user **root**: - - **curl http://169.254.169.254/openstack/latest/user_data** - -- Script usage examples - - This section describes how to inject scripts in different formats into Linux ECSs and view script execution results. - - **Example 1: Inject a user-data script.** - - When creating an ECS, set **User Data** to **As text** and enter the customized user data script. - - .. code-block:: - - #!/bin/bash - echo "Hello, the time is now $(date -R)" | tee /root/output.txt - - After the ECS is created, start it and run the **cat** *[file]* command to check the script execution result. - - .. code-block:: - - [root@XXXXXXXX ~]# cat /root/output.txt - Hello, the time is now Mon, 16 Jul 2016 16:03:18+0800 - - **Example 2: Inject a Cloud-Config data script.** - - When creating an ECS, set **User Data** to **As text** and enter the customized user data script. - - .. code-block:: - - #cloud-config - bootcmd: - - echo 192.168.1.130 us.archive.ubuntu.com >> /etc/hosts - - After the ECS is created, start it and run the **cat /etc/hosts** command to check the script execution result. - - .. _en-us_topic_0032380449__fig1787242875415: - - .. figure:: /_static/images/en-us_image_0115931570.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Viewing operating results - -User Data Scripts of Windows ECSs ---------------------------------- - -Customized user data scripts of Windows ECSs are based on the open-source Cloudbase-Init architecture. This architecture uses ECS metadata as the data source for initializing and automatically configuring the ECSs. The customized script types are compatible with open-source Cloudbase-Init. For details about Cloudbase-Init, see https://cloudbase-init.readthedocs.io/en/latest/userdata.html. - -- Script type: Both batch-processing program scripts and PowerShell scripts are supported. - - .. table:: **Table 2** Windows ECS script types - - +------------+---------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | - | Batch-Processing Program Script | PowerShell Script | - +============+=============================================================================================================================================+==========================================================================================================================================+ - | Format | The script must be started with **rem cmd**, which is the first line of the script. No space is allowed at the beginning of the first line. | The script must be started with **#ps1**, which is the first line of the script. No space is allowed at the beginning of the first line. | - +------------+---------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Constraint | Before Base64 encoding, the size of the script, including the first line, cannot exceed 32 KB. | Before Base64 encoding, the size of the script, including the first line, cannot exceed 32 KB. | - +------------+---------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -- How can I view the customized user data passed into a Windows ECS? - - #. Log in to the ECS. - - #. Access the following URL in the address box of the browser and view the user data: - - **http://169.254.169.254/openstack/latest/user_data** - -- Script usage examples - - This section describes how to inject scripts in different formats into Windows ECSs and view script execution results. - - **Example 1: Inject a batch-processing program script.** - - When creating an ECS, set **User Data** to **As text** and enter the customized user data script. - - .. code-block:: - - rem cmd - echo "Hello, BAT Test" > C:\1111.txt - - After the ECS is created, start it and check the script execution result. In this example, a text file named **1111** is added to disk C:\. - - .. _en-us_topic_0032380449__fig8622411077: - - .. figure:: /_static/images/en-us_image_0115932123.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Creating text file (Batch) - - To view the user data passed to the Windows ECS, log in at http://169.254.169.254/openstack/latest/user_data. - - .. _en-us_topic_0032380449__fig14281122141212: - - .. figure:: /_static/images/en-us_image_0115932873.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Viewing user data (Batch) - - **Example 2: Inject a PowerShell script.** - - When creating an ECS, set **User Data** to **As text** and enter the customized user data script. - - .. code-block:: - - #ps1 - echo "Hello, Powershell Test" > C:\aaaa.txt - - After the ECS is created, start it and check the script execution result. In this example, a text file named **aaaa** is added to disk C:\. - - .. _en-us_topic_0032380449__fig103618447159: - - .. figure:: /_static/images/en-us_image_0115933029.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Creating text file (PowerShell) - - To view the user data passed to the Windows ECS, log in at http://169.254.169.254/openstack/latest/user_data. - - .. _en-us_topic_0032380449__fig124617204176: - - .. figure:: /_static/images/en-us_image_0115934291.jpg - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Viewing user data (PowerShell) - -Case 1 ------- - -This case illustrates how to use the user data passing function to simplify Linux ECS configuration. - -In this example, vim is configured to enable syntax highlighting, display line numbers, and set the tab stop to **4**. The .vimrc configuration file is created and injected into the **/root/.vimrc** directory during ECS creation. After the ECS is created, vim is automatically configured based on your requirements. This improves ECS configuration efficiency, especially in batch ECS creation scenarios. - -User data example: - -.. code-block:: - - #cloud-config - write_files: - - path: /root/.vimrc - content: | - syntax on - set tabstop=4 - set number - -Case 2 ------- - -This case illustrates how to use the user data passing function to set the password for logging in to a Linux ECS. - -.. note:: - - The new password must meet the password complexity requirements listed in :ref:`Table 3 `. - -.. _en-us_topic_0032380449__en-us_topic_0021426802_table4381109318958: - -.. table:: **Table 3** Password complexity requirements - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Requirement | Example Value | - +=======================+==============================================================================================================================================================+===============================================================+ - | Password | - Consists of 8 to 26 characters. | YNbUwp!dUc9MClnv | - | | - Contains at least three of the following character types: | | - | | | .. note:: | - | | - Uppercase letters | | - | | - Lowercase letters | The example password is generated randomly. Do not use it. | - | | - Digits | | - | | - Special characters: $!@%-_=+[]:./^,{}? | | - | | | | - | | - Cannot contain the username or the username spelled backwards. | | - | | - Cannot contain more than two consecutive characters in the same sequence as they appear in the username. (This requirement applies only to Windows ECSs.) | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -User data example: - -- Using a ciphertext password (recommended) - - .. code-block:: - - #!/bin/bash - echo 'root:$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig' | chpasswd -e; - - In the preceding command output, **$6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig** is the ciphertext password, which can be generated as follows: - - #. Run the following command to generate an encrypted ciphertext value: - - **python -c "import crypt, getpass, pwd;print crypt.mksalt()"** - - The following information is displayed: - - .. code-block:: - - $6$V6azyeLwcD3CHlpY - - #. Run the following command to generate a ciphertext password based on the salt value: - - **python -c "import crypt, getpass, pwd;print crypt.crypt('Cloud.1234','\$6\$V6azyeLwcD3CHlpY')"** - - The following information is displayed: - - .. code-block:: - - $6$V6azyeLwcD3CHlpY$BN3VVq18fmCkj66B4zdHLWevqcxlig - -After the ECS is created, you can use the password to log in to it. - -Case 3 ------- - -This case illustrates how to use the user data passing function to reset the password for logging in to a Linux ECS. - -In this example, the password of user **root** is reset to **\*****\***. - -.. note:: - - The new password must meet the password complexity requirements listed in :ref:`Table 4 `. - -.. _en-us_topic_0032380449__table580060101120: - -.. table:: **Table 4** Password complexity requirements - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Requirement | Example Value | - +=======================+==============================================================================================================================================================+===============================================================+ - | Password | - Consists of 8 to 26 characters. | YNbUwp!dUc9MClnv | - | | - Contains at least three of the following character types: | | - | | | .. note:: | - | | - Uppercase letters | | - | | - Lowercase letters | The example password is generated randomly. Do not use it. | - | | - Digits | | - | | - Special characters: $!@%-_=+[]:./^,{}? | | - | | | | - | | - Cannot contain the username or the username spelled backwards. | | - | | - Cannot contain more than two consecutive characters in the same sequence as they appear in the username. (This requirement applies only to Windows ECSs.) | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -User data example (Retain the indentation in the following script): - -.. code-block:: - - #cloud-config - chpasswd: - list: | - root:****** - expire: False - -After the ECS is created, you can use the reset password to log in to it. To ensure system security, change the password of user **root** after logging in to the ECS for the first time. - -Case 4 ------- - -This case illustrates how to use the user data passing function to create a user on a Windows ECS and configure the password for the user. - -In this example, the user's username is **abc**, its password is **\*****\***, and the user is added to the **administrators** user group. - -.. note:: - - The new password must meet the password complexity requirements listed in :ref:`Table 4 `. - -User data example: - -.. code-block:: - - rem cmd - net user abc ****** /add - net localgroup administrators abc /add - -After the ECS is created, you can use the created username and password to log in to it. - -Case 5 ------- - -This case illustrates how to use the user data passing function to update system software packages for a Linux ECS and enable the HTTPd service. After the user data is passed to an ECS, you can use the HTTPd service. - -User data example: - -.. code-block:: - - #!/bin/bash - yum update -y - service httpd start - chkconfig httpd on - -Case 6 ------- - -This case illustrates how to use the user data passing function to assign user **root** permission for remotely logging in to a Linux ECS. After passing the file to an ECS, you can log in to the ECS as user **root** using SSH key pair authentication. - -User data example: - -.. code-block:: - - #cloud-config - disable_root: false - runcmd: - - sed -i 's/^PermitRootLogin.*$/PermitRootLogin without-password/' /etc/ssh/sshd_config - - sed -i '/^KexAlgorithms.*$/d' /etc/ssh/sshd_config - - service sshd restart - -.. _en-us_topic_0032380449__section54344118153243: - -Helpful Links -------------- - -For more information about user data passing cases, visit the official Cloud-init/Cloudbase-init website: - -- https://cloudinit.readthedocs.io/en/latest/ - -- https://cloudbase-init.readthedocs.io/en/latest/ diff --git a/ecs/umn/result/instances/optional_configuring_mapping_between_hostnames_and_ip_addresses.rst b/ecs/umn/result/instances/optional_configuring_mapping_between_hostnames_and_ip_addresses.rst deleted file mode 100644 index ff46c7cd..00000000 --- a/ecs/umn/result/instances/optional_configuring_mapping_between_hostnames_and_ip_addresses.rst +++ /dev/null @@ -1,90 +0,0 @@ -:original_name: en-us_topic_0074752335.html - -.. _en-us_topic_0074752335: - -(Optional) Configuring Mapping Between Hostnames and IP Addresses -================================================================= - -ECSs in the same VPC can communicate with each other using hostnames. In such a case, you are required to configure the mapping between hostnames and IP addresses. The communication using hostnames is more convenient than that using IP addresses. - -Constraints ------------ - -This method applies only to Linux ECSs. - -Procedure ---------- - -For example, there are two ECSs in a VPC, ecs-01 and ecs-02. Perform the following operations to enable communication using hostnames between ecs-01 and ecs-02: - -#. Log in to ecs-01 and ecs-02 and obtain their private IP addresses. - - a. Log in to the management console. - - b. Under **Computing**, click **Elastic Cloud Server**. - - c. On the **Elastic Cloud Server** page, obtain the private IP address in the **IP Address** column. - - For example, the obtained private IP addresses are as follows: - - ecs-01: 192.168.0.1 - - ecs-02: 192.168.0.2 - -#. Obtain the hostnames for the two ECSs. - - a. Log in to an ECS. - - b. Run the following command to view the ECS hostname: - - **sudo hostname** - - For example, the obtained hostnames are as follows: - - ecs-01: hostname01 - - ecs-02: hostname02 - -#. Create mapping between the hostnames and IP addresses and add information about other ECSs in the same VPC. - - a. Log in to ecs-01. - - b. .. _en-us_topic_0074752335__li6087483710276: - - Run the following command to switch to user **root**: - - **sudo su -** - - c. Run the following command to edit the hosts configuration file: - - **vi /etc/hosts** - - d. Press **i** to enter editing mode. - - e. Add the statement in the following format to set up the mapping: - - *Private IP address hostname* - - For example, add the following statement: - - 192.168.0.1 hostname01 - - 192.168.0.2 hostname02 - - f. Press **Esc** to exit editing mode. - - g. .. _en-us_topic_0074752335__li64061240102622: - - Run the following command to save the configuration and exit: - - **:wq** - - h. Log in to ecs-02. - - i. Repeat :ref:`3.b ` to :ref:`3.g `. - -#. Check whether the ECSs can communicate with each other using hostnames. - - Log in to an ECS in the same VPC, run the following command to ping the added host, and check whether the operation is successful: - - **ping** *Hostname* diff --git a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/gpu_driver.rst b/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/gpu_driver.rst deleted file mode 100644 index d519e60f..00000000 --- a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/gpu_driver.rst +++ /dev/null @@ -1,35 +0,0 @@ -:original_name: en-us_topic_0234802636.html - -.. _en-us_topic_0234802636: - -GPU Driver -========== - -Overview --------- - -Before using a GPU-accelerated ECS, make sure that a GPU driver has been installed on the ECS for GPU acceleration. - -GPU-accelerated ECSs support GRID and Tesla drivers. - -- To use graphics acceleration, such as OpenGL, DirectX, or Vulkan, install a GRID driver and separately purchase and configure a GRID license. The GRID driver with a vDWS license also supports CUDA for both computing and graphics acceleration. - - - A graphics-accelerated (G series) ECS created using a Windows public image has had a GRID driver of a specified version installed by default, but the GRID license must be purchased and configured separately. Before using such an ECS, check whether the desired driver has been installed on it and whether the version of the installed driver meets service requirements. - - A graphics-accelerated (G series) ECS created using a Linux public image does not have a GRID driver installed by default. To install a GRID driver, see :ref:`Installing a GRID Driver on a GPU-accelerated ECS `. - - To install a GRID driver on a GPU-accelerated ECS created using a private image, see :ref:`Installing a GRID Driver on a GPU-accelerated ECS `. - -- To use computing acceleration, install a Tesla driver. - - - A computing-accelerated (P series) ECS created using a Windows public image has had a Tesla driver of a specified version installed by default. - - A computing-accelerated (P series) ECS created using a Linux public image does not have a Tesla driver installed by default. To install a Tesla driver, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - - To install a Tesla driver on a GPU-accelerated ECS created using a private image, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -.. table:: **Table 1** Acceleration supported by GPU drivers - - +--------+--------------+-----------+---------------+---------------+---------------+-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | Driver | License | CUDA | OpenGL | DirectX | Vulkan | Application Scenario | Description | - +========+==============+===========+===============+===============+===============+=============================================================+====================================================================================================================================+ - | GRID | Required | Supported | Supported | Supported | Supported | 3D rendering, graphics workstation, and game acceleration | The GRID driver must be paid and requires a license to accelerate graphics and image applications. | - +--------+--------------+-----------+---------------+---------------+---------------+-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ - | Tesla | Not required | Supported | Not supported | Not supported | Not supported | Scientific computing, deep learning training, and inference | The Tesla driver is downloaded free of charge and usually used with NVIDIA CUDA SDKs to accelerate general computing applications. | - +--------+--------------+-----------+---------------+---------------+---------------+-------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/index.rst b/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/index.rst deleted file mode 100644 index 8658def1..00000000 --- a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0133513874: - -========================================== -(Optional) Installing a Driver and Toolkit -========================================== - -.. toctree:: - :maxdepth: 1 - - gpu_driver - installing_a_grid_driver_on_a_gpu-accelerated_ecs - obtaining_a_tesla_driver_and_cuda_toolkit - installing_a_tesla_driver_and_cuda_toolkit_on_a_gpu-accelerated_ecs diff --git a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_grid_driver_on_a_gpu-accelerated_ecs.rst b/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_grid_driver_on_a_gpu-accelerated_ecs.rst deleted file mode 100644 index 705baf70..00000000 --- a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_grid_driver_on_a_gpu-accelerated_ecs.rst +++ /dev/null @@ -1,287 +0,0 @@ -:original_name: en-us_topic_0149610914.html - -.. _en-us_topic_0149610914: - -Installing a GRID Driver on a GPU-accelerated ECS -================================================= - -Scenarios ---------- - -To use graphics acceleration, such as OpenGL, DirectX, or Vulkan, install a GRID driver and separately purchase and configure a GRID license. The GRID driver with a vDWS license also supports CUDA for both computing and graphics acceleration. - -- A graphics-accelerated (G series) ECS created using a Windows public image has had a GRID driver of a specified version installed by default, but the GRID license must be purchased and configured separately. -- A graphics-accelerated (G series) ECS created using a Linux public image does not have a GRID driver installed by default. You are required to install a GRID driver and purchase and configure a GRID license separately. -- If a GPU-accelerated ECS is created using a private image, install a GRID driver and separately purchase and configure a GRID license. - -This section describes how to install a GRID driver, purchase or apply for a GRID license, and configure the license server. - -Process of installing a GRID driver: - -#. :ref:`Purchasing a GRID License ` -#. :ref:`Downloading GRID Driver and Software License Packages ` -#. :ref:`Deploying and Configuring the License Server ` -#. :ref:`Installing the GRID Driver and Configuring the License ` - -.. note:: - - - NVIDIA allows you to apply for a 90-day trial license. - - For details about GPU-accelerated ECSs with different specifications and application scenarios, see :ref:`GPU-accelerated ECSs `. - -.. _en-us_topic_0149610914__section1130184214229: - -Purchasing a GRID License -------------------------- - -- Purchase a license. - - To obtain an official license, contact NVIDIA or their NVIDIA agent in your local country or region. - -- Apply for a trial license. - - Log in at the `official NVIDIA website `__ and enter desired information. - - For details about how to register an account and apply for a trial license, see `official NVIDIA help page `__. - - .. note:: - - The method of using a trial license is the same as that of using an official license. You can use an official license to activate an account with a trial license to prevent repetitive registration. The trial license has a validity period of 90 days. After the trial license expires, it cannot be used anymore. Purchase an official license then. - - .. _en-us_topic_0149610914__fig45088922717: - - .. figure:: /_static/images/en-us_image_0178069404.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Applying for a trial license - -.. _en-us_topic_0149610914__section91244318407: - -Downloading GRID Driver and Software License Packages ------------------------------------------------------ - -#. Obtain the driver installation package required for an OS. For details, see :ref:`Table 1 `. - - For more information about the GRID driver, see `NVIDIA vGPU Software Documentation `__. - - .. note:: - - For a GPU passthrough ECS, select a GRID driver version as required. - - For a GPU virtualization ECS, select a driver version based on the following table. - - .. _en-us_topic_0149610914__table188851534175019: - - .. table:: **Table 1** GRID driver versions supported by GPU-accelerated ECSs - - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | ECS Type | GPU Attachment | OS | Driver Version | CPU Architecture | - +=============+=================+==========================================+===============================+==================+ - | G6 | GPU passthrough | - Windows Server 2016 Standard 64bit | Select a version as required. | x86_64 | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | P2s | GPU passthrough | - Windows Server 2019 Standard 64bit | Select a version as required. | x86_64 | - | | | - Windows Server 2016 Standard 64bit | | | - | | | - Windows Server 2012 R2 Standard 64bit | | | - | | | - Ubuntu Server 20.04 64bit | | | - | | | - Ubuntu Server 18.04 64bit | | | - | | | - Ubuntu Server 16.04 64bit | | | - | | | - CentOS 7.7 64bit | | | - | | | - CentOS 7.4 64bit | | | - | | | - EulerOS 2.5 64bit | | | - | | | - Oracle Linux 7.6 64bit | | | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | P2v | GPU passthrough | - Windows Server 2019 Standard 64bit | Select a version as required. | x86_64 | - | | | - Windows Server 2016 Standard 64bit | | | - | | | - Windows Server 2012 R2 Standard 64bit | | | - | | | - Ubuntu Server 16.04 64bit | | | - | | | - CentOS 7.7 64bit | | | - | | | - EulerOS 2.5 64bit | | | - | | | - Oracle Linux 7.6 64bit | | | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | P2 | GPU passthrough | Ubuntu Server 16.04 64bit | Select a version as required. | x86_64 | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | P1 | GPU passthrough | - Windows Server 2012 R2 Standard 64bit | Select a version as required. | x86_64 | - | | | - Ubuntu Server 16.04 64bit | | | - | | | - CentOS 7.4 64bit | | | - | | | - Debian 9.0 64bit | | | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - | PI2 | GPU passthrough | - Windows Server 2019 Standard 64bit | Select a version as required. | x86_64 | - | | | - Windows Server 2016 Standard 64bit | | | - | | | - Windows Server 2012 R2 Standard 64bit | | | - | | | - Ubuntu Server 16.04 64bit | | | - | | | - CentOS 7.8 64bit | | | - +-------------+-----------------+------------------------------------------+-------------------------------+------------------+ - -#. After the registration, log in at the `official NVIDIA website `__ and enter the account. - -#. Check whether NVIDIA is used for the first time. - - a. If yes, go to step :ref:`4 `. - b. If no, go to step :ref:`6 `. - -#. .. _en-us_topic_0149610914__li1859773663819: - - Obtain the Product Activation Key (PAK) from the email indicating successful registration with NVIDIA. - - .. _en-us_topic_0149610914__fig133361216153817: - - .. figure:: /_static/images/en-us_image_0178334448.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** PAK - -#. Enter the PAK obtained in step :ref:`4 ` on the **Redeem Product Activation Keys** page and click **Redeem**. - - .. _en-us_topic_0149610914__fig16617143616380: - - .. figure:: /_static/images/en-us_image_0178334449.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Redeem Product Activation Keys - -#. .. _en-us_topic_0149610914__li0791101412396: - - Specify **Username** and **Password** and click **LOGIN**. - - .. _en-us_topic_0149610914__fig1367291114395: - - .. figure:: /_static/images/en-us_image_0178334450.png - :alt: **Figure 4** Logging in to the official NVIDIA website - - - **Figure 4** Logging in to the official NVIDIA website - -#. Log in at the official NVIDIA website as prompted and select **SOFTWARE DOWNLOADS**. - - .. _en-us_topic_0149610914__fig028419910169: - - .. figure:: /_static/images/en-us_image_0000001093447741.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** **SOFTWARE DOWNLOADS** page - -#. Download the GRID driver of the required version. For details, see :ref:`Table 1 `. - -#. Decompress the GRID driver installation package and install the driver that matches your ECS OS. - -#. On the **SOFTWARE DOWNLOADS** page, click **ADDITIONAL SOFTWARE** to download the license software package. - - .. _en-us_topic_0149610914__fig13215124318392: - - .. figure:: /_static/images/en-us_image_0000001093667097.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** ADDITIONAL SOFTWARE - -.. _en-us_topic_0149610914__section19229135113439: - -Deploying and Configuring the License Server --------------------------------------------- - -The following uses an ECS running CentOS 7.5 as an example to describe how to deploy and configure the license server on the ECS. - -.. note:: - - - The target ECS must have at least 2 vCPUs and 4 GiB of memory. - - Ensure that the MAC address of the target ECS has been recorded. - - If the license server is used in the production environment, deploy it in high availability mode. For details, see `official NVIDIA documentation for license server high availability `__. - -#. Configure the network. - - - If the license server is to be accessed using the VPC, ensure that the license server and the GPU-accelerated ECS with the GRID driver installed are in the same VPC subnet. - - If the license server is to be accessed using a public IP address, configure the security group to which license server belongs and add inbound rules for TCP 7070 and TCP 8080. - -2. Install the license server. - - For details, see the `official NVIDIA documentation for installing the license server `__. - -3. Obtain the license file. - - a. Log in to the `NVIDIA website `__ on a new tab and select **LICENSE SERVERS**. - - .. _en-us_topic_0149610914__fig1319854518598: - - .. figure:: /_static/images/en-us_image_0000001093449637.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** LICENSE SERVERS - - b. Click **CREATE SERVER**. - - c. Set **Server Name**, **Description**, and **MAC Address** (MAC address of the license server). - - d. Select **Feature**, enter the number of required licenses in the **Licenses** text box, and click **ADD**. - - In active/standby deployment, enter the name of the standby server in **Failover License Server** and enter the MAC address in **Failover MAC Address**. - - e. Click **CREATE LICENSE SERVER**. - - .. _en-us_topic_0149610914__fig1865418576181: - - .. figure:: /_static/images/en-us_image_0000001093450009.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Create License Server - - f. Download the license file. - - .. _en-us_topic_0149610914__fig19995314613: - - .. figure:: /_static/images/en-us_image_0000001093310123.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Downloading the license file - -4. In the web browser, access the homepage of the license server management page using the link configured during the installation. - - Default URL: http://*IP address of the EIP*:8080/licserver - -5. Choose **License Server** > **License Management**, select the .bin license file to be uploaded, and click **Upload**. - - .. _en-us_topic_0149610914__fig101141159980: - - .. figure:: /_static/images/en-us_image_0178325096.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 10** Uploading a license file - -.. _en-us_topic_0149610914__section17545653184812: - -Installing the GRID Driver and Configuring the License ------------------------------------------------------- - -#. Install the GRID driver of a desired version, for example, on a GPU-accelerated Windows ECS. - - .. note:: - - Microsoft remote login protocols do not support GPU 3D hardware acceleration. To use this function, install third-party desktop protocol-compliant software, such as VNC, PCoIP, or NICE DCV, and access the ECS through the client. - -#. Open the NVIDIA control panel on the Windows control panel. - -#. Enter the IP address and port number of the deployed license server in the level-1 license server, and then click **Apply**. If the message indicating that you have obtained a GRID license, the installation is successful. Additionally, the MAC address of the GPU-accelerated ECS with the GRID driver installed is displayed on the **Licensed Clients** page of the license server management console. - - .. _en-us_topic_0149610914__fig7104162713349: - - .. figure:: /_static/images/en-us_image_0178370293.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 11** License server management console diff --git a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_tesla_driver_and_cuda_toolkit_on_a_gpu-accelerated_ecs.rst b/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_tesla_driver_and_cuda_toolkit_on_a_gpu-accelerated_ecs.rst deleted file mode 100644 index 0f41d56b..00000000 --- a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/installing_a_tesla_driver_and_cuda_toolkit_on_a_gpu-accelerated_ecs.rst +++ /dev/null @@ -1,543 +0,0 @@ -:original_name: en-us_topic_0149470468.html - -.. _en-us_topic_0149470468: - -Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS -=================================================================== - -Scenarios ---------- - -Before using a GPU-accelerated ECS, make sure that the desired Tesla driver and CUDA toolkit have been installed on the ECS for computing acceleration. - -- A computing-accelerated (P series) ECS created using a Windows public image has had a Tesla driver of a specified version installed by default. -- A computing-accelerated (P series) ECS created using a Linux public image does not have a Tesla driver installed by default. After the ECS is created, install a driver on it for computing acceleration. -- After a GPU-accelerated ECS is created using a private image, it must have a Tesla driver installed. Otherwise, computing acceleration will not take effect. - -This section describes how to install a Tesla driver and CUDA toolkit on a GPU-accelerated ECS. - -Notes ------ - -- The target ECS has an EIP bound. -- The Tesla driver and CUDA toolkit have not been installed on the ECS. - -.. note:: - - - Download the CUDA toolkit from the official NVIDIA website and install it. A Tesla driver matching the CUDA version will be automatically installed then. However, if there are specific requirements or dependencies on the Tesla driver version, download the matching Tesla driver from the official NVIDIA website first and then install the driver before installing the CUDA toolkit. - - If a Tesla driver has been installed on the ECS, check the driver version. Before installing a new driver version, uninstall the original Tesla driver to prevent an installation failure due to driver conflicts. - -Installation process: - -- :ref:`Obtaining a Tesla Driver and CUDA Toolkit ` -- Installing a Tesla Driver - - - :ref:`Installing a Tesla Driver on a Linux ECS ` - - :ref:`Installing a Tesla Driver on a Windows ECS ` - -- Installing a CUDA Toolkit - - - :ref:`Installing the CUDA Toolkit on a Linux ECS ` - - :ref:`Installing the CUDA Toolkit on a Windows ECS ` - -.. _en-us_topic_0149470468__section1728514576397: - -Installing a Tesla Driver on a Linux ECS ----------------------------------------- - -The following uses Ubuntu 16.04 64bit as an example to describe how to install the Tesla driver matching CUDA 10.1 on a GPU-accelerated ECS. - -.. note:: - - The Linux kernel version is compatible with the driver version. If installing the driver failed, check the driver installation log, which is generally stored in **/var/log/nvidia-installer.log**. If the log shows that the failure was caused by a driver compilation error, for example, the **get_user_pages** parameter setting is incorrect, the kernel version is incompatible with the driver version. In such a case, select the desired kernel version and driver version and reinstall them. It is recommended that the release time of the kernel version and driver version be the same. - -#. Log in to the ECS. - -#. Update the system software based on the OS. - - - Ubuntu - - Update the software installation source: **apt-get -y update** - - Install necessary programs: **apt-get install gcc g++ make** - - - CentOS - - Update the software installation source: **yum -y update --exclude=kernel\* --exclude=centos-release\* --exclude=initscripts\*** - - Install the desired program: **yum install -y kernel-devel-`uname -r\` gcc gcc-c++** - -#. Download the NVIDIA driver package. - - Select a driver version at `NVIDIA Driver Downloads `__ based on the ECS type. Click **SEARCH**. - - .. _en-us_topic_0149470468__fig545554125711: - - .. figure:: /_static/images/en-us_image_0234354896.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Selecting a NVIDIA driver version - -#. Select a driver version as required. The following uses Tesla 418.67 as an example. - - .. _en-us_topic_0149470468__fig52351103310: - - .. figure:: /_static/images/en-us_image_0234354931.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Selecting a driver version - -#. Click the driver to be downloaded. On the **TESLA DRIVER FOR LINUX X64** page that is displayed, click **DOWNLOAD**. - -#. Copy the download link. - - .. _en-us_topic_0149470468__fig123801538205720: - - .. figure:: /_static/images/en-us_image_0234355284.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Copying the download link - -#. Run the following command on the ECS to download the driver: - - **wget** *Copied link* - - For example, **wget http://us.download.nvidia.com/tesla/418.67/NVIDIA-Linux-x86_64-418.67.run** - - .. _en-us_topic_0149470468__fig187219205141: - - .. figure:: /_static/images/en-us_image_0234355299.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Obtaining the installation package - -#. Run the following command to install the driver: - - **sh NVIDIA-Linux-x86_64-418.67.run** - -#. (Optional) If the following information is displayed after the command for installing the driver is executed, disable the Nouveau driver. - - .. _en-us_topic_0149470468__fig2682182345814: - - .. figure:: /_static/images/en-us_image_0250287387.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Disabling the Nouveau driver - - a. Run the following command to check whether the Nouveau driver has been installed: - - **lsmod \| grep nouveau** - - - If the command output contains information about the Nouveau driver, the Nouveau driver has been installed and must be disabled. Then, go to step :ref:`9.b `. - - If the command output does not contain information about the Nouveau driver, the Nouveau driver has been disabled. Then, go to step :ref:`9.d `. - - b. .. _en-us_topic_0149470468__li073251517124: - - Edit the **blacklist.conf** file. - - If the **/etc/modprobe.d/blacklist.conf** file is unavailable, create it. - - **vi /etc/modprobe.d/blacklist.conf** - - Add the following statement to the end of the file: - - .. code-block:: - - blacklist nouveau - options nouveau modeset=0 - - c. Run the following command to back up and create an initramfs application: - - - Ubuntu - - **sudo update-initramfs -u** - - - CentOS: - - **mv /boot/initramfs-$(uname -r).img /boot/initramfs-$(uname -r).img.bak** - - **dracut -v /boot/initramfs-$(uname -r).img $(uname -r)** - - d. .. _en-us_topic_0149470468__li9819105753916: - - Restart the ECS: - - **reboot** - -#. Select **OK** for three consecutive times as prompted to complete the driver installation. - - .. _en-us_topic_0149470468__fig1643713142594: - - .. figure:: /_static/images/en-us_image_0250287611.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 6** Completing the NVIDIA driver installation - -#. Run the following command to set systemd: - - **systemctl set-default multi-user.target** - -#. Run the **reboot** command to restart the ECS. - -#. Log in to the ECS and run the **nvidia-smi** command. If the command output contains the installed driver version, the driver has been installed. - - .. _en-us_topic_0149470468__fig61971535809: - - .. figure:: /_static/images/en-us_image_0234355305.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 7** Viewing the NVIDIA driver version - -.. _en-us_topic_0149470468__section244363219171: - -Installing a Tesla Driver on a Windows ECS ------------------------------------------- - -The following uses Windows Server 2016 Standard 64bit as an example to describe how to install a Tesla driver on a GPU-accelerated ECS. - -#. Log in to the ECS. - -#. Download the NVIDIA driver package. - - Select a driver version at `NVIDIA Driver Downloads `__ based on the ECS type. - - .. _en-us_topic_0149470468__fig62897581106: - - .. figure:: /_static/images/en-us_image_0234356929.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 8** Selecting a driver type (Windows) - -#. Select a driver version as required. The following uses Tesla 425.25 as an example. - - .. _en-us_topic_0149470468__fig5291626204819: - - .. figure:: /_static/images/en-us_image_0234356990.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 9** Selecting a driver version (Windows) - -#. Click the driver to be downloaded. On the **TESLA DRIVER FOR WINDOWS** page that is displayed, click **DOWNLOAD**. - -#. Click **Agree & Download** to download the installation package. - - .. _en-us_topic_0149470468__fig37451434818: - - .. figure:: /_static/images/en-us_image_0234357031.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 10** Downloading the driver installation package - -#. Double-click the driver and click **Run**. - - .. _en-us_topic_0149470468__fig177611624821: - - .. figure:: /_static/images/en-us_image_0234357053.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 11** Running the NVIDIA driver installation program - -#. Select an installation path and click **OK**. - - .. _en-us_topic_0149470468__fig1378440121: - - .. figure:: /_static/images/en-us_image_0234357336.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 12** Selecting an installation path - -#. Install the NVIDIA program as prompted. - - .. _en-us_topic_0149470468__fig46181053128: - - .. figure:: /_static/images/en-us_image_0234357355.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 13** Completing the driver installation - -#. Restart the ECS. - -#. Check whether the NVIDIA driver has been installed. - - a. Switch to **Device Manager** and click **Display adapters**. - - .. _en-us_topic_0149470468__fig8540781030: - - .. figure:: /_static/images/en-us_image_0234357385.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 14** Display adapters - - b. Open the **cmd** window on the ECS and run the following commands: - - **cd C:\Program Files\NVIDIA Corporation\NVSMI** - - **nvidia-smi** - - If the command output contains the installed driver version, the driver has been installed. - - .. _en-us_topic_0149470468__fig125251621439: - - .. figure:: /_static/images/en-us_image_0234357365.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 15** Viewing the NVIDIA driver version - -.. _en-us_topic_0149470468__section1034245773916: - -Installing the CUDA Toolkit on a Linux ECS ------------------------------------------- - -The following uses Ubuntu 16.04 64bit as an example to describe how to install the CUDA 10.1 toolkit on a GPU-accelerated ECS. - -#. Log in to the ECS. - -#. Update the system software based on the OS. - - - Ubuntu - - Update the software installation source: **apt-get -y update** - - Install necessary programs: **apt-get install gcc g++ make** - - - CentOS - - Update the software installation source: **yum -y update --exclude=kernel\* --exclude=centos-release\* --exclude=initscripts\*** - - Install the desired program: **yum install -y kernel-devel-`uname -r\` gcc gcc-c++** - -#. On the CUDA download page, set parameters according to the information shown in :ref:`Obtaining a Tesla Driver and CUDA Toolkit `. - - .. _en-us_topic_0149470468__fig1930101643513: - - .. figure:: /_static/images/en-us_image_0250288087.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 16** Selecting a CUDA version - -#. Find the link for downloading CUDA 10.1 and copy the link. - - .. _en-us_topic_0149470468__fig970482862918: - - .. figure:: /_static/images/en-us_image_0250288474.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 17** Copying the link for downloading CUDA - -5. Run the following command on the ECS to download CUDA: - - **wget** *Copied link* - - For example, **wget https://developer.nvidia.com/compute/cuda/10.1/Prod/local_installers/cuda_10.1.105_418.39_linux.run** - - .. _en-us_topic_0149470468__fig8354143184612: - - .. figure:: /_static/images/en-us_image_0234358619.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 18** Downloading CUDA - -6. Install CUDA. - - Follow the instructions provided on the official NVIDIA website. - - .. _en-us_topic_0149470468__fig11827757103913: - - .. figure:: /_static/images/en-us_image_0250288371.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 19** Installing CUDA - -7. Run the following command to install CUDA: - - **sh cuda_10.1.243_418.87.00_linux.run** - -8. Select **accept** on the installation page and press **Enter**. - - .. _en-us_topic_0149470468__fig514958145414: - - .. figure:: /_static/images/en-us_image_0234358634.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 20** Installing CUDA_1 - -9. Select **Install** and press **Enter** to start the installation. - - .. _en-us_topic_0149470468__fig20943181255411: - - .. figure:: /_static/images/en-us_image_0234358642.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 21** Installing CUDA_2 - - .. _en-us_topic_0149470468__fig148915619526: - - .. figure:: /_static/images/en-us_image_0234358704.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 22** Completing the installation - -10. Run the following command to switch to **/usr/local/cuda-10.1/samples/1_Utilities/deviceQuery**: - - **cd /usr/local/cuda-10.1/samples/1_Utilities/deviceQuery** - -11. Run the **make** command to automatically compile the deviceQuery program. - -12. Run the following command to check whether CUDA has been installed: - - **./deviceQuery** - - If the command output contains the CUDA version, CUDA has been installed. - - .. _en-us_topic_0149470468__fig1282815711392: - - .. figure:: /_static/images/en-us_image_0234358719.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 23** deviceQuery common output - -13. Check the CUDA version. - - **/usr/local/cuda/bin/nvcc -V** - - .. _en-us_topic_0149470468__fig18749997817: - - .. figure:: /_static/images/en-us_image_0234358804.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 24** Checking the CUDA version - -14. Run the following command to enable the persistent mode: - - **sudo nvidia-smi -pm 1** - - Enabling the persistent mode optimizes the GPU performance on Linux ECSs. - -.. _en-us_topic_0149470468__section0337133719497: - -Installing the CUDA Toolkit on a Windows ECS --------------------------------------------- - -The following uses Windows Server 2016 Standard 64bit as an example to describe how to install the CUDA 10.1 toolkit on a GPU-accelerated ECS. - -#. Log in to the ECS. - -#. On the CUDA download page, set parameters according to the information shown in :ref:`Downloading a CUDA Toolkit `. - - .. _en-us_topic_0149470468__fig17127316719: - - .. figure:: /_static/images/en-us_image_0250288895.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 25** Selecting a CUDA version - -#. Find the link for downloading CUDA 10.1. - - .. _en-us_topic_0149470468__fig22798411673: - - .. figure:: /_static/images/en-us_image_0250289123.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 26** Finding the link for downloading CUDA - -#. Click **Download** to download the CUDA toolkit. - -#. Double-click the installation file and click **Run** to install the CUDA toolkit. - - .. _en-us_topic_0149470468__fig696324171118: - - .. figure:: /_static/images/en-us_image_0234360248.png - :alt: **Figure 27** Installing CUDA - - - **Figure 27** Installing CUDA - -#. On the **CUDA Setup Package** page, select an installation path and click **OK**. - - .. _en-us_topic_0149470468__fig18644103851215: - - .. figure:: /_static/images/en-us_image_0234360274.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 28** Selecting an installation path - -#. Install the CUDA toolkit as prompted. - - .. _en-us_topic_0149470468__fig2266175711165: - - .. figure:: /_static/images/en-us_image_0234360255.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 29** Completing the installation - -8. Check whether CUDA has been installed - - Open the **cmd** window and run the following command: - - **nvcc -V** - - If the command output contains the CUDA version, CUDA has been installed. - - .. _en-us_topic_0149470468__fig6475101453: - - .. figure:: /_static/images/en-us_image_0234360293.png - :alt: **Figure 30** Successful installation - - - **Figure 30** Successful installation diff --git a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/obtaining_a_tesla_driver_and_cuda_toolkit.rst b/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/obtaining_a_tesla_driver_and_cuda_toolkit.rst deleted file mode 100644 index c166de86..00000000 --- a/ecs/umn/result/instances/optional_installing_a_driver_and_toolkit/obtaining_a_tesla_driver_and_cuda_toolkit.rst +++ /dev/null @@ -1,156 +0,0 @@ -:original_name: en-us_topic_0213874991.html - -.. _en-us_topic_0213874991: - -Obtaining a Tesla Driver and CUDA Toolkit -========================================= - -Scenarios ---------- - -Before using a GPU-accelerated ECS, make sure that the desired Tesla driver and CUDA toolkit have been installed on the EIP. Otherwise, computing acceleration will not take effect. This section describes how to obtain a Tesla driver and CUDA toolkit. Select a driver version based on your ECS type. - -For instructions about how to install the Tesla driver and CUDA toolkit, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -Downloading a Tesla Driver --------------------------- - -`Download a driver `__ based on your ECS type. - -.. table:: **Table 1** Mapping between Tesla drivers and ECS types - - ======== ====== ============== ======= - ECS Type Driver Product Series Product - ======== ====== ============== ======= - P2s Tesla V V100 - P2v Tesla V V100 - P2 Tesla V V100 - P1 Tesla P P100 - PI2 Tesla T T4 - G6 Tesla T T4 - ======== ====== ============== ======= - -.. _en-us_topic_0213874991__section10203125783920: - -Downloading a CUDA Toolkit --------------------------- - -.. table:: **Table 2** Path in which the CUDA toolkit is downloaded for P2s ECSs - - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------------------------+------------------+ - | ECS Type | OS | CUDA Version | How to Obtain | CPU Architecture | - +=============+=======================================+=========================================================================================================+=============================================+==================+ - | P2s | CentOS 7.4 64bit | 9.2 or later | Select a CUDA version as required. | x86_64 | - | | | | | | - | (V100) | | If the kernel version is 3.10.0-957.5.1.e17.x86_64 or earlier, install the CUDA toolkit of version 9.2. | https://developer.nvidia.com/cuda-downloads | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------------------------+------------------+ - | P2s | Ubuntu 16.04 64bit | 9.2 or later | | x86_64 | - | | | | | | - | (V100) | | If the kernel version is 4.4.0-141-generic or earlier, install the CUDA toolkit of version 9.2. | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------------------------+------------------+ - | P2s | Windows Server 2016 Standard 64bit | 9.2 or later | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------------------------+------------------+ - | P2s | Windows Server 2012 R2 Standard 64bit | 9.2 or later | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+---------------------------------------------+------------------+ - -.. table:: **Table 3** Path in which the CUDA toolkit is downloaded for P2v ECSs - - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | ECS Type | OS | CUDA Version | How to Obtain | CPU Architecture | - +=============+=======================================+=========================================================================================================+====================================================================+==================+ - | P2v | CentOS 7.7 64bit | 9.2/10.1 | Version 9.2: https://developer.nvidia.com/cuda-92-download-archive | x86_64 | - | | | | | | - | (V100) | | If the kernel version is 3.10.0-957.5.1.e17.x86_64 or earlier, install the CUDA toolkit of version 9.2. | Version 10.1: | | - | | | | | | - | | | | https://developer.nvidia.com/cuda-10.1-download-archive-base | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | P2v | EulerOS 2.5 64bit | 9.2 | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | P2v | Ubuntu 16.04 64bit | 9.2/10.1 | | x86_64 | - | | | | | | - | (V100) | | If the kernel version is 4.4.0-141-generic or earlier, install the CUDA toolkit of version 9.2. | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | P2v | Windows Server 2019 Standard 64bit | 9.2/10.1 | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | P2v | Windows Server 2016 Standard 64bit | 9.2/10.1 | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - | P2v | Windows Server 2012 R2 Standard 64bit | 9.2/10.1 | | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------------------+---------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+------------------+ - -.. table:: **Table 4** Path in which the CUDA toolkit is downloaded for P2 ECSs - - +-------------+---------------------------+--------------+-------------------------------------------------------+------------------+ - | ECS Type | OS | CUDA Version | How to Obtain | CPU Architecture | - +=============+===========================+==============+=======================================================+==================+ - | P2 | Ubuntu Server 16.04 64bit | 9 | https://developer.nvidia.com/cuda-90-download-archive | x86_64 | - | | | | | | - | (V100) | | | | | - +-------------+---------------------------+--------------+-------------------------------------------------------+------------------+ - -.. table:: **Table 5** Path in which the CUDA toolkit is downloaded for P1 ECSs - - +-------------+---------------------------------------+--------------+-------------------------------------------------------+------------------+ - | ECS Type | OS | CUDA Version | How to Obtain | CPU Architecture | - +=============+=======================================+==============+=======================================================+==================+ - | P1 | CentOS 7.3 64bit | 9 | https://developer.nvidia.com/cuda-90-download-archive | x86_64 | - | | | | | | - | (P100) | | | | | - +-------------+---------------------------------------+--------------+-------------------------------------------------------+------------------+ - | P1 | Ubuntu 16.04 64bit | 9 | | x86_64 | - | | | | | | - | (P100) | | | | | - +-------------+---------------------------------------+--------------+-------------------------------------------------------+------------------+ - | P1 | Windows Server 2012 R2 Standard 64bit | 9 | | x86_64 | - | | | | | | - | (P100) | | | | | - +-------------+---------------------------------------+--------------+-------------------------------------------------------+------------------+ - -.. table:: **Table 6** Path in which the CUDA toolkit is downloaded for PI2 ECSs - - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | ECS Type | OS | CUDA Version | How to Obtain | CPU Architecture | - +=============+=======================================+==============+==============================================================+==================+ - | PI2 | CentOS 7.8 64bit | 10.1 | https://developer.nvidia.com/cuda-10.1-download-archive-base | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | PI2 | Ubuntu 16.04 64bit | 10.1 | | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | PI2 | Windows Server 2019 Standard 64bit | 10.1 | | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | PI2 | Windows Server 2016 Standard 64bit | 10.1 | | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | PI2 | Windows Server 2012 R2 Standard 64bit | 10.1 | | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+---------------------------------------+--------------+--------------------------------------------------------------+------------------+ - -.. table:: **Table 7** Path in which the CUDA toolkit is downloaded for G6 ECSs - - +-------------+------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | ECS | OS | CUDA Version | How to Obtain | CPU Architecture | - | | | | | | - | Type | | | | | - +-------------+------------------------------------+--------------+--------------------------------------------------------------+------------------+ - | G6 | Windows Server 2016 Standard 64bit | 10.1 | https://developer.nvidia.com/cuda-10.1-download-archive-base | x86_64 | - | | | | | | - | (T4) | | | | | - +-------------+------------------------------------+--------------+--------------------------------------------------------------+------------------+ diff --git a/ecs/umn/result/instances/viewing_ecs_information/exporting_ecs_information.rst b/ecs/umn/result/instances/viewing_ecs_information/exporting_ecs_information.rst deleted file mode 100644 index ef2e22a3..00000000 --- a/ecs/umn/result/instances/viewing_ecs_information/exporting_ecs_information.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: en-us_topic_0060610074.html - -.. _en-us_topic_0060610074: - -Exporting ECS Information -========================= - -Scenarios ---------- - -The information of all ECSs under your account can be exported in CSV format to a local directory. The file records the IDs, private IP addresses, and EIPs of your ECSs. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the upper right corner of the ECS list, click |image2|. - - The system will automatically export all ECSs in the current region under your account to a local directory. - -#. In the lower left corner of your local computer desktop, obtain the exported file **servers.csv**. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0142360062.png - diff --git a/ecs/umn/result/instances/viewing_ecs_information/index.rst b/ecs/umn/result/instances/viewing_ecs_information/index.rst deleted file mode 100644 index 4da8cf6b..00000000 --- a/ecs/umn/result/instances/viewing_ecs_information/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0030893661: - -======================= -Viewing ECS Information -======================= - -.. toctree:: - :maxdepth: 1 - - viewing_ecs_creation_statuses - viewing_failures - viewing_details_about_an_ecs - exporting_ecs_information diff --git a/ecs/umn/result/instances/viewing_ecs_information/viewing_details_about_an_ecs.rst b/ecs/umn/result/instances/viewing_ecs_information/viewing_details_about_an_ecs.rst deleted file mode 100644 index 7165a79e..00000000 --- a/ecs/umn/result/instances/viewing_ecs_information/viewing_details_about_an_ecs.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_0017130261.html - -.. _en-us_topic_0017130261: - -Viewing Details About an ECS -============================ - -Scenarios ---------- - -After obtaining ECSs, you can view and manage them on the management console. This section describes how to view detailed ECS configurations, including its name, image, system disk, data disks, VPC, NIC, security group, and EIP. - -To view the private IP address of an ECS, view it on the **Elastic Cloud Server** page. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - - The **Elastic Cloud Server** page is displayed. On this page, you can view your ECSs and the basic information about the ECSs, such as their private IP addresses. - -#. In the search box above the ECS list, enter the ECS name, IP address, or ID, and click |image2| for search. Alternatively, click **Search by Tag** above the upper right corner of the ECS list and search for an ECS by tag key and value. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. View the ECS details. - - You can modify ECS configurations, for example, change its security group, add a NIC or tag to it, or bind an EIP to it, by clicking corresponding links or buttons. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0128851621.png - diff --git a/ecs/umn/result/instances/viewing_ecs_information/viewing_ecs_creation_statuses.rst b/ecs/umn/result/instances/viewing_ecs_information/viewing_ecs_creation_statuses.rst deleted file mode 100644 index 1bd09dfc..00000000 --- a/ecs/umn/result/instances/viewing_ecs_information/viewing_ecs_creation_statuses.rst +++ /dev/null @@ -1,37 +0,0 @@ -:original_name: en-us_topic_0039588795.html - -.. _en-us_topic_0039588795: - -Viewing ECS Creation Statuses -============================= - -Scenarios ---------- - -After submitting the request for creating an ECS, you can view the creation status. This section describes how to view the creation status of an ECS. - -Procedure ---------- - -#. Log in to the management console. -#. Click |image1| in the upper left corner and select your region and project. -#. Under **Computing**, click **Elastic Cloud Server**. -#. After creating an ECS, view the creation status in the task status area on the right side of common operations (**Start**, **Stop**, and **More**). -#. Click the number displayed above **Creating** and view details about the tasks. - - .. note:: - - - An ECS that is being created is in one of the following states: - - - **Creating**: The ECS is being created. - - - **Failures**: Creating the ECS failed. In such a case, the system automatically rolls the task back and displays an error code on the GUI, for example, **Ecs.0013 Insufficient EIP quota**. - - - **Running**: The request of creating the ECS has been processed, and the ECS is running properly. An ECS in this state can provide services for you. - - See :ref:`How Do I Handle Error Messages Displayed on the Management Console? ` for troubleshooting. - - - If you find that the task status area shows an ECS creation failure but the ECS list displays the created ECS, see :ref:`Why Does the Failures Area Show an ECS Creation Failure But the ECS List Displays the Created ECS? ` - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/instances/viewing_ecs_information/viewing_failures.rst b/ecs/umn/result/instances/viewing_ecs_information/viewing_failures.rst deleted file mode 100644 index 5f8aa297..00000000 --- a/ecs/umn/result/instances/viewing_ecs_information/viewing_failures.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_0108255889.html - -.. _en-us_topic_0108255889: - -Viewing Failures -================ - -Scenarios ---------- - -The **Failures** area shows the tasks that failed to process due to an error, including the task name and status. **Failures** is displayed on the management console if a task failed. This section describes how to view failures. - -Failure Types -------------- - -:ref:`Table 1 ` lists the types of failures that can be recorded in the **Failures** area. - -.. _en-us_topic_0108255889__table155141127195016: - -.. table:: **Table 1** Failure types - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Failure Type | Description | - +===================================+===============================================================================================================================================================================================================================================================================+ - | Creation failures | A task failed to process. For a failed task, the system rolls back and displays an error code, for example, **Ecs.0013 Insufficient EIP quota**. See :ref:`How Do I Handle Error Messages Displayed on the Management Console? ` for troubleshooting. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Operation failures | - Modifying ECS specifications | - | | | - | | If an ECS specifications modification failed, this operation is recorded in **Failures**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. View **Failures** on the right side of common operations. - - .. _en-us_topic_0108255889__fig1678913358104: - - .. figure:: /_static/images/en-us_image_0152768827.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Failures - -#. Click the number displayed in the **Failures** area to view details about the tasks. - - - **Creation Failures**: show the tasks that are being created and those failed to create. - - **Operation Failures**: show the tasks with errors, including the operations performed on the tasks and error codes. Such information can be used for rapid fault locating. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/monitoring/basic_ecs_metrics.rst b/ecs/umn/result/monitoring/basic_ecs_metrics.rst deleted file mode 100644 index 4ce00704..00000000 --- a/ecs/umn/result/monitoring/basic_ecs_metrics.rst +++ /dev/null @@ -1,171 +0,0 @@ -:original_name: en-us_topic_0030911465.html - -.. _en-us_topic_0030911465: - -Basic ECS Metrics -================= - -Description ------------ - -This section describes monitoring metrics reported by ECS to Cloud Eye. You can use Cloud Eye to view these metrics and alarms generated for ECSs. - -Namespace ---------- - -SYS.ECS - -ECS Metrics ------------ - -ECS metrics vary depending on ECS OSs and types. For details, see :ref:`Table 1 `. Y indicates that the metric is supported, and x indicates that the metric is not supported. - -.. _en-us_topic_0030911465__table1474714113454: - -.. table:: **Table 1** ECS metrics - - +-----------------------+------------------------------+------------------------------+ - | Metric | Windows | Linux | - +=======================+==============================+==============================+ - | CPU Usage | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Memory Usage | Supported | Not supported | - +-----------------------+------------------------------+------------------------------+ - | Disk Usage | Supported | Not supported | - +-----------------------+------------------------------+------------------------------+ - | Disk Read Bandwidth | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Disk Write Bandwidth | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Disk Read IOPS | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Disk Write IOPS | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Inband Incoming Rate | Supported | Not supported | - +-----------------------+------------------------------+------------------------------+ - | Inband Outgoing Rate | Supported | Not supported | - +-----------------------+------------------------------+------------------------------+ - | Outband Incoming Rate | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | Outband Outgoing Rate | Supported | Supported | - +-----------------------+------------------------------+------------------------------+ - | InfiniBand NIC Status | Supported (Only for H2 ECSs) | Supported (Only for H2 ECSs) | - +-----------------------+------------------------------+------------------------------+ - -.. note:: - - The image based on which the target ECS is created must have OTC Tools installed (OTC Tools has been installed for public images by default). Otherwise, the **Memory Usage** and **Disk Usage** metrics are unavailable. For details about how to install the OTC Tools, visit https://github.com/UVP-Tools/UVP-Tools/. - -:ref:`Table 2 ` describes these ECS metrics. - -The monitoring intervals for the following ECSs with raw monitoring metrics are as follows: - -- KVM ECS: 5 minutes - -.. _en-us_topic_0030911465__table64866324222846: - -.. table:: **Table 2** Metric description - - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | Metric | Parameter | Description | Value Range | Monitored Object | Monitoring Interval (Raw Metrics and KVM Only) | - +=======================================+=======================+=======================================================================================================================================================================================================================================================================================================================================================+================+==================+================================================+ - | cpu_util | CPU Usage | CPU usage of an ECS | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: Percent | | | | - | | | | | | | - | | | Formula: CPU usage of an ECS/Number of vCPUs in the ECS | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | mem_util | Memory Usage | Memory usage of an ECS | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | This metric is unavailable if the image has no OTC Tools installed. | | | | - | | | | | | | - | | | Unit: Percent | | | | - | | | | | | | - | | | Formula: Used memory of an ECS/Total memory of the ECS | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | disk_util_inband | Disk Usage | Disk usage of an ECS | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | This metric is unavailable if the image has no OTC Tools installed. | | | | - | | | | | | | - | | | Unit: Percent | | | | - | | | | | | | - | | | Formula: Used capacity of an ECS disk/Total capacity of the ECS disk | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | disk_read_bytes_rate | Disk Read Bandwidth | Number of bytes read from an ECS disk per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of bytes read from an ECS disk/Monitoring interval | | | | - | | | | | | | - | | | byte_out = (rd_bytes - last_rd_bytes)/Time difference | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | disk_write_bytes_rate | Disk Write Bandwidth | Number of bytes written to an ECS disk per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of bytes written to an ECS disk/Monitoring interval | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | disk_read_requests_rate | Disk Read IOPS | Number of read requests sent to an ECS disk per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: request/s | | | | - | | | | | | | - | | | Formula: Total number of read requests sent to an ECS disk/Monitoring interval | | | | - | | | | | | | - | | | req_out = (rd_req - last_rd_req)/Time difference | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | disk_write_requests_rate | Disk Write IOPS | Number of write requests sent to an ECS disk per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: request/s | | | | - | | | | | | | - | | | Formula: Total number of write requests sent to an ECS disk/Monitoring interval | | | | - | | | | | | | - | | | req_in = (wr_req - last_wr_req)/Time difference | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | network_incoming_bytes_rate_inband | Inband Incoming Rate | Number of incoming bytes on an ECS per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of inband incoming bytes on an ECS/Monitoring interval | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | network_outgoing_bytes_rate_inband | Inband Outgoing Rate | Number of outgoing bytes on an ECS per second | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of inband outgoing bytes on an ECS/Monitoring interval | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | network_incoming_bytes_aggregate_rate | Outband Incoming Rate | Number of incoming bytes on an ECS per second on the hypervisor | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of outband incoming bytes on an ECS/Monitoring interval | | | | - | | | | | | | - | | | This metric is unavailable if SR-IOV is enabled. | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | network_outgoing_bytes_aggregate_rate | Outband Outgoing Rate | Number of outgoing bytes on an ECS per second on the hypervisor | ≥ 0 | ECS | 5 minutes | - | | | | | | | - | | | Unit: byte/s | | | | - | | | | | | | - | | | Formula: Total number of outband outgoing bytes on an ECS/Monitoring interval | | | | - | | | | | | | - | | | This metric is unavailable if SR-IOV is enabled. | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - | ib_card_state | InfiniBand NIC status | Status of an InfiniBand NIC on an H2 ECS | **0** or **1** | ECS | 5 minutes | - | | | | | | | - | | | The system periodically checks the status and returns check results using value **0** or **1**. | | | | - | | | | | | | - | | | - **0**: The system is running properly. That is, the InfiniBand NIC is functional. | | | | - | | | - **1**: The system is not running properly. That is, the InfiniBand NIC malfunctions. When the physical NIC corresponding to a virtual NIC becomes faulty, for example, the network cable is not securely connected to the NIC, the switch or adapter is incompatible with the InfiniBand NIC, or the NIC is disabled, the returned value is **1**. | | | | - | | | | | | | - | | | .. note:: | | | | - | | | | | | | - | | | Only Mellanox EDR 100 GB single-port InfiniBand NICs are supported. | | | | - +---------------------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------+------------------+------------------------------------------------+ - -Dimensions ----------- - -=========== ===================== -Key Value -=========== ===================== -instance_id Specifies the ECS ID. -=========== ===================== diff --git a/ecs/umn/result/monitoring/index.rst b/ecs/umn/result/monitoring/index.rst deleted file mode 100644 index 5bad5c8b..00000000 --- a/ecs/umn/result/monitoring/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0072987316: - -========== -Monitoring -========== - -.. toctree:: - :maxdepth: 1 - - monitoring_ecss - basic_ecs_metrics - setting_alarm_rules - viewing_ecs_metrics diff --git a/ecs/umn/result/monitoring/monitoring_ecss.rst b/ecs/umn/result/monitoring/monitoring_ecss.rst deleted file mode 100644 index fa63d154..00000000 --- a/ecs/umn/result/monitoring/monitoring_ecss.rst +++ /dev/null @@ -1,14 +0,0 @@ -:original_name: en-us_topic_0027371529.html - -.. _en-us_topic_0027371529: - -Monitoring ECSs -=============== - -Monitoring is key for ensuring ECS performance, reliability, and availability. Using monitored data, you can determine ECS resource utilization. The public cloud provides Cloud Eye to help you obtain the running statuses of your ECSs. You can use Cloud Eye to automatically monitor ECSs in real time and manage alarms and notifications to keep track of ECS performance metrics. - -This section covers the following content: - -- Viewing basic ECS metrics -- Customizing ECS alarm rules -- Viewing ECS running statuses for routine monitoring diff --git a/ecs/umn/result/monitoring/setting_alarm_rules.rst b/ecs/umn/result/monitoring/setting_alarm_rules.rst deleted file mode 100644 index 42e535eb..00000000 --- a/ecs/umn/result/monitoring/setting_alarm_rules.rst +++ /dev/null @@ -1,54 +0,0 @@ -:original_name: en-us_topic_0027371531.html - -.. _en-us_topic_0027371531: - -Setting Alarm Rules -=================== - -Scenarios ---------- - -Setting ECS alarm rules allows you to customize the monitored objects and notification policies so that you can closely monitor your ECSs. - -This section describes how to set ECS alarm rules, including alarm rule names, monitoring objects, monitoring metrics, alarm thresholds, monitoring intervals, and notifications. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Management & Deployment**, click **Cloud Eye**. - -#. In the navigation pane on the left, choose **Alarm Management** > **Alarm Rules**. - -#. On the **Alarm Rules** page, click **Create Alarm Rule** to create an alarm rule, or modify an existing alarm rule. - - The following operations use modifying an existing alarm rule as an example. - - a. Click the target alarm rule. - - b. Click **Modify** in the upper right corner of the page. - - c. In the **Modify Alarm Rule** dialog box shown in :ref:`Figure 1 `, set the parameters as prompted. - - .. _en-us_topic_0027371531__fig5398007222382: - - .. figure:: /_static/images/en-us_image_0022382203.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Modifying an alarm rule - - d. Click **OK**. - - After an alarm rule is modified, the system automatically notifies you of an alarm when the alarm complying with the alarm rule is generated. - - .. note:: - - For more information about ECS alarm rules, see *Cloud Eye User Guide*. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/monitoring/viewing_ecs_metrics.rst b/ecs/umn/result/monitoring/viewing_ecs_metrics.rst deleted file mode 100644 index adb26b6d..00000000 --- a/ecs/umn/result/monitoring/viewing_ecs_metrics.rst +++ /dev/null @@ -1,52 +0,0 @@ -:original_name: en-us_topic_0027371530.html - -.. _en-us_topic_0027371530: - -Viewing ECS Metrics -=================== - -Scenarios ---------- - -The public cloud platform provides Cloud Eye, which monitors the running statuses of your ECSs. You can obtain the monitoring metrics of each ECS on the management console. - -Prerequisites -------------- - -- The ECS is running properly. - - Cloud Eye does not display the monitoring data for a stopped, faulty, or deleted ECS. After such an ECS restarts or recovers, the monitoring data is available in Cloud Eye. - - .. note:: - - Cloud Eye discontinues monitoring ECSs that remain in **Stopped** or **Faulty** state for 24 hours and removes them from the monitoring list. However, the alarm rules for such ECSs are not automatically deleted. - -- Alarm rules have been configured in Cloud Eye for the target ECS. - - The monitoring data is unavailable for the ECSs without alarm rules configured in Cloud Eye. For details, see :ref:`Setting Alarm Rules `. - -- The target ECS has been properly running for at least 10 minutes. - - The monitoring data and graphics are available for a new ECS after the ECS runs for at least 10 minutes. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the search box above the upper right corner of the ECS list, enter the ECS name, IP address, or ID for search. - -#. Click the name of the target ECS. The page providing details about the ECS is displayed. - -#. Click the **Monitoring** tab to view the monitoring data. - -#. In the ECS monitoring area, select a duration to view the monitoring data. - - You can view the monitoring data of the ECS in the last 1, 3, or 12 hours. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/nics/adding_a_nic.rst b/ecs/umn/result/nics/adding_a_nic.rst deleted file mode 100644 index e152af93..00000000 --- a/ecs/umn/result/nics/adding_a_nic.rst +++ /dev/null @@ -1,102 +0,0 @@ -:original_name: en-us_topic_0093492518.html - -.. _en-us_topic_0093492518: - -Adding a NIC -============ - -Scenarios ---------- - -If multiple NICs are required by your ECS, you can add them to your ECS. To add a NIC to the ECS, perform the following operations: - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **NICs** tab. Then, click **Add NIC**. - -#. Select the subnet and security group to be added. - - .. _en-us_topic_0093492518__fig188071746111817: - - .. figure:: /_static/images/en-us_image_0093507600.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Selecting the security group and subnet - - - **Security Group**: You can select multiple security groups. In such a case, the access rules of all the selected security groups apply on the ECS. - - **Private IP Address**: If you want to add a NIC with a specified IP address, enter an IP address into the **Private IP Address** field. - -#. Click **OK**. - -Follow-up Procedure -------------------- - -Some OSs cannot identify newly added NICs. In this case, you must manually activate the NICs. Ubuntu is used as an example in the following NIC activation procedure. Required operations may vary among systems. For additional information, see the documentation for your OS. - -#. Locate the row containing the target ECS and click **Remote Login** in the **Operation** column. - - Log in to the ECS. - -#. .. _en-us_topic_0093492518__li595089165210: - - Run the following command to view the NIC name: - - **ifconfig -a** - - In this example, the NIC name is **eth2**. - -#. Run the following command to switch to the target directory: - - **cd /etc/network** - -#. Run the following command to open the **interfaces** file: - - **vi interfaces** - -#. Add the following information to the **interfaces** file: - - **auto** *eth2* - - **iface** *eth2* **inet dhcp** - -#. Run the following command to save and exit the **interfaces** file: - - **:wq** - -#. Run either the **ifup eth2** command or the **/etc/init.d/networking restart** command to make the newly added NIC take effect. - - *X* in the preceding command indicates the NIC name and SN, for example, **ifup eth2**. - -#. Run the following command to check whether the NIC name obtained in step :ref:`2 ` is displayed in the command output: - - **ifconfig** - - For example, check whether **eth2** is displayed in the command output. - - - If yes, the newly added NIC has been activated, and no further action is required. - - If no, the newly added NIC failed to be activated. Go to step :ref:`9 `. - -#. .. _en-us_topic_0093492518__li1695469165210: - - Log in to the management console. Locate the row containing the target ECS, click **More** in the **Operation** column, and select **Restart**. - -#. Run the following command to check whether the NIC name obtained in step :ref:`2 ` is displayed in the command output: - - - If yes, no further action is required. - - If no, contact customer service. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/nics/deleting_a_nic.rst b/ecs/umn/result/nics/deleting_a_nic.rst deleted file mode 100644 index 11ec58da..00000000 --- a/ecs/umn/result/nics/deleting_a_nic.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_0093492519.html - -.. _en-us_topic_0093492519: - -Deleting a NIC -============== - -Scenarios ---------- - -An ECS can have up to 12 NICs, including one primary NIC that cannot be deleted and extension NICs. This section describes how to delete an extension NIC. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **NICs** tab. Then, click **Delete** in the row of the target NIC. - - .. note:: - - You are not allowed to delete the primary ECS NIC. By default, the primary ECS NIC is the first NIC displayed in the NIC list. - -#. Click **Yes** in the displayed dialog box. - - .. note:: - - Certain ECSs do not support NIC deletion when they are running. For details about these ECSs, see the GUI display. To delete a NIC from such an ECS, stop the ECS. - -.. |image1| image:: /_static/images/en-us_image_0093507592.png - diff --git a/ecs/umn/result/nics/enabling_nic_multi-queue.rst b/ecs/umn/result/nics/enabling_nic_multi-queue.rst deleted file mode 100644 index a6cd4ad8..00000000 --- a/ecs/umn/result/nics/enabling_nic_multi-queue.rst +++ /dev/null @@ -1,323 +0,0 @@ -:original_name: en-us_topic_0058758453.html - -.. _en-us_topic_0058758453: - -Enabling NIC Multi-Queue -======================== - -Scenarios ---------- - -Single-core CPU performance cannot meet the requirement of processing NIC interruptions incurred with the increase of network I/O bandwidth. NIC multi-queue enables multiple CPUs to process ECS NIC interruptions, thereby improving PPS and I/O performance. - -The ECS described in this section is assumed to comply with the requirements on specifications and virtualization type. - -- If the ECS was created using a public image listed in :ref:`Support of NIC Multi-Queue `, NIC multi-queue has been enabled on the ECS by default. Therefore, you do not need to perform the operations described in this section. -- If the ECS was created using a private image and the OS of the external image file is listed in :ref:`Support of NIC Multi-Queue `, perform the following operations to enable NIC multi-queue: - - #. :ref:`Importing the External Image File to the IMS Console ` - #. :ref:`Setting NIC Multi-Queue for the Image ` - #. :ref:`Creating an ECS Using a Private Image ` - #. :ref:`Enabling NIC Multi-Queue ` - -.. _en-us_topic_0058758453__section892862210138: - -Support of NIC Multi-Queue --------------------------- - -NIC multi-queue can be enabled on an ECS only when the ECS specifications, virtualization type, and image OS meet the requirements described in this section. - -- For details about the ECS specifications that support NIC multi-queue, see :ref:`ECS Specifications and Types `. - - .. note:: - - If the number of NIC queues is greater than 1, NIC multi-queue is supported. - -- The virtualization type must be KVM. -- The Linux public images listed in :ref:`Table 2 ` support NIC multi-queue. - - .. note:: - - - Windows public images have not supported NIC multi-queue. If you enable NIC multi-queue in a Windows public image, starting an ECS created using such an image may be slow. - - - It is a good practice to upgrade the kernel version of the Linux ECS to 2.6.35 or later. Otherwise, NIC multi-queue is not supported. - - Run the **uname -r** command to obtain the kernel version. If the kernel version is earlier than 2.6.35, contact customer service to upgrade the kernel. - -.. table:: **Table 1** Support of NIC multi-queue for Linux ECSs - - +----------------------------------------------------+----------------------------+------------------------------------+ - | Image | Support of NIC Multi-Queue | NIC Multi-Queue Enabled by Default | - +====================================================+============================+====================================+ - | Ubuntu 14.04/16.04/18.04/20.04 server 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | OpenSUSE 42.2/15.\* 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | SUSE Enterprise 12 SP1/SP2 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | CentOS 6.8/6.9/7.*/8.\* 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | Debian 8.0.0/8.8.0/8.9.0/9.0.0/10.0.0/10.2.0 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | Fedora 24/25/30 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - | EulerOS 2.2/2.3/2.5 64bit | Yes | Yes | - +----------------------------------------------------+----------------------------+------------------------------------+ - -.. _en-us_topic_0058758453__table1572993710538: - -.. table:: **Table 2** Support of NIC multi-queue for KVM ECSs - - +---------+-------------------------------------------------------------+--------------------------------+ - | OS | Image | Status | - +=========+=============================================================+================================+ - | Windows | Windows Server 2008 Web R2 64-bit | Supported using private images | - +---------+-------------------------------------------------------------+--------------------------------+ - | | Windows Server 2008 R2 Standard/DataCenter/Enterprise 64bit | Supported using private images | - +---------+-------------------------------------------------------------+--------------------------------+ - | | Windows Server 2012 R2 Standard/DataCenter 64bit | Supported using private images | - +---------+-------------------------------------------------------------+--------------------------------+ - | | Windows Server 2016 Standard/DataCenter 64bit | Supported using private images | - +---------+-------------------------------------------------------------+--------------------------------+ - | Linux | Ubuntu 14.04/16.04 server 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | OpenSUSE 42.2 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | SUSE Enterprise 12 SP1/SP2 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | CentOS 6.8/6.9/7.0/7.1/7.2/7.3/7.4/7.5/7.6 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | Debian 8.0.0/8.8.0/8.9.0/9.0.0 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | Fedora 24/25 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - | | EulerOS 2.2 64bit | Supported | - +---------+-------------------------------------------------------------+--------------------------------+ - -.. _en-us_topic_0058758453__section1659682611504: - -Importing the External Image File to the IMS Console ----------------------------------------------------- - -For details, see "Registering an Image File as a Private Image" in *Image Management Service User Guide*. - -.. _en-us_topic_0058758453__section1949113217282: - -Setting NIC Multi-Queue for the Image -------------------------------------- - -Windows OSs have not commercially supported NIC multi-queue. If you enable NIC multi-queue in a Windows image, starting an ECS created using such an image may be slow. - -Use one of the following methods to set the NIC multi-queue attribute: - -**Method 1:** - -#. Log in to the management console. -#. Under Computing, click **Image Management Service**. -#. Click the **Private Images** tab, locate the row containing the target image, click **Modify** in the **Operation** column. -#. Set the NIC multi-queue attribute of the image. - -**Method 2:** - -#. Log in to the management console. -#. Under Computing, click **Image Management Service**. -#. Click the **Private Images** tab. In the image list, click the name of the target image to switch to the page providing details about the image. -#. Click **Modify** in the upper right corner. In the displayed **Modify Image** dialog box, set the NIC multi-queue attribute. - -**Method 3:** Add **hw_vif_multiqueue_enabled** to an image through the API. - -#. .. _en-us_topic_0058758453__en-us_topic_0085214115_li13762086162643: - - For instructions about how to obtain the token, see `Token Authentication `__. - -#. For instructions about how to call an API to update image information, see "Updating Image Information (Native OpenStack API)" in *Image Management Service API Reference*. - -#. Add **X-Auth-Token** to the request header. - - The value of **X-Auth-Token** is the token obtained in step :ref:`1 `. - -#. Add **Content-Type** to the request header. - - The value of **Content-Type** is **application/openstack-images-v2.1-json-patch**. - - The request URI is in the following format: - - PATCH /v2/images/{image_id} - - The request body is as follows: - - .. code-block:: - - [ - { - "op":"add", - "path":"/hw_vif_multiqueue_enabled", - "value": "true" - } - ] - - :ref:`Figure 1 ` shows an example request body for modifying the NIC multi-queue attribute. - - .. _en-us_topic_0058758453__en-us_topic_0085214115_fig3215821216479: - - .. figure:: /_static/images/en-us_image_0193026956.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Example request body - -.. _en-us_topic_0058758453__section1841681225617: - -Creating an ECS Using a Private Image -------------------------------------- - -Create an ECS using a registered private image. For details, see :ref:`Creating an ECS `. Note the following when setting the parameters: - -- **Region**: Select the region where the private image is located. -- **Image**: Select **Private image** and then the desired image from the drop-down list. - -.. _en-us_topic_0058758453__section214227201118: - -.. _enabling-nic-multi-queue-1: - -Enabling NIC Multi-Queue ------------------------- - -KVM Windows ECSs use private images to support NIC multi-queue. For details, see "How Do I Set NIC Multi-queue Feature of an Image?" in *Image Management Service User Guide*. - -This section uses a Linux ECS running CentOS 7.4 as an example to describe how to enable NIC multi-queue. - -#. Enable NIC multi-queue. - - a. Log in to the ECS. - - b. Run the following command to obtain the number of queues supported by the NIC and the number of queues with NIC multi-queue enabled: - - **ethtool -l** *NIC* - - c. Run the following command to configure the number of queues used by the NIC: - - **ethtool -L** *NIC* **combined** *Number of queues* - - An example is provided as follows: - - .. code-block:: - - [root@localhost ~]# ethtool -l eth0 #View the number of queues used by NIC eth0. - Channel parameters for eth0: - Pre-set maximums: - RX: 0 - TX: 0 - Other: 0 - Combined: 4 #Indicates that a maximum of four queues can be enabled for the NIC. - Current hardware settings: - RX: 0 - TX: 0 - Other: 0 - Combined: 1 #Indicates that one queue has been enabled. - - [root@localhost ~]# ethtool -L eth0 combined 4 #Enable four queues on NIC eth0. - -#. (Optional) Enable irqbalance so that the system automatically allocates NIC interrupts on multiple vCPUs. - - a. Run the following command to enable irqbalance: - - **service irqbalance start** - - b. Run the following command to view the irqbalance status: - - **service irqbalance status** - - If the **Active** value in the command output contains **active (running)**, irqbalance has been enabled. - - .. _en-us_topic_0058758453__fig165114253253: - - .. figure:: /_static/images/en-us_image_0126402833.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Enabled irqbalance - -#. (Optional) Enable interrupt binding. - - Enabling irqbalance allows the system to automatically allocate NIC interrupts, improving network performance. If the improved network performance still fails to meet your requirements, manually configure interrupt affinity on the ECS. - - To do so, perform the following operations: - - Configure the following script so that one ECS vCPU serves the interrupt requests initialized by one queue. One queue corresponds to one interrupt, and one interrupt binds to one vCPU. - - .. code-block:: - - #!/bin/bash - service irqbalance stop - - eth_dirs=$(ls -d /sys/class/net/eth*) - if [ $? -ne 0 ];then - echo "Failed to find eth* , sleep 30" >> $ecs_network_log - sleep 30 - eth_dirs=$(ls -d /sys/class/net/eth*) - fi - - for eth in $eth_dirs - do - cur_eth=$(basename $eth) - cpu_count=`cat /proc/cpuinfo| grep "processor"| wc -l` - virtio_name=$(ls -l /sys/class/net/"$cur_eth"/device/driver/ | grep pci |awk {'print $9'}) - - affinity_cpu=0 - virtio_input="$virtio_name""-input" - irqs_in=$(grep "$virtio_input" /proc/interrupts | awk -F ":" '{print $1}') - for irq in ${irqs_in[*]} - do - echo $((affinity_cpu%cpu_count)) > /proc/irq/"$irq"/smp_affinity_list - affinity_cpu=$[affinity_cpu+2] - done - - affinity_cpu=1 - virtio_output="$virtio_name""-output" - irqs_out=$(grep "$virtio_output" /proc/interrupts | awk -F ":" '{print $1}') - for irq in ${irqs_out[*]} - do - echo $((affinity_cpu%cpu_count)) > /proc/irq/"$irq"/smp_affinity_list - affinity_cpu=$[affinity_cpu+2] - done - done - -#. (Optional) Enable XPS and RPS. - - XPS allows the system with NIC multi-queue enabled to select a queue by vCPU when sending a data packet. - - .. code-block:: - - #!/bin/bash - # enable XPS feature - cpu_count=$(grep -c processor /proc/cpuinfo) - dec2hex(){ - echo $(printf "%x" $1) - } - eth_dirs=$(ls -d /sys/class/net/eth*) - if [ $? -ne 0 ];then - echo "Failed to find eth* , sleep 30" >> $ecs_network_log - sleep 30 - eth_dirs=$(ls -d /sys/class/net/eth*) - fi - for eth in $eth_dirs - do - cpu_id=1 - cur_eth=$(basename $eth) - cur_q_num=$(ethtool -l $cur_eth | grep -iA5 current | grep -i combined | awk {'print $2'}) - for((i=0;i $xps_file - echo $cpuset > $rps_file - let cpu_id=cpu_id*2 - done - done diff --git a/ecs/umn/result/nics/index.rst b/ecs/umn/result/nics/index.rst deleted file mode 100644 index 29cf230e..00000000 --- a/ecs/umn/result/nics/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0092497777: - -==== -NICs -==== - -.. toctree:: - :maxdepth: 1 - - adding_a_nic - deleting_a_nic - modifying_a_private_ip_address - managing_virtual_ip_addresses - enabling_nic_multi-queue diff --git a/ecs/umn/result/nics/managing_virtual_ip_addresses.rst b/ecs/umn/result/nics/managing_virtual_ip_addresses.rst deleted file mode 100644 index 4a531c23..00000000 --- a/ecs/umn/result/nics/managing_virtual_ip_addresses.rst +++ /dev/null @@ -1,39 +0,0 @@ -:original_name: en-us_topic_0093492520.html - -.. _en-us_topic_0093492520: - -Managing Virtual IP Addresses -============================= - -Scenarios ---------- - -A virtual IP address provides the second IP address for one or more ECS NICs, improving high availability between the ECSs. - -One NIC can be bound with up to 10 virtual IP addresses, and one virtual IP address can be bound to up to 10 NICs. Multiple ECSs deployed to work in active/standby mode can be bound with the same virtual IP address for disaster recovery. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Network Interfaces** tab. Then, click **Manage Virtual IP Address**. - - The **Virtual Private Cloud** page is displayed. - -#. On the **IP Addresses** tab, select a desired one or click **Assign Virtual IP Address** for a new one. - -#. Click **Bind to Instance** in the **Operation** column and select the target ECS name and the NIC to bind the virtual IP address to the ECS NIC. - - For more information about virtual IP addresses, see *Virtual Private Cloud User Guide*. - -.. |image1| image:: /_static/images/en-us_image_0093518909.png - diff --git a/ecs/umn/result/nics/modifying_a_private_ip_address.rst b/ecs/umn/result/nics/modifying_a_private_ip_address.rst deleted file mode 100644 index 0a9e9cff..00000000 --- a/ecs/umn/result/nics/modifying_a_private_ip_address.rst +++ /dev/null @@ -1,42 +0,0 @@ -:original_name: en-us_topic_0133339807.html - -.. _en-us_topic_0133339807: - -Modifying a Private IP Address -============================== - -Scenarios ---------- - -You can modify the private IP address of the primary NIC. If you want to modify the private IP address of an extension NIC, delete the NIC and attach a new NIC. - -Constraints ------------ - -- The ECS must be stopped. -- If a virtual IP address or DNAT rule has been configured for the NIC, cancel the configuration before modifying the private IP address. -- If the NIC has an IPv6 address, its private IP address (IPv4 or IPv6 address) cannot be modified. -- Before changing the private IP address of an ELB backend server, delete the backend server group. - -Procedure ---------- - -#. Log in to the management console. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **NICs** tab. Locate the row containing the primary NIC and click **Modify Private IP**. - - The **Modify Private IP** dialog box is displayed. - -#. Change the subnet and private IP address of the primary NIC as required. - - .. note:: - - Subnets can be changed only within the same VPC. - - If the target private IP address is not specified, the system will automatically assign one to the primary NIC. diff --git a/ecs/umn/result/passwords_and_key_pairs/changing_the_login_password_on_an_ecs.rst b/ecs/umn/result/passwords_and_key_pairs/changing_the_login_password_on_an_ecs.rst deleted file mode 100644 index afe1a931..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/changing_the_login_password_on_an_ecs.rst +++ /dev/null @@ -1,81 +0,0 @@ -:original_name: en-us_topic_0122627689.html - -.. _en-us_topic_0122627689: - -Changing the Login Password on an ECS -===================================== - -Scenarios ---------- - -This section describes how to change the password for logging in to an ECS when the password is about to expire, the password is forgotten, or you are logging in to the ECS for the first time. It is a good practice to change the initial password upon the first login. - -Prerequisites -------------- - -The ECS can be logged in. - -Background ----------- - -:ref:`Table 1 ` shows the ECS password complexity requirements. - -.. _en-us_topic_0122627689__en-us_topic_0021426802_table4381109318958: - -.. table:: **Table 1** Password complexity requirements - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Requirement | Example Value | - +=======================+==============================================================================================================================================================+===============================================================+ - | Password | - Consists of 8 to 26 characters. | YNbUwp!dUc9MClnv | - | | - Contains at least three of the following character types: | | - | | | .. note:: | - | | - Uppercase letters | | - | | - Lowercase letters | The example password is generated randomly. Do not use it. | - | | - Digits | | - | | - Special characters: $!@%-_=+[]:./^,{}? | | - | | | | - | | - Cannot contain the username or the username spelled backwards. | | - | | - Cannot contain more than two consecutive characters in the same sequence as they appear in the username. (This requirement applies only to Windows ECSs.) | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -Windows -------- - -#. Log in to the ECS. - - For details, see :ref:`Login Overview `. - -#. Press **Win+R** to start the **Run** dialog box. - -#. Enter **cmd** to open the command-line interface (CLI) window. - -#. Run the following command to change the password (the new password must meet the requirements described in :ref:`Table 1 `): - - **net user** **Administrator** *New password* - -Linux ------ - -#. Use the existing key file to log in to the ECS as user **root** through SSH. - - For details, see :ref:`Login Using an SSH Key `. - -#. Run the following command to reset the password of user **root**: - - **passwd** - - To reset the password of another user, replace **passwd** with **passwd username**. - -#. Enter the new password as prompted. Ensure that the new password meets the requirements described in :ref:`Table 1 `. - - .. code-block:: - - New password: - Retype new password: - - If the following information is displayed, the password has been changed: - - .. code-block:: - - passwd: password updated successfully diff --git a/ecs/umn/result/passwords_and_key_pairs/creating_a_key_pair.rst b/ecs/umn/result/passwords_and_key_pairs/creating_a_key_pair.rst deleted file mode 100644 index 08c4b232..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/creating_a_key_pair.rst +++ /dev/null @@ -1,210 +0,0 @@ -:original_name: en-us_topic_0014250631.html - -.. _en-us_topic_0014250631: - -Creating a Key Pair -=================== - -Overview --------- - -A key pair that consists of a public key and a private key is required for authentication when you log in to an ECS. Both the public and private keys are used for authentication. Therefore, you must use an existing key pair or create a new one for remote login authentication. - -- Creating a key pair - - If no key pair is available, create one, in which the private key is used for login authentication. You can use either of the following methods to create a key pair: - - - (Recommended) Create a key pair on the management console. After the creation, the public key is automatically stored in the system, and the private key is manually stored in a local directory. For details, see :ref:`Creating a Key Pair on the Management Console `. - - Create a key pair using **puttygen.exe**. After the creation, both the public key and private key are stored locally. For details, see :ref:`Creating a Key Pair Using puttygen.exe `. After the creation, import the key pair by following the instructions provided in :ref:`Importing a Key Pair `. Then, the key pair can be used. - -- Using an existing key pair - - If a key pair is available locally, for example, generated using PuTTYgen, you can import the public key on the management console so that the system maintains the public key file. For details, see :ref:`Importing a Key Pair `. - - .. note:: - - If the public key of the existing key pair is stored by clicking **Save public key** of **puttygen.exe**, the public key cannot be imported to the management console. - - If this key pair must be used for remote authentication, see :ref:`Why Does a Key Pair Created Using puttygen.exe Fail to Be Imported on the Management Console? ` - -Constraints ------------ - -- ECSs support the following encryption algorithms: - - - SSH-2 (RSA, 1024) - - SSH-2 (RSA, 2048) - - SSH-2 (RSA, 4096) - -- The private key is one of the most important functions for protecting your ECS during remote login. Save the private key to your local directory and keep it secure. The private key can be downloaded only once. - -.. _en-us_topic_0014250631__section35336147204538: - -Creating a Key Pair on the Management Console ---------------------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the navigation pane on the left, choose **Key Pair**. - -#. On the right side of the page, click **Create Key Pair**. - -#. Enter the key name and click **OK**. - - An automatically allocated key name consists of **KeyPair-** and a 4-digit random number. Change it to an easy-to-remember one, for example, **KeyPair-xxxx_ecs**. - -#. Manually or automatically download the private key file. The file name is the specified key pair name with a suffix of .pem. Securely store the private key file. In the displayed dialog box, click **OK**. - - .. note:: - - This is the only opportunity for you to save the private key file. Keep it secure. When creating an ECS, provide the name of your desired key pair. Each time you log in to the ECS using SSH, provide the private key. - -.. _en-us_topic_0014250631__section38463609165715: - -Creating a Key Pair Using **puttygen.exe** ------------------------------------------- - -#. Download and install PuTTY and PuTTYgen. - - https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html - - .. note:: - - PuTTYgen is a key generator, which is used to create a key pair that consists of a public key and a private key for PuTTY. - -#. Obtain the public and private keys. - - a. Double-click **puttygen.exe** to switch to the **PuTTY Key Generator** page. - - .. _en-us_topic_0014250631__en-us_topic_0037960038_fig4490538015580: - - .. figure:: /_static/images/en-us_image_0272917695.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** PuTTY Key Generator - - b. Click **Generate**. - - The key generator automatically generates a key pair that consists of a public key and a private key. The public key is shown in the red box in :ref:`Figure 2 `. - - .. _en-us_topic_0014250631__en-us_topic_0037960038_fig4678746517750: - - .. figure:: /_static/images/en-us_image_0272919399.png - :alt: **Figure 2** Obtaining the public and private keys - - - **Figure 2** Obtaining the public and private keys - -#. .. _en-us_topic_0014250631__li24584709151818: - - Copy the public key content to a .txt file and save the file in a local directory. - - .. note:: - - Do not save the public key by clicking **Save public key**. Storing a public key by clicking **Save public key** of **puttygen.exe** will change the format of the public key content. Such a key cannot be imported to the management console. - -#. Save the private key and keep it secure. The private key can be downloaded only once. - - The format in which to save your private key varies depending on application scenarios: - - - Saving the private key in .ppk format - - When you are required to log in to a Linux ECS using PuTTY, you must use the .ppk private key. To save the private key in .ppk format, perform the following operations: - - a. On the **PuTTY Key Generator** page, choose **File** > **Save private key**. - - .. _en-us_topic_0014250631__fig1031955919299: - - .. figure:: /_static/images/en-us_image_0276033982.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 3** Save private key - - b. Save the converted private key, for example, **kp-123.ppk**, in a local directory. - - - Saving the private key in .pem format - - When you are required to log in to a Linux ECS using Xshell or attempt to obtain the password for logging in to a Windows ECS, you must use the .pem private key for authentication. To save the private key in .pem format, perform the following operations: - - a. Choose **Conversions** > **Export OpenSSH key**. - - .. note:: - - If you use this private file to obtain the password for logging in to a Windows ECS, when you choose **Export OpenSSH key**, do not configure **Key passphrase**. Otherwise, obtaining the password will fail. - - .. _en-us_topic_0014250631__fig15752222153016: - - .. figure:: /_static/images/en-us_image_0272919409.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 4** Export OpenSSH key - - b. Save the private key, for example, **kp-123.pem**, in a local directory. - -#. Import the public key to the system. For details, see "Copying the public key content" in :ref:`Importing a Key Pair `. - -.. _en-us_topic_0014250631__section62005706143441: - -Importing a Key Pair --------------------- - -If you store a public key by clicking **Save public key** of **puttygen.exe**, the format of the public key content will change. Such a key cannot be imported to the management console. To resolve this issue, obtain the public key content in correct format and import the content to the management console. For details, see :ref:`Why Does a Key Pair Created Using puttygen.exe Fail to Be Imported on the Management Console? ` - -#. Log in to the management console. - -#. Click |image2| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the navigation pane on the left, choose **Key Pair**. - -#. On the right side of the page, click **Import Key Pair**. - - .. _en-us_topic_0014250631__fig30209536143442: - - .. figure:: /_static/images/en-us_image_0037980515.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 5** Import Key Pair - -#. Use either of the following methods to import the key pair: - - - Selecting a file - - a. On the **Import Key Pair** page of the management console, click **Select File** and select the local public key file, for example, the .txt file saved in :ref:`3 `. - - .. note:: - - When importing a key pair, ensure that the public key is imported. Otherwise, the importing will fail. - - b. Click **OK**. - - After the public key is imported, you can change its name. - - - Copying the public key content - - a. Copy the content of the public key in .txt file into the **Public Key Content** text box. - b. Click **OK**. - -Helpful Links -------------- - -- :ref:`What Should I Do If a Key Pair Cannot Be Imported? ` -- :ref:`Why Does a Key Pair Created Using puttygen.exe Fail to Be Imported on the Management Console? ` - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/passwords_and_key_pairs/deleting_the_initial_password_for_logging_in_to_a_windows_ecs.rst b/ecs/umn/result/passwords_and_key_pairs/deleting_the_initial_password_for_logging_in_to_a_windows_ecs.rst deleted file mode 100644 index 1f3edafd..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/deleting_the_initial_password_for_logging_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: en-us_topic_0031107267.html - -.. _en-us_topic_0031107267: - -Deleting the Initial Password for Logging In to a Windows ECS -============================================================= - -Scenarios ---------- - -After you obtain the initial password, it is a good practice to delete it to ensure system security. - -Deleting the initial password does not affect ECS operation or login. Once deleted, the password cannot be retrieved. Before you delete a password, it is a good practice to record it. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, select the target ECS. - -#. In the **Operation** column, click **More** and select **Delete Password**. - - The system displays a message, asking you whether you want to delete the password. - -#. Click **OK** to delete the password. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/passwords_and_key_pairs/index.rst b/ecs/umn/result/passwords_and_key_pairs/index.rst deleted file mode 100644 index 7c0f6f7d..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0140313881: - -======================= -Passwords and Key Pairs -======================= - -.. toctree:: - :maxdepth: 1 - - changing_the_login_password_on_an_ecs - resetting_a_login_password/index - creating_a_key_pair - obtaining_the_password_for_logging_in_to_a_windows_ecs - deleting_the_initial_password_for_logging_in_to_a_windows_ecs diff --git a/ecs/umn/result/passwords_and_key_pairs/obtaining_the_password_for_logging_in_to_a_windows_ecs.rst b/ecs/umn/result/passwords_and_key_pairs/obtaining_the_password_for_logging_in_to_a_windows_ecs.rst deleted file mode 100644 index 1a4dd398..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/obtaining_the_password_for_logging_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0031107266.html - -.. _en-us_topic_0031107266: - -Obtaining the Password for Logging In to a Windows ECS -====================================================== - -Scenarios ---------- - -Password authentication is required to log in to a Windows ECS. Therefore, you must use the key file used when you created the ECS to obtain the administrator password generated during ECS creation. The administrator user is **Administrator** or the user configured using Cloudbase-Init. This password is randomly generated, offering high security. - -You can obtain the initial password for logging in to a Windows ECS through the management console or APIs. For details, see this section. - -Obtaining the Password Through the Management Console ------------------------------------------------------ - -#. Obtain the private key file (.pem file) used when you created the ECS. -#. Log in to the management console. -#. Click |image1| in the upper left corner and select your region and project. -#. Under **Computing**, click **Elastic Cloud Server**. -#. On the **Elastic Cloud Server** page, select the target ECS. -#. In the **Operation** column, click **More** and select **Get Password**. -#. Use either of the following methods to obtain the password through the key file: - - - Click **Select File** and upload the key file from a local directory. - - Copy the key file content to the text field. - -#. Click **Get Password** to obtain a random password. - -Obtaining the Password Through APIs ------------------------------------ - -#. Obtain the private key file (.pem file) used when you created the ECS. - -#. Set up the API calling environment. - -#. Call APIs. For details, see `API Usage Guidelines `__ in *Elastic Cloud Server API Reference*. - -#. .. _en-us_topic_0031107266__li5770130102852: - - Obtain the ciphertext password. - - Call the password obtaining APIs to obtain the ciphertext password of the public key encrypted using RSA. The API URI is in the format "GET /v2/{*tenant_id*}/servers/{*server_id*}/os-server-password". - - .. note:: - - For instructions about how to call the APIs, see `Retrieving the Password for Logging In to a Windows ECS (Native OpenStack API) `__ in *Elastic Cloud Server API Reference*. - -#. Decrypt the ciphertext password. - - Use the private key file used when you created the ECS to decrypt the ciphertext password obtained in step :ref:`4 `. - - a. Run the following command to convert the ciphertext password format to ".key -nocrypt" using OpenSSL: - - **openssl pkcs8 -topk8 -inform PEM -outform DER -in rsa_pem.key -out pkcs8_der.key -nocrypt** - - b. Invoke the Java class library **org.bouncycastle.jce.provider.BouncyCastleProvider** and use the key file to edit the code decryption ciphertext. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/index.rst b/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/index.rst deleted file mode 100644 index 47d41dd1..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0031073513: - -========================== -Resetting a Login Password -========================== - -.. toctree:: - :maxdepth: 1 - - resetting_the_password_for_logging_in_to_a_windows_ecs - resetting_the_password_for_logging_in_to_a_linux_ecs diff --git a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_linux_ecs.rst b/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_linux_ecs.rst deleted file mode 100644 index e10dff58..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_linux_ecs.rst +++ /dev/null @@ -1,111 +0,0 @@ -:original_name: en-us_topic_0021427650.html - -.. _en-us_topic_0021427650: - -Resetting the Password for Logging In to a Linux ECS -==================================================== - -Scenarios ---------- - -Keep your password secure. Reset the password if: - -- The password is forgotten. -- The password has expired. - -This section describes how to reset the password of user **root**. After resetting the password, you can log in to the ECS, and change the private key or reset the password of a non-**root** user. - -Prerequisites -------------- - -- A temporary Linux ECS which locates in the same AZ as the target ECS is available. -- You have bound an EIP to the temporary ECS. - -Procedure ---------- - -#. Download the script for resetting the password and upload the script to the temporary ECS. - - Contact customer service to obtain the password reset script. Use a connection tool, such as WinSCP, to upload the obtained **changepasswd.sh** script to the temporary ECS. - - To download WinSCP, log in at https://winscp.net/. - -#. .. _en-us_topic_0021427650__li19814359584: - - Stop the original Linux ECS, detach the system disk from it, and attach the system disk to the temporary ECS. - - a. Stop the original ECS, switch to the page providing details about the ECS, and click the **Disks** tab. - - .. note:: - - Do not forcibly stop the original ECS. Otherwise, password reset may fail. - - b. .. _en-us_topic_0021427650__li5640121684418: - - Locate the row containing the system disk to be detached and click **Detach** to detach the system disk from the ECS. - - c. On the page providing details about the temporary ECS, click the **Disks** tab. - - d. Click **Attach Disk**. In the displayed dialog box, select the system disk detached in step :ref:`2.b ` and attach it to the temporary ECS. - -#. Log in to the temporary ECS remotely and reset the password. - - a. Locate the row containing the temporary ECS and click **Remote Login** in the **Operation** column. - - b. .. _en-us_topic_0021427650__li664021617445: - - Run the following command to view the directory of the system disk detached from the original Linux ECS now attached to the temporary ECS: - - **fdisk -l** - - c. Run the following commands in the directory where the script is stored to run the script for resetting the password: - - **chmod +x changepasswd.sh** - - **./changepasswd.sh** - - When you run the password reset script, if the system displays a message indicating that there is no command related to logical volume manager (LVM), such as the message "no lvs command", install an LVM tool on the temporary ECS. The LVM2 tool is recommended, which can be installed by running the **yum install lvm2** command. - - .. note:: - - If the original ECS and the temporary ECS both run CentOS 7, a mount failure may occur during script execution. To resolve this issue, replace **mount $dev $mountPath** with **mount -o nouuid $dev $mountPath** in the script. - - d. Enter the new password and the directory obtained in step :ref:`3.b ` as prompted. - - If the following information is displayed, the password has been changed: - - .. code-block:: - - set password success. - -#. For a non-**root** user, perform the following operations to enable the login permission of user **root**: - - **vi /etc/ssh/sshd_config** - - Modify the following parameters: - - - Change **PasswordAuthentication no** to **PasswordAuthentication yes**. - - Alternatively, delete the comment tag (#) before **PasswordAuthentication yes**. - - - Change **PermitRootLogin no** to **PermitRootLogin yes**. - - Alternatively, delete the comment tag (#) before **PermitRootLogin yes**. - - - Change the value of **AllowUsers** to **root**. - - Search for **AllowUsers** in the file. If **AllowUsers** is unavailable, add it at the end of the file. - -#. Stop the temporary ECS, detach the system disk, attach the system disk to the original Linux ECS, and restart the original Linux ECS. - - a. Stop the temporary ECS, switch to the page providing details about the ECS, and click the **Disks** tab. - - b. .. _en-us_topic_0021427650__li964031614447: - - Click **Detach** to detach the data disk attached in step :ref:`2 `. - - c. On the page providing details about the original Linux ECS, click the **Disks** tab. - - d. Click **Attach Disk**. In the displayed dialog box, select the data disk detached in step :ref:`5.b ` and device name **/dev/sda**. - - e. Restart the original Linux ECS. diff --git a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_windows_ecs.rst b/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_windows_ecs.rst deleted file mode 100644 index 744c7b54..00000000 --- a/ecs/umn/result/passwords_and_key_pairs/resetting_a_login_password/resetting_the_password_for_logging_in_to_a_windows_ecs.rst +++ /dev/null @@ -1,170 +0,0 @@ -:original_name: en-us_topic_0021426802.html - -.. _en-us_topic_0021426802: - -Resetting the Password for Logging In to a Windows ECS -====================================================== - -Scenarios ---------- - -You can reset your ECS password if: - -- The password is forgotten. -- The password has expired. - -The method described in this section can only be used to change the password of a local Windows account, but not the password of a domain account. - -Prerequisites -------------- - -- A temporary Linux ECS which runs Ubuntu 14.04 or later and locates in the same AZ as the target ECS is available. - -- You have bound an EIP to the temporary ECS and configured the apt-get source. - -- You have used either of the following methods to install **ntfs-3g** and **chntpw** software packages on the temporary ECS: - - Method 1: - - Run the following command to install the **ntfs-3g** and **chntpw** software packages: - - **sudo apt-get install ntfs-3g chntpw** - - Method 2: - - Download the ntfs-3g and chntpw software packages of the version required by the temporary ECS OS. - - To obtain the ntfs-3g software package, log in at `www.tuxera.com/community/open-source-ntfs-3g/ `__. - - To obtain the chntpw software package, log in at https://www.chntpw.com/download/. - -Procedure ---------- - -#. Stop the original ECS, detach the system disk from it, and attach the system disk to the temporary ECS. - - a. Log in to the management console. - - b. Click |image1| in the upper left corner and select your region and project. - - c. Under **Computing**, click **Elastic Cloud Server**. - - d. Stop the original Windows ECS, switch to the page providing details about the ECS, and click the **Disks** tab. - - .. note:: - - Do not forcibly stop the Windows ECS. Otherwise, password reset may fail. - - e. .. _en-us_topic_0021426802__li49674320202157: - - Locate the row containing the system disk to be detached and click **Detach** to detach the system disk from the ECS. - - f. On the page providing details about the temporary ECS, click the **Disks** tab. - - g. .. _en-us_topic_0021426802__li32570973202157: - - Click **Attach Disk**. In the displayed dialog box, select the system disk detached in step :ref:`1.e ` and attach it to the temporary ECS. - -#. Log in to the temporary ECS remotely and attach the system disk. - - a. .. _en-us_topic_0021426802__li20334892202157: - - Run the following command to view the directory of the system disk detached from the original Windows ECS now attached to the temporary ECS: - - **fdisk -l** - - b. Run the following command to mount the file system of the detached system disk to the temporary ECS: - - **mount -t ntfs-3g /dev/**\ *Result obtained in step :ref:`2.a `* **/mnt/** - - For example, if the result obtained in step :ref:`2.a ` is **xvde2**, run the following command: - - **mount -t ntfs-3g /dev/xvde2 /mnt/** - - If the following error information is displayed after the preceding command is executed, the NTFS file systems may be inconsistent. In such a case, rectify the file system inconsistency. - - .. code-block:: - - The disk contains an unclean file system (0, 0). - Metadata kept in Windows cache, refused to mount. - Failed to mount '/dev/xvde2': Operation not permitted - The NTFS partition is in an unsafe state. Please resume and shutdown - Windows fully (no hibernation or fast restarting), or mount the volume - read-only with the 'ro' mount option. - - Back up the disk data, run the following command to rectify the NTFS file system inconsistency, and attach the system disk: - - **ntfsfix /dev/**\ *Result obtained in step :ref:`2.a `* - - For example, if the result obtained in step :ref:`2.a ` is **xvde2**, run the following command: - - **ntfsfix /dev/xvde2** - -#. Change the password and clear the original password. - - a. Run the following command to back up the SAM file: - - **cp /mnt/Windows/System32/config/SAM /mnt/Windows/System32/config/SAM.bak** - - b. Run the following command to change the password of a specified user: - - **chntpw -u** **Administrator /mnt/Windows/System32/config/SAM** - - c. Enter **1**, **q**, and **y** as prompted, and press **Enter**. - - The password has been reset if the following information is displayed: - - .. code-block:: - - Select: [q] > 1 - Password cleared! - Select: [q] > q - Hives that have changed: - #Name - 0 - Write hive files? (y/n) [n] : y - 0 - OK - -#. Stop the temporary ECS, detach the system disk, and attach the system disk to the original Windows ECS. - - a. Stop the temporary ECS, switch to the page providing details about the ECS, and click the **Disks** tab. - - b. .. _en-us_topic_0021426802__li46368402202157: - - Click **Detach** to detach the data disk temporarily attached in step :ref:`1.g `. - - c. On the page providing details about the original Windows ECS, click the **Disks** tab. - - d. Click **Attach Disk**. In the displayed dialog box, select the data disk detached in step :ref:`4.b ` and device name **/dev/sda**. - -#. Start the original Windows ECS and set a new login password. - - a. Click **Start** to start the original Windows ECS. After the status becomes **Running**, click **Remote Login** in the **Operation** column. - - b. Click **Start**. Enter **CMD** in the search box and press **Enter**. - - c. Run the following command to change the password (the new password must meet the requirements described in :ref:`Table 1 `): - - **net user** **Administrator** *New password* - - .. _en-us_topic_0021426802__en-us_topic_0021426802_table4381109318958: - - .. table:: **Table 1** Password complexity requirements - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Requirement | Example Value | - +=======================+==============================================================================================================================================================+===============================================================+ - | Password | - Consists of 8 to 26 characters. | YNbUwp!dUc9MClnv | - | | - Contains at least three of the following character types: | | - | | | .. note:: | - | | - Uppercase letters | | - | | - Lowercase letters | The example password is generated randomly. Do not use it. | - | | - Digits | | - | | - Special characters: $!@%-_=+[]:./^,{}? | | - | | | | - | | - Cannot contain the username or the username spelled backwards. | | - | | - Cannot contain more than two consecutive characters in the same sequence as they appear in the username. (This requirement applies only to Windows ECSs.) | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/resources_and_tags/index.rst b/ecs/umn/result/resources_and_tags/index.rst deleted file mode 100644 index f0ad7787..00000000 --- a/ecs/umn/result/resources_and_tags/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _en-us_topic_0183016706: - -================== -Resources and Tags -================== - -.. toctree:: - :maxdepth: 1 - - tag_management/index - quota_adjustment diff --git a/ecs/umn/result/resources_and_tags/quota_adjustment.rst b/ecs/umn/result/resources_and_tags/quota_adjustment.rst deleted file mode 100644 index 85d77823..00000000 --- a/ecs/umn/result/resources_and_tags/quota_adjustment.rst +++ /dev/null @@ -1,52 +0,0 @@ -:original_name: en-us_topic_0000001210881033.html - -.. _en-us_topic_0000001210881033: - -Quota Adjustment -================ - -What Is Quota? --------------- - -Quotas can limit the number or amount of resources available to users, such as the maximum number of ECSs or EVS disks that can be created. - -If the existing resource quota cannot meet your service requirements, you can apply for a higher quota. - -How Do I View My Quotas? ------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select the desired region and project. - -#. In the upper right corner of the page, click |image2|. - - The **Service Quota** page is displayed. - -#. View the used and total quota of each type of resources on the displayed page. - - If a quota cannot meet service requirements, apply for a higher quota. - -How Do I Apply for a Higher Quota? ----------------------------------- - -The system does not support online quota adjustment. If you need to adjust a quota, call the hotline or send an email to the customer service mailbox. Customer service personnel will timely process your request for quota adjustment and inform you of the real-time progress by making a call or sending an email. - -Before dialing the hotline number or sending an email, make sure that the following information has been obtained: - -- Domain name, project name, and project ID, which can be obtained by performing the following operations: - - Log in to the management console using the cloud account, click the username in the upper right corner, select **My Credentials** from the drop-down list, and obtain the domain name, project name, and project ID on the **My Credentials** page. - -- Quota information, which includes: - - - Service name - - Quota type - - Required quota - -`Learn how to obtain the service hotline and email address. `__ - -.. |image1| image:: /_static/images/en-us_image_0275513364.png - -.. |image2| image:: /_static/images/en-us_image_0152727234.png - diff --git a/ecs/umn/result/resources_and_tags/tag_management/adding_tags.rst b/ecs/umn/result/resources_and_tags/tag_management/adding_tags.rst deleted file mode 100644 index e72e88fc..00000000 --- a/ecs/umn/result/resources_and_tags/tag_management/adding_tags.rst +++ /dev/null @@ -1,107 +0,0 @@ -:original_name: en-us_topic_0183019669.html - -.. _en-us_topic_0183019669: - -Adding Tags -=========== - -Tags are used to identify cloud resources, such as ECSs, images, and disks. If you have multiple types of cloud resources which are associated with each other, you can add tags to the resources to classify and manage them easily. For more details, see :ref:`Overview `. - -You can add tags to ECSs in any of the following ways: - -- :ref:`Adding Tags When Creating an ECS ` -- :ref:`Adding Tags on the Page Providing Details About an ECS ` -- :ref:`Adding Tags on the TMS Console ` - -For details about how to use predefined tags, see :ref:`Using Predefined Tags `. - -.. _en-us_topic_0183019669__section619816351650: - -Adding Tags When Creating an ECS --------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click **Create ECS**. - -#. Configure ECS parameters. - - Select **Configure now** for **Advanced Options**. Then, add a tag key and tag value. For the tag key and tag value requirements, see :ref:`Table 1 `. - - .. note:: - - - For details about other parameters, see "Purchasing an ECS with Customized Configurations". - -.. _en-us_topic_0183019669__section15164103015253: - -Adding Tags on the Page Providing Details About an ECS ------------------------------------------------------- - -#. Log in to the management console. - -#. Click |image2| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Tags** tab and then **Add Tag**. In the displayed dialog box, enter the tag key and tag value. For the tag key and tag value requirements, see :ref:`Table 1 `. - - You can change the tag value after the tag is added. - -.. _en-us_topic_0183019669__section115321623241: - -Adding Tags on the TMS Console ------------------------------- - -.. note:: - - This method is suitable for adding tags with the same tag key to multiple resources. - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Tag Management Service**. - -#. On the displayed **Resource Tags** page, select the region where the resource is located, select **ECS** for **Resource Type**, and click **Search**. - - All ECSs matching the search criteria are displayed. - -#. In the **Search Result** area, click **Create Key**. In the displayed dialog box, enter a key (for example **project**) and click **OK**. - - After the tag is created, the tag key is added to the resource list. If the key is not displayed in the resource list, click |image3| and select the created key from the drop-down list. - - By default, the value of the tag key is **Not tagged**. You need to set a value for the tag of each resource to associate the tag with the resource. - -#. Click **Edit** to make the resource list editable. - -#. Locate the row containing the target ECS, click |image4|, and enter a value (for example **A**). - - After a value is set for a tag key, the number of tags is incremented by 1. Repeat the preceding steps to add tag values for other ECSs. - -.. _en-us_topic_0183019669__section648015120456: - -Using Predefined Tags ---------------------- - -If you want to add the same tag to multiple ECSs or other resources, you can create a predefined tag on the TMS console and then select the tag for the ECSs or resources. This frees you from having to repeatedly enter tag keys and values. To do so, perform the following operations: - -#. Log in to the management console. -#. Under **Management & Deployment**, click **Tag Management Service**. -#. In the navigation pane on the left, choose **Predefined Tags**. In the right pane, click **Create Tag** enter a key (for example **project**) and a value (for example **A**) in the displayed dialog box. -#. Choose **Service List** > **Computing** > **Elastic Cloud Server**, and select the predefined tag by following the procedure for adding a tag. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0210779229.png - -.. |image3| image:: /_static/images/en-us_image_0210875481.png - :class: imgResize - -.. |image4| image:: /_static/images/en-us_image_0210875480.png - diff --git a/ecs/umn/result/resources_and_tags/tag_management/deleting_a_tag.rst b/ecs/umn/result/resources_and_tags/tag_management/deleting_a_tag.rst deleted file mode 100644 index 25aca5f4..00000000 --- a/ecs/umn/result/resources_and_tags/tag_management/deleting_a_tag.rst +++ /dev/null @@ -1,88 +0,0 @@ -:original_name: en-us_topic_0183019671.html - -.. _en-us_topic_0183019671: - -Deleting a Tag -============== - -If you no longer need a tag, delete it in any of the following ways: - -- :ref:`Deleting a Tag on the Page Providing Details About an ECS ` -- :ref:`Deleting a Tag on the TMS Console ` -- :ref:`Batch Deleting Tags on the TMS Console ` - -.. _en-us_topic_0183019671__section8763326153815: - -Deleting a Tag on the Page Providing Details About an ECS ---------------------------------------------------------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Tags** tab. Locate the row containing the tag to be deleted and click **Delete** in the **Operation** column. In the **Delete Tag** dialog box, click **Yes**. - -.. _en-us_topic_0183019671__section167319315388: - -Deleting a Tag on the TMS Console ---------------------------------- - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Tag Management Service**. - -#. In the upper right corner of the page, click the username and select **Tag Management** from the drop-down list. - -#. On the **Resource Tags** page, set the search criteria for ECSs and click **Search**. - -#. In the **Search Result** area, click **Edit** to make the resource tag list editable. - - If the key of a tag you want to delete is not contained in the list, click |image2| and select the tag key from the drop-down list. It is a good practice to select at most 10 keys to display. - -#. Locate the row containing the target ECS and click |image3|. - -#. (Optional) Click |image4| in the upper right of the **Search Result** area. - - The resource list is refreshed and the refresh time is updated. - -.. _en-us_topic_0183019671__section13142241209: - -Batch Deleting Tags on the TMS Console --------------------------------------- - -.. important:: - - Exercise caution when deleting tags in a batch. After you delete the tags, they will be removed from all the associated ECSs and cannot be recovered. - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Tag Management Service**. - -#. On the **Resource Tags** page, set the search criteria for ECSs and click **Search**. - -#. Select the target ECSs. - -#. Click **Manage Tag** in the upper left corner of the list. - -#. In the displayed **Manage Tag** dialog box, click **Delete** in the **Operation** column. Click **OK**. - -#. (Optional) Click |image5| in the upper right of the **Search Result** area. - - The resource list is refreshed and the refresh time is updated. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - -.. |image2| image:: /_static/images/en-us_image_0210875481.png - -.. |image3| image:: /_static/images/en-us_image_0210875482.png - -.. |image4| image:: /_static/images/en-us_image_0210875483.png - -.. |image5| image:: /_static/images/en-us_image_0210875483.png - diff --git a/ecs/umn/result/resources_and_tags/tag_management/index.rst b/ecs/umn/result/resources_and_tags/tag_management/index.rst deleted file mode 100644 index 178e9c5d..00000000 --- a/ecs/umn/result/resources_and_tags/tag_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0183019668: - -============== -Tag Management -============== - -.. toctree:: - :maxdepth: 1 - - overview - adding_tags - searching_for_resources_by_tag - deleting_a_tag diff --git a/ecs/umn/result/resources_and_tags/tag_management/overview.rst b/ecs/umn/result/resources_and_tags/tag_management/overview.rst deleted file mode 100644 index a42b9ad4..00000000 --- a/ecs/umn/result/resources_and_tags/tag_management/overview.rst +++ /dev/null @@ -1,64 +0,0 @@ -:original_name: en-us_topic_0092499768.html - -.. _en-us_topic_0092499768: - -Overview -======== - -Scenarios ---------- - -A tag identifies an ECS. Adding tags to an ECS facilitates ECS identification and management. - -You can add a tag to an ECS during the ECS creation or after the ECS creation (**Tags** tab on the page providing details about the ECS). Up to 10 tags can be added to an ECS. - -.. note:: - - Tags added during ECS creation will also be added to the created EIP and EVS disks (including the system disk and data disks) of the ECS. If the ECS uses an existing EIP, the tags will not be added to the EIP. - - After creating the ECS, you can view the tags on the pages providing details about the ECS, EIP, and EVS disks. - -Basics of Tags --------------- - -Tags are used to identify cloud resources. When you have many cloud resources of the same type, you can use tags to classify cloud resources by dimension (for example, use, owner, or environment). - -.. _en-us_topic_0092499768__en-us_topic_0157874334_fig81911042564: - -.. figure:: /_static/images/en-us_image_0157904965.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Example tags - -:ref:`Figure 1 ` shows how tags work. In this example, you assign two tags to each cloud resource. Each tag contains a key and a value that you define. The key of one tag is **Owner**, and the key of another tag is **Use**. Each tag has a value. - -You can quickly search for and filter specific cloud resources based on the tags added to them. For example, you can define a set of tags for cloud resources in an account to track the owner and usage of each cloud resource, making resource management easier. - -Tag Naming Rules ----------------- - -- Each tag consists of a key-value pair. - -- Each ECS supports adding up to 10 tags. - -- For each resource, a tag key must be unique and can have only one tag value. - -- A tag consists of a tag key and a tag value. :ref:`Table 1 ` lists the tag key and value requirements. - - .. _en-us_topic_0092499768__table197401426182516: - - .. table:: **Table 1** Tag key and value requirements - - +-----------------------+---------------------------------------------------------------------------+-----------------------+ - | Parameter | Requirement | Example Value | - +=======================+===========================================================================+=======================+ - | Key | - Cannot be left blank. | Organization | - | | - The key value must be unique for an ECS. | | - | | - Can contain a maximum of 36 characters. | | - | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | | - +-----------------------+---------------------------------------------------------------------------+-----------------------+ - | Value | - Can contain a maximum of 43 characters. | Apache | - | | - Can only consist of digits, letters, hyphens (-), and underscores (_). | | - +-----------------------+---------------------------------------------------------------------------+-----------------------+ diff --git a/ecs/umn/result/resources_and_tags/tag_management/searching_for_resources_by_tag.rst b/ecs/umn/result/resources_and_tags/tag_management/searching_for_resources_by_tag.rst deleted file mode 100644 index e5f7c80f..00000000 --- a/ecs/umn/result/resources_and_tags/tag_management/searching_for_resources_by_tag.rst +++ /dev/null @@ -1,58 +0,0 @@ -:original_name: en-us_topic_0183019670.html - -.. _en-us_topic_0183019670: - -Searching for Resources by Tag -============================== - -After tags are added to resources, you can search for resources by tag using either of the following methods. - -Searching for ECSs by Tag -------------------------- - -On the **Elastic Cloud Server** page, search for ECSs by tag key or value. - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. Click **Search by Tag** above the upper right corner of the ECS list to expand the search area. - - .. _en-us_topic_0183019670__fig6766162682513: - - .. figure:: /_static/images/en-us_image_0183030460.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Searching for ECSs by tag - -#. Enter the tag of the ECS to be searched for. - - Neither the tag key nor value can be empty. When the tag key or value is matched, the system automatically shows the target ECSs. - -#. Add tags. - - The system supports multiple tags and uses the intersection set of all tags to search for ECSs. - -#. Click **Search**. - - The system searches for ECSs based on tag keys and values. - -Filtering Resources on the TMS Console --------------------------------------- - -#. Log in to the management console. - -#. Under **Management & Deployment**, click **Tag Management Service**. - -#. On the **Resource Tags** page, set the search criteria, including **Region**, **Resource Type**, and **Resource Tag**. - -#. Click **Search**. - - All the resources that meet the search criteria will be displayed in the **Search Result** area. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/security/index.rst b/ecs/umn/result/security/index.rst deleted file mode 100644 index b1caadd8..00000000 --- a/ecs/umn/result/security/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _en-us_topic_0092499769: - -======== -Security -======== - -.. toctree:: - :maxdepth: 1 - - security_groups/index diff --git a/ecs/umn/result/security/security_groups/changing_a_security_group.rst b/ecs/umn/result/security/security_groups/changing_a_security_group.rst deleted file mode 100644 index a69d186a..00000000 --- a/ecs/umn/result/security/security_groups/changing_a_security_group.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0093492517.html - -.. _en-us_topic_0093492517: - -Changing a Security Group -========================= - -Scenarios ---------- - -To change the security group of an ECS NIC, perform the operations described in this section. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. In the ECS list, locate the row that contains the target ECS. Click **More** in the **Operation** column and select **Manage Network** > **Change Security Group**. - - The **Change Security Group** dialog box is displayed. - - .. _en-us_topic_0093492517__fig1673733486: - - .. figure:: /_static/images/en-us_image_0122999741.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Change Security Group - -#. Select the target NIC and security groups as prompted. - - You can select multiple security groups. In such a case, the rules of all the selected security groups will be aggregated to apply on the ECS. - - To create a security group, click **Create Security Group**. - - .. note:: - - Using multiple security groups may deteriorate ECS network performance. You are suggested to select no more than five security groups. - -#. Click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0093507575.png - diff --git a/ecs/umn/result/security/security_groups/configuring_security_group_rules.rst b/ecs/umn/result/security/security_groups/configuring_security_group_rules.rst deleted file mode 100644 index bcd059cf..00000000 --- a/ecs/umn/result/security/security_groups/configuring_security_group_rules.rst +++ /dev/null @@ -1,110 +0,0 @@ -:original_name: en-us_topic_0030878383.html - -.. _en-us_topic_0030878383: - -Configuring Security Group Rules -================================ - -Scenarios ---------- - -Similar to firewall, a security group is a logical group used to control network access. You can define access rules for a security group to protect the ECSs that are added to this security group. - -- Inbound: Inbound rules allow external network traffic to be sent to the ECSs in the security group. -- Outbound: Outbound rules allow network traffic from the ECSs in the security group to be sent out of the security group. - -For details about the default security group rules, see *Virtual Private Cloud User Guide*. For details about configuration examples for security group rules, see :ref:`Security Group Configuration Examples `. - -Procedure ---------- - -#. Log in to the management console. - -#. Click |image1| in the upper left corner and select your region and project. - -#. Under **Computing**, click **Elastic Cloud Server**. - -#. On the **Elastic Cloud Server** page, click the name of the target ECS. - - The page providing details about the ECS is displayed. - -#. Click the **Security Groups** tab, expand the information of the security group, and view security group rules. - -#. Click the security group ID. - - The system automatically switches to the security group details page. - -#. On the **Inbound Rules** tab, click **Add Rule**. In the displayed dialog box, set required parameters to add an inbound rule. - - You can click **+** to add more inbound rules. - - .. _en-us_topic_0030878383__en-us_topic_0118534005_fig1786518124129: - - .. figure:: /_static/images/en-us_image_0284920908.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Add Inbound Rule - - .. table:: **Table 1** Inbound rule parameter description - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Description | Example Value | - +=======================+======================================================================================================================================================================================+=======================+ - | Protocol & Port | **Protocol**: The network protocol. Currently, the value can be **All**, **TCP**, **UDP**, **ICMP**, **GRE**, or others. | TCP | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | | **Port**: The port or port range over which the traffic can reach your ECS. The value ranges from 1 to 65535. | 22, or 22-30 | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Source | The source of the security group rule. The value can be a single IP address or a security group to allow access from the IP address or instances in the security group. For example: | 0.0.0.0/0 | - | | | | - | | - xxx.xxx.xxx.xxx/32 (IPv4 address) | | - | | - xxx.xxx.xxx.0/24 (IP address range) | | - | | - 0.0.0.0/0 (all IP addresses) | | - | | - sg-abc (security group) | | - | | | | - | | If the source is a security group, this rule will apply to all instances associated with the selected security group. | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Description | Supplementary information about the security group rule. This parameter is optional. | N/A | - | | | | - | | The security group rule description can contain a maximum of 255 characters and cannot contain angle brackets (< or >). | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - -#. On the **Outbound Rules** tab, click **Add Rule**. In the displayed dialog box, set required parameters to add an outbound rule. - - You can click **+** to add more outbound rules. - - .. _en-us_topic_0030878383__en-us_topic_0118534005_fig11809848184019: - - .. figure:: /_static/images/en-us_image_0284993717.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Add Outbound Rule - - .. table:: **Table 2** Outbound rule parameter description - - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Parameter | Description | Example Value | - +=======================+=========================================================================================================================================================================================+=======================+ - | Protocol & Port | **Protocol**: The network protocol. Currently, the value can be **All**, **TCP**, **UDP**, **ICMP**, **GRE**, or others. | TCP | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | | **Port**: The port or port range over which the traffic can leave your ECS. The value ranges from 1 to 65535. | 22, or 22-30 | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Destination | The destination of the security group rule. The value can be a single IP address or a security group to allow access to the IP address or instances in the security group. For example: | 0.0.0.0/0 | - | | | | - | | - xxx.xxx.xxx.xxx/32 (IPv4 address) | | - | | - xxx.xxx.xxx.0/24 (IP address range) | | - | | - 0.0.0.0/0 (all IP addresses) | | - | | - sg-abc (security group) | | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Description | Supplementary information about the security group rule. This parameter is optional. | N/A | - | | | | - | | The security group rule description can contain a maximum of 255 characters and cannot contain angle brackets (< or >). | | - +-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - -#. Click **OK** to complete the security rule configuration. - -.. |image1| image:: /_static/images/en-us_image_0210779229.png - diff --git a/ecs/umn/result/security/security_groups/default_security_group_and_rules.rst b/ecs/umn/result/security/security_groups/default_security_group_and_rules.rst deleted file mode 100644 index 1a5bb095..00000000 --- a/ecs/umn/result/security/security_groups/default_security_group_and_rules.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: en-us_topic_0140323154.html - -.. _en-us_topic_0140323154: - -Default Security Group and Rules -================================ - -Your account automatically comes with a default security group. The default security group allows all outbound traffic, denies all inbound traffic, and allows all traffic between cloud resources in the group. Your cloud resources in this security group can communicate with each other already without adding additional rules. - -:ref:`Figure 1 ` shows the default security group. - -.. _en-us_topic_0140323154__fig11890174421819: - -.. figure:: /_static/images/en-us_image_0000001230120807.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Default security group - -:ref:`Table 1 ` describes the rules for the default security group. - -.. _en-us_topic_0140323154__table542641118503: - -.. table:: **Table 1** Default security group rules - - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Direction | Protocol | Port/Range | Source/Destination | Description | - +===========+==========+============+==============================================================+====================================================================================================================+ - | Outbound | All | All | Destination: 0.0.0.0/0 | Allows all outbound traffic. | - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Inbound | All | All | Source: the current security group (for example, sg-*xxxxx*) | Allows communications among ECSs within the security group and denies all inbound traffic (incoming data packets). | - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/security/security_groups/index.rst b/ecs/umn/result/security/security_groups/index.rst deleted file mode 100644 index e33674f6..00000000 --- a/ecs/umn/result/security/security_groups/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0140323151: - -=============== -Security Groups -=============== - -.. toctree:: - :maxdepth: 1 - - overview - default_security_group_and_rules - security_group_configuration_examples - configuring_security_group_rules - changing_a_security_group diff --git a/ecs/umn/result/security/security_groups/overview.rst b/ecs/umn/result/security/security_groups/overview.rst deleted file mode 100644 index 4ea06c91..00000000 --- a/ecs/umn/result/security/security_groups/overview.rst +++ /dev/null @@ -1,31 +0,0 @@ -:original_name: en-us_topic_0140323157.html - -.. _en-us_topic_0140323157: - -Overview -======== - -Security Group --------------- - -A security group is a collection of access control rules for ECSs that have the same security protection requirements and that are mutually trusted. After a security group is created, you can create various access rules for the security group, these rules will apply to all ECSs added to this security group. - -You can also customize a security group or use the default one. The system provides a default security group for you, which permits all outbound traffic and denies inbound traffic. ECSs in a security group are accessible to each other. For details about the default security group, see :ref:`Default Security Group and Rules `. - -Security Group Rules --------------------- - -After a security group is created, you can add rules to the security group. A rule applies either to inbound traffic (ingress) or outbound traffic (egress). After ECSs are added to the security group, they are protected by the rules of that group. - -Each security group has default rules. For details, see :ref:`Default Security Group and Rules `. You can also customize security group rules. For details, see :ref:`Configuring Security Group Rules `. - -Security Group Constraints --------------------------- - -- By default, you can create a maximum of 100 security groups in your cloud account. -- By default, you can add up to 50 security group rules to a security group. -- By default, you can add an ECS or an extension NIC to a maximum of five security groups. In such a case, the rules of all the selected security groups are aggregated to take effect. -- When creating a private network load balancer, you need to select a desired security group. Do not delete the default security group rules or ensure that the following requirements are met: - - - Outbound rules: only allow data packets to the selected security group or only data packets from the peer load balancer. - - Inbound rules: only allow data packets from the selected security group or only data packets from the peer load balancer. diff --git a/ecs/umn/result/security/security_groups/security_group_configuration_examples.rst b/ecs/umn/result/security/security_groups/security_group_configuration_examples.rst deleted file mode 100644 index 70cedb51..00000000 --- a/ecs/umn/result/security/security_groups/security_group_configuration_examples.rst +++ /dev/null @@ -1,167 +0,0 @@ -:original_name: en-us_topic_0140323152.html - -.. _en-us_topic_0140323152: - -Security Group Configuration Examples -===================================== - -Common security group configuration examples are as follows: The following examples allow all outgoing data packets by default and only describe how to configure the inbound rules of a security group. - -- :ref:`Enabling ECSs in Different Security Groups to Communicate with Each Other Through an Internal Network ` -- :ref:`Enabling Specified IP Addresses to Remotely Access ECSs in a Security Group ` -- :ref:`Remotely Connecting to Linux ECSs Using SSH ` -- :ref:`Remotely Connecting to Windows ECSs Using RDP ` -- :ref:`Enabling Communication Between ECSs ` -- :ref:`Hosting a Website on ECSs ` -- :ref:`Enabling an ECS to Function as a DNS Server ` -- :ref:`Uploading or Downloading Files Using FTP ` - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section14197522283: - -Enabling ECSs in Different Security Groups to Communicate with Each Other Through an Internal Network ------------------------------------------------------------------------------------------------------ - -- Example scenario: - - Resources on an ECS in a security group need to be copied to an ECS associated with another security group. The two ECSs are in the same VPC. We recommend that you enable private network communication between the ECSs and then copy the resources. - -- Security group configuration: - - Within a given VPC, ECSs in the same security group can communicate with one another by default. However, ECSs in different security groups cannot communicate with each other by default. To enable these ECSs to communicate with each other, you need to add certain security group rules. - - You can add an inbound rule to the security groups containing the ECSs to allow access from ECSs in the other security group. The required rule is as follows. - - +-----------+----------------------------------------------------+--------------------+------------------------------+ - | Direction | Protocol/Application | Port | Source | - +===========+====================================================+====================+==============================+ - | Inbound | Used for communication through an internal network | Port or port range | ID of another security group | - +-----------+----------------------------------------------------+--------------------+------------------------------+ - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section17693183118306: - -Enabling Specified IP Addresses to Remotely Access ECSs in a Security Group ---------------------------------------------------------------------------- - -- Example scenario: - - To prevent ECSs from being attacked, you can change the port for remote login and configure security group rules that allow only specified IP addresses to remotely access the ECSs. - -- Security group configuration: - - To allow IP address **192.168.20.2** to remotely access Linux ECSs in a security group over the SSH protocol (port 22), you can configure the following security group rule. - - +-----------------+-----------------+-----------------+-------------------------------------------------+ - | Direction | Protocol | Port | Source | - +=================+=================+=================+=================================================+ - | Inbound | SSH | 22 | IPv4 CIDR block or ID of another security group | - | | | | | - | | | | For example, 192.168.20.2/32 | - +-----------------+-----------------+-----------------+-------------------------------------------------+ - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section115069253338: - -Remotely Connecting to Linux ECSs Using SSH -------------------------------------------- - -- Example scenario: - - After creating Linux ECSs, you can add a security group rule to enable remote SSH access to the ECSs. - -- Security group rule: - - ========= ======== ==== ========= - Direction Protocol Port Source - ========= ======== ==== ========= - Inbound SSH 22 0.0.0.0/0 - ========= ======== ==== ========= - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section168046312349: - -Remotely Connecting to Windows ECSs Using RDP ---------------------------------------------- - -- Example scenario: - - After creating Windows ECSs, you can add a security group rule to enable remote RDP access to the ECSs. - -- Security group rule: - - ========= ======== ==== ========= - Direction Protocol Port Source - ========= ======== ==== ========= - Inbound RDP 3389 0.0.0.0/0 - ========= ======== ==== ========= - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section34721049193411: - -Enabling Communication Between ECSs ------------------------------------ - -- Example scenario: - - After creating ECSs, you need to add a security group rule so that you can run the **ping** command to test communication between the ECSs. - -- Security group rule: - - ========= ======== ==== ========= - Direction Protocol Port Source - ========= ======== ==== ========= - Inbound ICMP All 0.0.0.0/0 - ========= ======== ==== ========= - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section1517991516357: - -Hosting a Website on ECSs -------------------------- - -- Example scenario: - - If you deploy a website on your ECSs and require that your website be accessed over HTTP or HTTPS, you can add rules to the security group used by the ECSs that function as the web servers. - -- Security group rule: - - ========= ======== ==== ========= - Direction Protocol Port Source - ========= ======== ==== ========= - Inbound HTTP 80 0.0.0.0/0 - Inbound HTTPS 443 0.0.0.0/0 - ========= ======== ==== ========= - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section2910346123520: - -Enabling an ECS to Function as a DNS Server -------------------------------------------- - -- Example scenario: - - If you need to use an ECS as a DNS server, you must allow TCP and UDP access from port 53 to the DNS server. You can add the following rules to the security group associated with the ECS. - -- Security group rules: - - ========= ======== ==== ========= - Direction Protocol Port Source - ========= ======== ==== ========= - Inbound TCP 53 0.0.0.0/0 - Inbound UDP 53 0.0.0.0/0 - ========= ======== ==== ========= - -.. _en-us_topic_0140323152__en-us_topic_0118534011_section5964121693610: - -Uploading or Downloading Files Using FTP ----------------------------------------- - -- Example scenario: - - If you want to use File Transfer Protocol (FTP) to upload files to or download files from ECSs, you need to add a security group rule. - - .. note:: - - You must first install the FTP server program on the ECSs and check whether ports 20 and 21 are working properly. - -- Security group rule: - - ========= ======== ===== ========= - Direction Protocol Port Source - ========= ======== ===== ========= - Inbound TCP 20-21 0.0.0.0/0 - ========= ======== ===== ========= diff --git a/ecs/umn/result/service_overview/cbr.rst b/ecs/umn/result/service_overview/cbr.rst deleted file mode 100644 index 2b670335..00000000 --- a/ecs/umn/result/service_overview/cbr.rst +++ /dev/null @@ -1,33 +0,0 @@ -:original_name: en-us_topic_0000001174675379.html - -.. _en-us_topic_0000001174675379: - -CBR -=== - -What Is CBR? ------------- - -Cloud Backup and Recovery (CBR) enables you to back up cloud servers and disks with ease. In case of a virus attack, accidental deletion, or software or hardware fault, you can restore data to any point in the past when the data was backed up. - -CBR protects your services by ensuring the security and consistency of your data. - -Differences Between Cloud Server Backup and Cloud Disk Backup -------------------------------------------------------------- - -You can back up ECS data using the Cloud Server Backup or Cloud Disk Backup function. - -- Cloud Server Backup (recommended): Use this backup function if you want to back up the data of all EVS disks (system and data disks) on an ECS. This prevents data inconsistency caused by time difference in creating a backup. -- Cloud Disk Backup: Use this backup function if you want to back up the data of one or more EVS disks (system or data disk) on an ECS. This minimizes backup costs on the basis of data security. - -.. table:: **Table 1** Differences between cloud server backup and cloud disk backup - - +---------------------------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | Item | Cloud Server Backup | Cloud Disk Backup | - +=======================================+==================================================================================+=========================================================================================================+ - | Resources to be backed up or restored | All disks (system and data disks) on a server | One or more specified disks (system or data disks) | - +---------------------------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | Recommended scenario | An entire cloud server needs to be protected. | Only data disks need to be backed up, because the system disk does not contain users' application data. | - +---------------------------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ - | Advantages | All disks on a server are backed up at the same time, ensuring data consistency. | Backup cost is reduced without compromising data security. | - +---------------------------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/service_overview/ecs_and_other_services.rst b/ecs/umn/result/service_overview/ecs_and_other_services.rst deleted file mode 100644 index 01ad4b49..00000000 --- a/ecs/umn/result/service_overview/ecs_and_other_services.rst +++ /dev/null @@ -1,60 +0,0 @@ -:original_name: en-us_topic_0013771111.html - -.. _en-us_topic_0013771111: - -ECS and Other Services -====================== - -:ref:`Figure 1 ` shows the relationships between ECS and other services. - -.. _en-us_topic_0013771111__fig44795566546: - -.. figure:: /_static/images/en-us_image_0225439857.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Relationships between ECS and other services - -ECS-related Services --------------------- - -- Auto Scaling (AS) - - Automatically adjusts ECS resources based on the configured AS policies. This improves resource usage and reduces resource costs. - -- Elastic Load Balancing (ELB) - - Automatically distributes traffic to multiple ECSs. This enhances system service and fault tolerance capabilities. - -- Elastic Volume Service (EVS) - - Enables you to attach EVS disks to an ECS and expand their capacity. - -- Virtual Private Cloud (VPC) - - Enables you to configure internal networks and change network configurations by customizing security groups, VPNs, IP address ranges, and bandwidth. This simplifies network management. You can also customize the ECS access rules within a security group and between security groups to improve ECS security. - -- Image Management Service (IMS) - - Enables you to create ECSs using images. This improves the efficiency of ECS creation. - -- Cloud Eye - - Allows you to check the status of monitored service objects after you have obtained an ECS. This can be done without requiring additional plug-ins be installed. For details about ECS metrics supported by Cloud Eye, see :ref:`Basic ECS Metrics `. - -- Key Management Service (KMS) - - The encryption feature relies on KMS. You can use an encrypted image or EVS disks when creating an ECS. In such a case, you are required to use the key provided by KMS to improve data security. - -- Cloud Trace Service (CTS) - - Records ECS-related operations for later query, audit, and backtrack. - -- Cloud Backup and Recovery (CBR) - - Backs up EVS disks and ECSs for restoration. You can back up all EVS disks (including the system disk and data disks) attached to an ECS and use the backup to restore the ECS data. - -- Tag Management Service (TMS) - - A tag identifies an ECS. Adding tags to an ECS facilitates ECS identification and management. diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/dedicated_general-purpose_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/dedicated_general-purpose_ecss.rst deleted file mode 100644 index 9572638c..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/dedicated_general-purpose_ecss.rst +++ /dev/null @@ -1,90 +0,0 @@ -:original_name: en-us_topic_0091224748.html - -.. _en-us_topic_0091224748: - -Dedicated General-Purpose ECSs -============================== - -Overview --------- - -C4 ECSs use second-generation Intel® Xeon® Scalable processors with technologies optimized and high-speed intelligent NICs to offer powerful and stable computing performance, including ultra-high network bandwidth and PPS. - -C3 ECSs are newly released. They are developed based on KVM virtualization, use Intel® Xeon® Scalable processors and Data Plane Development Kit (DPDK) rapid packet processing mechanism, and feature high and stable computing performance. Equipped with high-performance NICs, the C3 ECSs provide high performance and stability, meeting enterprise-grade application requirements. - -Specifications --------------- - -.. table:: **Table 1** C4 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+=====================================+ - | c4.large.2 | 2 | 4 | 4/1.2 | 40 | 2 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.xlarge.2 | 4 | 8 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.2xlarge.2 | 8 | 16 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.3xlarge.2 | 12 | 24 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.4xlarge.2 | 16 | 32 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.6xlarge.2 | 24 | 48 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.8xlarge.2 | 32 | 64 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.16xlarge.2 | 64 | 128 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.large.4 | 2 | 8 | 4/1.2 | 40 | 2 | 2 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.xlarge.4 | 4 | 16 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.2xlarge.4 | 8 | 32 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.3xlarge.4 | 12 | 48 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.4xlarge.4 | 16 | 64 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.6xlarge.4 | 24 | 96 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.8xlarge.4 | 32 | 128 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.16xlarge.4 | 64 | 256 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 2** C3 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+================================+ - | c3.large.2 | 2 | 4 | 1.5/0.6 | 30 | 2 | 12 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.xlarge.2 | 4 | 8 | 3/1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.2xlarge.2 | 8 | 16 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.4xlarge.2 | 16 | 32 | 10/4 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.8xlarge.2 | 32 | 64 | 15/8 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.15xlarge.2 | 60 | 128 | 17/16 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.large.4 | 2 | 8 | 1.5/0.6 | 30 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.xlarge.4 | 4 | 16 | 3/1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.2xlarge.4 | 8 | 32 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.4xlarge.4 | 16 | 64 | 10/4 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.8xlarge.4 | 32 | 128 | 15/8 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.15xlarge.4 | 60 | 256 | 16/16 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - -Scenarios ---------- - -- C4 ECSs: Websites and web applications, generalized databases and cache servers, and medium- and heavy-workload enterprise applications with strict requirements on computing and network performance -- C3 ECSs: Small- and medium-scale databases, cache servers, and search clusters with high requirements on stability; enterprise-grade applications of diverse types and in various scales diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/disk-intensive_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/disk-intensive_ecss.rst deleted file mode 100644 index 199be1d7..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/disk-intensive_ecss.rst +++ /dev/null @@ -1,115 +0,0 @@ -:original_name: en-us_topic_0035470099.html - -.. _en-us_topic_0035470099: - -Disk-intensive ECSs -=================== - -Overview --------- - -D2 ECSs are developed based on KVM virtualization. They use local storage and provide high storage performance and intranet bandwidth for distributed Hadoop computing, large data warehouse, distributed file system, and log/data processing. - -Specifications --------------- - -.. table:: **Table 1** D2 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Local Disks (GiB) | Hardware | - +===============+=======+==============+====================================+======================+=================+=====================+===================+=============================+ - | d2.xlarge.8 | 4 | 32 | 4/1.4 | 40 | 2 | KVM | 2×1675 | CPU: Intel® Xeon® Gold 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.2xlarge.8 | 8 | 64 | 6/2.8 | 80 | 4 | KVM | 4×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.4xlarge.8 | 16 | 128 | 10/5.6 | 160 | 6 | KVM | 8×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.6xlarge.8 | 24 | 192 | 15/8.5 | 250 | 8 | KVM | 12×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.8xlarge.8 | 32 | 256 | 17/11 | 320 | 8 | KVM | 16×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.15xlarge.9 | 60 | 540 | 17/17 | 500 | 16 | KVM | 24×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - -Scenarios ---------- - -- Applications - - Disk-intensive ECSs are suitable for applications that require large volumes of data to process, high I/O performance, and rapid data switching and processing. - -- Application scenarios - - Big data computing, network file systems, data processing, MapReduce, Hadoop, and data-intensive computing - -Features of D2 ECSs -------------------- - -- D2 ECSs use local disks to provide high sequential read/write performance and low latency, improving file read/write performance. -- D2 ECSs provide powerful and stable computing capabilities, ensuring efficient data processing. -- D2 ECSs with a vCPU/memory ratio of 1:8 process large volumes of data. -- D2 ECSs provide high intranet performance, including high intranet bandwidth and PPS, meeting requirements for data exchange between ECSs during peak hours. -- Each D2 ECS supports a maximum configuration of 24 local disks, 60 vCPUs, and 540 GiB memory. - -.. table:: **Table 2** Specifications of a single SAS HDD disk attached to a D2 ECS - - ================== ================= - Metric Performance - ================== ================= - Disk capacity 1800 GiB - Maximum throughput 230 MB/s - Access latency Millisecond-level - ================== ================= - -Notes on Using D2 ECSs ----------------------- - -- Currently, the following operating systems are supported (subject to the information displayed on the console): - - - CentOS 6.7/6.8/7.2/7.3/7.4 64bit - - SUSE Enterprise Linux Server 11 SP3/SP4 64bit - - SUSE Enterprise Linux Server 12 SP1/SP2 64bit - - Red Hat Enterprise Linux 6.8/7.3 64bit - - Windows Server 2008 R2 Enterprise 64bit - - Windows Server 2012 R2 Standard 64bit - - Windows Server 2016 Standard 64bit - - Debian 8.7/9/9.0.0 64bit - - EulerOS 2.2 64bit - - Fedora 25/26 64bit - - OpenSUSE 42.2/42.3 64bit - -- When the physical host where a D2 ECS is deployed becomes faulty, the ECS cannot be migrated. -- To improve network performance, you can set the NIC MTU of a D2 ECS to **8888**. -- D2 ECSs do not support modifying specifications. -- D2 ECSs do not support local disk snapshots or backups. -- D2 ECSs do not support OS reinstallation or change. -- D2 ECSs can use both local disks and EVS disks to store data. In addition, they can have EVS disks attached to provide a larger storage size. Use restrictions on the two types of storage media are as follows: - - - Only an EVS disk, not a local disk, can be used as the system disk of a D2 ECS. - - - Both EVS disks and local disks can be used as data disks of a D2 ECS. - - - A maximum of 60 disks (including VBD, SCSI, and local disks) can be attached to a D2 ECS. Among the 60 disks, the maximum number of SCSI disks is 30, and the VBD disks (including the system disk) is 24. For details, see :ref:`Can I Attach Multiple Disks to an ECS? ` - - .. note:: - - The maximum number of disks attached to an existing D2 ECS remains unchanged. To attach 60 disks, enable advanced disk. For details, see :ref:`Enabling Advanced Disk `. - - - You are advised to use World Wide Names (WWNs), but not drive letters, in applications to perform operations on local disks to prevent drive letter drift (low probability) on Linux. Take local disk attachment as an example: - - If the local disk WWN is wwn-0x50014ee2b14249f6, run the **mount /dev/disk/by-id/wwn-0x50014ee2b14249f6** command. - - .. note:: - - How can I view the local disk WWN? - - #. Log in to the ECS. - - #. Run the following command: - - **ll /dev/disk/by-id** - -- The local disk data of a D2 ECS may be lost due to some reasons, such as physical server breakdown or local disk damage. If the data reliability of your application cannot be ensured, you are strongly advised to use EVS disks to build your ECS. -- When a D2 ECS is deleted, its local disk data is automatically deleted. Back up the data before deleting such an ECS. Deleting local disk data is time-consuming. Therefore, a D2 ECS requires a longer period of time than other ECSs for releasing resources. -- Do not store long-term service data in local disks. Instead, back up data in a timely manner and use a high availability data architecture. Store long-term service data in EVS disks. -- You are not allowed to buy additional local disks. The quantity and capacity of your local disks are determined according to your ECS flavor. For D2 ECSs, if additional local disks are required, buy them when creating the ECSs. diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/ecs_specifications.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/ecs_specifications.rst deleted file mode 100644 index 9a67f885..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/ecs_specifications.rst +++ /dev/null @@ -1,373 +0,0 @@ -:original_name: en-us_topic_0177512565.html - -.. _en-us_topic_0177512565: - -ECS Specifications -================== - -General-Purpose ---------------- - -.. table:: **Table 1** S3 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+=====================+=====================================+ - | s3.medium.1 | 1 | 1 | 0.8/0.15 | 10 | 1 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6278 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.1 | 2 | 2 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.1 | 4 | 4 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.1 | 8 | 8 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.1 | 16 | 16 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.1 | 32 | 32 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.2 | 1 | 2 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.2 | 2 | 4 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.2 | 4 | 8 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.2 | 8 | 16 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.2 | 16 | 32 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.2 | 32 | 64 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.4 | 1 | 4 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.4 | 2 | 8 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.4 | 4 | 16 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.4 | 8 | 32 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.4 | 16 | 64 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.4 | 32 | 128 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.8 | 1 | 8 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.8 | 2 | 16 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.8 | 4 | 32 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.8 | 8 | 64 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.8 | 16 | 128 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.8 | 32 | 256 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 2** S2 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+=====================+================================+ - | s2.medium.1 | 1 | 1 | 0.5/0.1 | 5 | 1 | 12 | KVM | CPU: Intel® Xeon® Skylake 6161 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.1 | 2 | 2 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.1 | 4 | 4 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.1 | 8 | 8 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.1 | 16 | 16 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.1 | 32 | 32 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.2 | 1 | 2 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.2 | 2 | 4 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.2 | 4 | 8 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.2 | 8 | 16 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.2 | 16 | 32 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.2 | 32 | 64 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.4 | 1 | 4 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.4 | 2 | 8 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.4 | 4 | 16 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.4 | 8 | 32 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.4 | 16 | 64 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.4 | 32 | 128 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.8 | 1 | 8 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.8 | 2 | 16 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.8 | 4 | 32 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.8 | 8 | 64 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.8 | 16 | 128 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.8 | 32 | 256 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - -Dedicated General-Purpose -------------------------- - -.. table:: **Table 3** C4 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+=====================================+ - | c4.large.2 | 2 | 4 | 4/1.2 | 40 | 2 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.xlarge.2 | 4 | 8 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.2xlarge.2 | 8 | 16 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.3xlarge.2 | 12 | 24 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.4xlarge.2 | 16 | 32 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.6xlarge.2 | 24 | 48 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.8xlarge.2 | 32 | 64 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.16xlarge.2 | 64 | 128 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.large.4 | 2 | 8 | 4/1.2 | 40 | 2 | 2 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.xlarge.4 | 4 | 16 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.2xlarge.4 | 8 | 32 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.3xlarge.4 | 12 | 48 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.4xlarge.4 | 16 | 64 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.6xlarge.4 | 24 | 96 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.8xlarge.4 | 32 | 128 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | c4.16xlarge.4 | 64 | 256 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 4** C3 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+================================+ - | c3.large.2 | 2 | 4 | 1.5/0.6 | 30 | 2 | 12 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.xlarge.2 | 4 | 8 | 3/1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.2xlarge.2 | 8 | 16 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.4xlarge.2 | 16 | 32 | 10/4 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.8xlarge.2 | 32 | 64 | 15/8 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.15xlarge.2 | 60 | 128 | 17/16 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.large.4 | 2 | 8 | 1.5/0.6 | 30 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.xlarge.4 | 4 | 16 | 3/1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.2xlarge.4 | 8 | 32 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.4xlarge.4 | 16 | 64 | 10/4 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.8xlarge.4 | 32 | 128 | 15/8 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | c3.15xlarge.4 | 60 | 256 | 16/16 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - -Memory-optimized ----------------- - -.. table:: **Table 5** M4 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+=====================================+ - | m4.large.8 | 2 | 16 | 4/1.2 | 40 | 2 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.xlarge.8 | 4 | 32 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.2xlarge.8 | 8 | 64 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.3xlarge.8 | 12 | 96 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.4xlarge.8 | 16 | 128 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.6xlarge.8 | 24 | 192 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.8xlarge.8 | 32 | 256 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.16xlarge.8 | 64 | 512 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 6** M3 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+================================+ - | m3.large.8 | 2 | 16 | 1.5/0.6 | 30 | 2 | 12 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.xlarge.8 | 4 | 32 | 3/1.1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.2xlarge.8 | 8 | 64 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.4xlarge.8 | 16 | 128 | 10/4.5 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.8xlarge.8 | 32 | 256 | 15/9 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.15xlarge.8 | 60 | 512 | 17/17 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - -.. table:: **Table 7** M2 ECS specifications - - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Hardware | - +==============+=======+==============+====================================+======================+=================+=====================+========================================+ - | m2.4xlarge.8 | 16 | 128 | 8/5 | 40 | 4 | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - | m2.8xlarge.8 | 32 | 256 | 13/8 | 60 | 8 | KVM | | - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - -Large-Memory ------------- - -.. table:: **Table 8** E3 ECS specifications - - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Hardware | - +================+=======+==============+====================================+======================+=================+=====================+================================+ - | e3.7xlarge.12 | 28 | 348 | 25/12 | 280 | 8 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - | e3.14xlarge.12 | 56 | 696 | 25/25 | 500 | 16 | KVM | | - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - -Disk-intensive --------------- - -.. table:: **Table 9** D2 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Local Disks (GiB) | Hardware | - +===============+=======+==============+====================================+======================+=================+=====================+===================+=============================+ - | d2.xlarge.8 | 4 | 32 | 4/1.4 | 40 | 2 | KVM | 2×1675 | CPU: Intel® Xeon® Gold 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.2xlarge.8 | 8 | 64 | 6/2.8 | 80 | 4 | KVM | 4×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.4xlarge.8 | 16 | 128 | 10/5.6 | 160 | 6 | KVM | 8×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.6xlarge.8 | 24 | 192 | 15/8.5 | 250 | 8 | KVM | 12×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.8xlarge.8 | 32 | 256 | 17/11 | 320 | 8 | KVM | 16×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - | d2.15xlarge.9 | 60 | 540 | 17/17 | 500 | 16 | KVM | 24×1675 | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+-------------------+-----------------------------+ - -High-Performance Computing --------------------------- - -.. table:: **Table 10** HL1 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+---------------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Virtualization Type | Network Type | Hardware | - +===============+=======+==============+====================================+===================+=================+=====================+===========================+========================================+ - | hl1.8xlarge.8 | 32 | 256 | 9/9 | 90 | 8 | KVM | 100 Gbit/s EDR InfiniBand | CPU: Intel® Xeon® Processor E5-2690 v4 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+---------------------------+----------------------------------------+ - -.. table:: **Table 11** H2 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Virtualization Type | Local Disks | Capacity of One Local Disk (TB) | Network Type | Hardware | - +===============+=======+==============+====================================+===================+=================+=====================+=============+=================================+===========================+==============================+ - | h2.3xlarge.10 | 16 | 128 | 13/13 | 90 | 8 | KVM | 1 | 3.2 | 100 Gbit/s EDR InfiniBand | CPU: Intel® Xeon® E5-2667 v4 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - | h2.3xlarge.20 | 16 | 256 | 13/13 | 90 | 8 | KVM | 1 | 3.2 | 100 Gbit/s EDR InfiniBand | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - -GPU-accelerated ---------------- - -.. table:: **Table 12** G6 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Virtualization Type | Hardware | - +===============+=======+==============+====================================+===================+=================+==============+========+==================+=====================+=====================================+ - | g6.10xlarge.7 | 40 | 280 | 25/15 | 200 | 16 | 8 | 1 x T4 | 16 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - | g6.20xlarge.7 | 80 | 560 | 30/30 | 400 | 32 | 8 | 2 x T4 | 32 | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - -.. table:: **Table 13** P2s ECS specifications - - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Connection | GPU Memory (GiB) | Virtualization Type | Hardware | - +================+=======+==============+====================================+===================+=================+==============+==========+================+==================+=====================+==========================================================+ - | p2s.2xlarge.8 | 8 | 64 | 10/4 | 50 | 4 | 4 | 1 x V100 | PCIe Gen3 | 1 x 32 GiB | KVM | CPU: 2nd Generation Intel® Xeon® Scalable Processor 6278 | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.4xlarge.8 | 16 | 128 | 15/8 | 100 | 8 | 8 | 2 x V100 | PCIe Gen3 | 2 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.8xlarge.8 | 32 | 256 | 25/15 | 200 | 16 | 8 | 4 x V100 | PCIe Gen3 | 4 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.16xlarge.8 | 64 | 512 | 30/30 | 400 | 32 | 8 | 8 x V100 | PCIe Gen3 | 8 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - -.. table:: **Table 14** P2v ECS specifications - - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Connection | GPU Memory (GiB) | Virtualization Type | Hardware | - +================+=======+==============+====================================+===================+=================+==============+==========+================+==================+=====================+===========================================+ - | p2v.2xlarge.8 | 8 | 64 | 10/4 | 50 | 4 | 4 | 1 x V100 | N/A | 1 × 16 GiB | KVM | CPU: Intel® Xeon® Skylake-SP Gold 6151 v5 | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.4xlarge.8 | 16 | 128 | 15/8 | 100 | 8 | 8 | 2 x V100 | NVLink | 2 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.8xlarge.8 | 32 | 256 | 25/15 | 200 | 16 | 8 | 4 x V100 | NVLink | 4 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.16xlarge.8 | 64 | 512 | 30/30 | 400 | 32 | 8 | 8 x V100 | NVLink | 8 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - -.. table:: **Table 15** P2 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+==========+==================+==================+=====================+========================================+ - | p2.2xlarge.8 | 8 | 64 | 5/1.6 | 35 | 2 | 12 | 1 x V100 | 1 x 16 | 1 × 800 GiB NVMe | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | p2.4xlarge.8 | 16 | 128 | 8/3.2 | 70 | 4 | 12 | 2 x V100 | 2 x 16 | 2 × 800 GiB NVMe | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | p2.8xlarge.8 | 32 | 256 | 10/6.5 | 140 | 8 | 12 | 4 x V100 | 4 x 16 | 4 × 800 GiB NVMe | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - -.. table:: **Table 16** P1 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks (GiB) | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+==========+==================+===================+=====================+========================================+ - | p1.2xlarge.8 | 8 | 64 | 5/1.6 | 35 | 2 | 12 | 1 x P100 | 1 x 16 | 1×800 | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | p1.4xlarge.8 | 16 | 128 | 8/3.2 | 70 | 4 | 12 | 2 x P100 | 2 x 16 | 2×800 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | p1.8xlarge.8 | 32 | 256 | 10/6.5 | 140 | 8 | 12 | 4 x P100 | 4 x 16 | 4×800 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - -.. table:: **Table 17** PI2 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks | Virtualization Type | Hardware | - +===============+=======+==============+====================================+===================+=================+==============+========+==================+=============+=====================+==================================================================================+ - | pi2.2xlarge.4 | 8 | 32 | 10/4 | 50 | 4 | 4 | 1 x T4 | 1 × 16 GiB | N/A | KVM | CPU: Intel® Xeon® Skylake 6151 3.0 GHz or Intel® Xeon® Cascade Lake 6278 2.6 GHz | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | pi2.4xlarge.4 | 16 | 64 | 15/8 | 100 | 8 | 8 | 2 x T4 | 2 × 16 GiB | N/A | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | pi2.8xlarge.4 | 32 | 128 | 25/15 | 200 | 16 | 8 | 4 x T4 | 4 × 16 GiB | N/A | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/general-purpose_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/general-purpose_ecss.rst deleted file mode 100644 index 7e2bc25d..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/general-purpose_ecss.rst +++ /dev/null @@ -1,142 +0,0 @@ -:original_name: en-us_topic_0035470101.html - -.. _en-us_topic_0035470101: - -General-Purpose ECSs -==================== - -Overview --------- - -General-purpose ECSs provide a balance of computing, memory, and network resources and a baseline level of vCPU performance with the ability to burst above the baseline. These ECSs are suitable for applications with general workloads, such as web servers, enterprise R&D, and small-scale databases. - -S3 ECSs are suitable for applications that require moderate performance generally but occasionally burstable high performance, such as light-workload web servers, enterprise R&D and testing environments, and low- and medium-performance databases. - -S2 ECSs use Intel® Xeon® Scalable processors, which significantly improve the comprehensive performance. They provide a balance of computing, memory, and network resources and a baseline level of vCPU performance with the ability to burst above the baseline. These ECSs are suitable for many applications. - -Specifications --------------- - -.. table:: **Table 1** S3 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+=====================+=====================================+ - | s3.medium.1 | 1 | 1 | 0.8/0.15 | 10 | 1 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6278 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.1 | 2 | 2 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.1 | 4 | 4 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.1 | 8 | 8 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.1 | 16 | 16 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.1 | 32 | 32 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.2 | 1 | 2 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.2 | 2 | 4 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.2 | 4 | 8 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.2 | 8 | 16 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.2 | 16 | 32 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.2 | 32 | 64 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.4 | 1 | 4 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.4 | 2 | 8 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.4 | 4 | 16 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.4 | 8 | 32 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.4 | 16 | 64 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.4 | 32 | 128 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.medium.8 | 1 | 8 | 0.8/0.15 | 10 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.large.8 | 2 | 16 | 1.5/0.3 | 15 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.xlarge.8 | 4 | 32 | 2/0.5 | 25 | 1 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.2xlarge.8 | 8 | 64 | 3/1 | 50 | 2 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.4xlarge.8 | 16 | 128 | 6/2 | 100 | 4 | 2 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - | s3.8xlarge.8 | 32 | 256 | 8/2 | 200 | 8 | 4 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 2** S2 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+=====================+================================+ - | s2.medium.1 | 1 | 1 | 0.5/0.1 | 5 | 1 | 12 | KVM | CPU: Intel® Xeon® Skylake 6161 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.1 | 2 | 2 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.1 | 4 | 4 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.1 | 8 | 8 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.1 | 16 | 16 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.1 | 32 | 32 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.2 | 1 | 2 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.2 | 2 | 4 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.2 | 4 | 8 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.2 | 8 | 16 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.2 | 16 | 32 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.2 | 32 | 64 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.4 | 1 | 4 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.4 | 2 | 8 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.4 | 4 | 16 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.4 | 8 | 32 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.4 | 16 | 64 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.4 | 32 | 128 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.medium.8 | 1 | 8 | 0.5/0.1 | 5 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.large.8 | 2 | 16 | 0.8/0.2 | 10 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.xlarge.8 | 4 | 32 | 1.5/0.4 | 15 | 1 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.2xlarge.8 | 8 | 64 | 3/0.8 | 20 | 2 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.4xlarge.8 | 16 | 128 | 4/1.5 | 30 | 4 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - | s2.8xlarge.8 | 32 | 256 | 6/3 | 50 | 8 | 12 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+---------------------+--------------------------------+ - -Scenarios ---------- - -- Applications - - General-purpose ECSs are suitable for applications that have no special requirements on CPU performance, memory, disk capacity, or bandwidth, but have high requirements on security and reliability. They feature low initial investment and maintenance costs. - -- Application scenarios - - Enterprise website deployment, enterprise office environment setup, enterprise R&D and testing activities, web servers, R&D and testing environments, and small-scale databases - -Notes ------ - -- General-purpose ECSs support all released OSs. diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/gpu-accelerated_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/gpu-accelerated_ecss.rst deleted file mode 100644 index 8eb1b58b..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/gpu-accelerated_ecss.rst +++ /dev/null @@ -1,492 +0,0 @@ -:original_name: en-us_topic_0097289624.html - -.. _en-us_topic_0097289624: - -GPU-accelerated ECSs -==================== - -GPU-accelerated ECSs provide outstanding floating-point computing capabilities. They are suitable for applications that require real-time, highly concurrent massive computing. - -GPU-accelerated ECSs are classified as G series and P series of ECSs. - -- G series: Graphics-accelerated ECSs, which are suitable for 3D animation rendering and CAD -- P series: Computing-accelerated or inference-accelerated ECSs, which are suitable for deep learning, scientific computing, and CAE - -GPU-accelerated ECS Types -------------------------- - -GPU-accelerated ECSs are classified as graphics-accelerated (G series) and computing-accelerated (P series) ECSs. - -Recommended: - -:ref:`Inference-accelerated PI2 ` - -:ref:`Graphics-accelerated Enhancement G6 ` - -Available now: All GPU models except the recommended ones. - -- G series - - - :ref:`Graphics-accelerated Enhancement G6 ` (recommended) - -- P series - - - :ref:`Computing-accelerated P2s ` (recommended) - - :ref:`Computing-accelerated P2v ` - - :ref:`Computing-accelerated P2 ` - - :ref:`Computing-accelerated P1 ` - - :ref:`Inference-accelerated PI2 ` (recommended) - -Helpful links: - -- :ref:`Installing a GRID Driver on a GPU-accelerated ECS ` -- :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS ` - -.. _en-us_topic_0097289624__section131302034104515: - -Graphics-accelerated Enhancement G6 ------------------------------------ - -**Overview** - -G6 ECSs use NVIDIA Tesla T4 GPUs to support DirectX, OpenGL, and Vulkan and provide 16 GiB of GPU memory. The theoretical Pixel rate is 101.8 Gpixel/s and Texture rate 254.4 GTexel/s, meeting professional graphics processing requirements. - -Select your desired GPU-accelerated ECS type and specifications. - -**Specifications** - -.. table:: **Table 1** G6 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Virtualization Type | Hardware | - +===============+=======+==============+====================================+===================+=================+==============+========+==================+=====================+=====================================+ - | g6.10xlarge.7 | 40 | 280 | 25/15 | 200 | 16 | 8 | 1 x T4 | 16 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - | g6.20xlarge.7 | 80 | 560 | 30/30 | 400 | 32 | 8 | 2 x T4 | 32 | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+---------------------+-------------------------------------+ - -.. note:: - - A G6.10xlarge.7 ECS exclusively uses a T4 GPU for professional graphics acceleration. Such an ECS can be used for heavy-load CPU inference. - -**G6 ECS Features** - -- CPU: 2nd Generation Intel® Xeon® Scalable 6266 processors (3.0 GHz of base frequency and 3.4 GHz of turbo frequency) -- Graphics acceleration APIs - - - DirectX 12, Direct2D, DirectX Video Acceleration (DXVA) - - OpenGL 4.5 - - Vulkan 1.0 - -- CUDA and OpenCL -- NVIDIA T4 GPUs -- Graphics acceleration applications -- Heavy-load CPU inference -- Application flow identical to common ECSs -- Automatic scheduling of G6 ECSs to AZs where NVIDIA T4 GPUs are used -- One built-in NVENC and two NVDEC GPUs - -**Supported Common Software** - -G6 ECSs are used in graphics acceleration scenarios, such as video rendering, cloud desktop, and 3D visualization. If the software relies on GPU DirectX and OpenGL hardware acceleration, use G6 ECSs. G6 ECSs support the following commonly used graphics processing software: - -- AutoCAD -- 3DS MAX -- MAYA -- Agisoft PhotoScan -- ContextCapture - -**Notes** - -- G6 ECSs support the following OS: - - - Windows Server 2016 Standard 64bit - -- G6 ECSs created using a public image have had the GRID driver of a specific version installed by default. However, you need to purchase and configure the GRID license by yourself. Ensure that the GRID driver version meets service requirements. - -- If a G6 ECS is created using a private image, make sure that the GRID driver was installed during the private image creation. If not, install the driver for graphics acceleration after the ECS is created. - -.. _en-us_topic_0097289624__section1454714546567: - -Computing-accelerated P2s -------------------------- - -**Overview** - -P2s ECSs use NVIDIA Tesla V100 GPUs to provide flexibility, high-performance computing, and cost-effectiveness. P2s ECSs provide outstanding general computing capabilities and have strengths in AI-based deep learning, scientific computing, Computational Fluid Dynamics (CFD), computing finance, seismic analysis, molecular modeling, and genomics. - -**Specifications** - -.. table:: **Table 2** P2s ECS specifications - - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Connection | GPU Memory (GiB) | Virtualization Type | Hardware | - +================+=======+==============+====================================+===================+=================+==============+==========+================+==================+=====================+==========================================================+ - | p2s.2xlarge.8 | 8 | 64 | 10/4 | 50 | 4 | 4 | 1 x V100 | PCIe Gen3 | 1 x 32 GiB | KVM | CPU: 2nd Generation Intel® Xeon® Scalable Processor 6278 | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.4xlarge.8 | 16 | 128 | 15/8 | 100 | 8 | 8 | 2 x V100 | PCIe Gen3 | 2 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.8xlarge.8 | 32 | 256 | 25/15 | 200 | 16 | 8 | 4 x V100 | PCIe Gen3 | 4 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - | p2s.16xlarge.8 | 64 | 512 | 30/30 | 400 | 32 | 8 | 8 x V100 | PCIe Gen3 | 8 x 32 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+----------------------------------------------------------+ - -**P2s ECS Features** - -- CPU: 2nd Generation Intel® Xeon® Scalable 6278 processors (2.6 GHz of base frequency and 3.5 GHz of turbo frequency), or Intel® Xeon® Scalable 6151 processors (3.0 GHz of base frequency and 3.4 GHz of turbo frequency) - -- Up to eight NVIDIA Tesla V100 GPUs on an ECS - -- NVIDIA CUDA parallel computing and common deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet - -- 14 TFLOPS of single-precision computing and 7 TFLOPS of double-precision computing - -- NVIDIA Tensor cores with 112 TFLOPS of single- and double-precision computing for deep learning - -- Up to 30 Gbit/s of network bandwidth on a single ECS - -- 32 GiB of HBM2 GPU memory with a bandwidth of 900 Gbit/s - -- Comprehensive basic capabilities - - Networks are user-defined, subnets can be divided, and network access policies can be configured as needed. Mass storage is used, elastic capacity expansion as well as backup and restoration are supported to make data more secure. Auto Scaling allows you to add or reduce the number of ECSs quickly. - -- Flexibility - - Similar to other types of ECSs, P2s ECSs can be provisioned in a few minutes. - -- Excellent supercomputing ecosystem - - The supercomputing ecosystem allows you to build up a flexible, high-performance, cost-effective computing platform. A large number of HPC applications and deep-learning frameworks can run on P2s ECSs. - -**Supported Common Software** - -P2s ECSs are used in computing acceleration scenarios, such as deep learning training, inference, scientific computing, molecular modeling, and seismic analysis. If the software is required to support GPU CUDA, use P2s ECSs. P2s ECSs support the following commonly used software: - -- Common deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet -- CUDA GPU rendering supported by RedShift for Autodesk 3dsMax and V-Ray for 3ds Max -- Agisoft PhotoScan -- MapD - -**Notes** - -- P2s ECSs support the following OSs: - - - Windows Server 2019 Standard 64bit - - Windows Server 2016 Standard 64bit - - Windows Server 2012 R2 Standard 64bit - - Ubuntu Server 20.04 64bit - - Ubuntu Server 18.04 64bit - - Ubuntu Server 16.04 64bit - - CentOS 7.7 64bit - - CentOS 7.4 64bit - - EulerOS 2.5 64bit - - Oracle Linux 7.6 64bit - -- By default, P2s ECSs created using a Windows public image have the Tesla driver installed. -- If a P2s ECS is created using a private image, make sure that the Tesla driver was installed during the private image creation. If not, install the driver for computing acceleration after the ECS is created. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -.. _en-us_topic_0097289624__section208472383415: - -Computing-accelerated P2v -------------------------- - -**Overview** - -Compared with P2 ECSs, P2v ECSs use NVIDIA Tesla V100 GPUs to provide flexibility, high-performance computing, and cost-effectiveness. These ECSs use GPU NVLink for direct communication between GPUs, improving data transmission efficiency. P2v ECSs provide outstanding general computing capabilities and have strengths in AI-based deep learning, scientific computing, Computational Fluid Dynamics (CFD), computing finance, seismic analysis, molecular modeling, and genomics. - -**Specifications** - -.. table:: **Table 3** P2v ECS specifications - - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Connection | GPU Memory (GiB) | Virtualization Type | Hardware | - +================+=======+==============+====================================+===================+=================+==============+==========+================+==================+=====================+===========================================+ - | p2v.2xlarge.8 | 8 | 64 | 10/4 | 50 | 4 | 4 | 1 x V100 | N/A | 1 × 16 GiB | KVM | CPU: Intel® Xeon® Skylake-SP Gold 6151 v5 | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.4xlarge.8 | 16 | 128 | 15/8 | 100 | 8 | 8 | 2 x V100 | NVLink | 2 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.8xlarge.8 | 32 | 256 | 25/15 | 200 | 16 | 8 | 4 x V100 | NVLink | 4 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - | p2v.16xlarge.8 | 64 | 512 | 30/30 | 400 | 32 | 8 | 8 x V100 | NVLink | 8 × 16 GiB | KVM | | - +----------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+----------------+------------------+---------------------+-------------------------------------------+ - -**P2v ECS Features** - -- CPU: Intel® Xeon® Scalable 6151 processors (3.0 GHz of base frequency and 3.4 GHz of turbo frequency) - -- Up to eight NVIDIA Tesla V100 GPUs on an ECS - -- NVIDIA CUDA parallel computing and common deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet - -- 15.7 TFLOPS of single-precision computing and 7.8 TFLOPS of double-precision computing - -- NVIDIA Tensor cores with 125 TFLOPS of single- and double-precision computing for deep learning - -- Up to 30 Gbit/s of network bandwidth on a single ECS - -- 16 GiB of HBM2 GPU memory with a bandwidth of 900 Gbit/s - -- Comprehensive basic capabilities - - Networks are user-defined, subnets can be divided, and network access policies can be configured as needed. Mass storage is used, elastic capacity expansion as well as backup and restoration are supported to make data more secure. Auto Scaling allows you to add or reduce the number of ECSs quickly. - -- Flexibility - - Similar to other types of ECSs, P2v ECSs can be provisioned in a few minutes. - -- Excellent supercomputing ecosystem - - The supercomputing ecosystem allows you to build up a flexible, high-performance, cost-effective computing platform. A large number of HPC applications and deep-learning frameworks can run on P2v ECSs. - -**Supported Common Software** - -P2v ECSs are used in computing acceleration scenarios, such as deep learning training, inference, scientific computing, molecular modeling, and seismic analysis. If the software is required to support GPU CUDA, use P2v ECSs. P2v ECSs support the following commonly used software: - -- Common deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet -- CUDA GPU rendering supported by RedShift for Autodesk 3dsMax and V-Ray for 3ds Max -- Agisoft PhotoScan -- MapD - -**Notes** - -- P2v ECSs support the following OSs: - - - Windows Server 2019 Standard 64bit - - Windows Server 2016 Standard 64bit - - Windows Server 2012 R2 Standard 64bit - - Ubuntu Server 16.04 64bit - - CentOS 7.7 64bit - - EulerOS 2.5 64bit - - Oracle Linux 7.6 64bit - -- By default, P2v ECSs created using a Windows public image have the Tesla driver installed. -- By default, P2v ECSs created using a Linux public image do not have a Tesla driver installed. After the ECS is created, install a driver on it for computing acceleration. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. -- If a P2v ECS is created using a private image, make sure that the Tesla driver was installed during the private image creation. If not, install the driver for computing acceleration after the ECS is created. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -.. _en-us_topic_0097289624__section5477185118234: - -Computing-accelerated P2 ------------------------- - -**Overview** - -Compared with P1 ECSs, P2 ECSs use NVIDIA Tesla V100 GPUs, which have improved both single- and double-precision computing capabilities by 50% and offer 112 TFLOPS of deep learning. - -**Specifications** - -.. table:: **Table 4** P2 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+==========+==================+==================+=====================+========================================+ - | p2.2xlarge.8 | 8 | 64 | 5/1.6 | 35 | 2 | 12 | 1 x V100 | 1 x 16 | 1 × 800 GiB NVMe | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | p2.4xlarge.8 | 16 | 128 | 8/3.2 | 70 | 4 | 12 | 2 x V100 | 2 x 16 | 2 × 800 GiB NVMe | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - | p2.8xlarge.8 | 32 | 256 | 10/6.5 | 140 | 8 | 12 | 4 x V100 | 4 x 16 | 4 × 800 GiB NVMe | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+------------------+---------------------+----------------------------------------+ - -**P2 ECS Features** - -- CPU: Intel® Xeon® Processor E5-2690 v4 (2.6 GHz) - -- NVIDIA Tesla V100 GPUs - -- GPU hardware passthrough - -- 14 TFLOPS of single-precision computing, 7 TFLOPS of double-precision computing, and 112 TFLOPS of deep learning - -- Maximum network bandwidth of 12 Gbit/s - -- 16 GiB of HBM2 GPU memory with a bandwidth of 900 Gbit/s - -- 800 GiB NVMe SSDs for temporary local storage - -- Comprehensive basic capabilities - - Networks are user-defined, subnets can be divided, and network access policies can be configured as needed. Mass storage is used, elastic capacity expansion as well as backup and restoration are supported to make data more secure. Auto Scaling allows you to add or reduce the number of ECSs quickly. - -- Flexibility - - Similar to other types of ECSs, P2 ECSs can be provisioned in a few minutes. - -- Excellent supercomputing ecosystem - - The supercomputing ecosystem allows you to build up a flexible, high-performance, cost-effective computing platform. A large number of HPC applications and deep-learning frameworks can run on P2 ECSs. - -**Supported Common Software** - -P2 ECSs are used in computing acceleration scenarios, such as deep learning training, inference, scientific computing, molecular modeling, and seismic analysis. If the software requires GPU CUDA parallel computing, use P2 ECSs. P2 ECSs support the following commonly used software: - -- Common deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet -- CUDA GPU rendering supported by RedShift for Autodesk 3dsMax and V-Ray for 3ds Max -- Agisoft PhotoScan -- MapD - -**Notes** - -- The system disk of a P2 ECS must be greater than or equal to 15 GiB. It is recommended that the system disk be greater than 40 GiB. - -- The local NVMe SSDs attached to P2 ECSs are dedicated for services with strict requirements on storage I/O performance, such as deep learning training and HPC. Local disks are attached to the ECSs of specified flavors and cannot be separately bought. In addition, you are not allowed to detach a local disk and then attach it to another ECS. - - .. note:: - - Data may be lost on the local NVMe SSDs attached to P2 ECSs due to, for example, a disk or host fault. Therefore, you are suggested to store only temporary data in local NVMe SSDs. If you store important data in such a disk, securely back up the data. - -- P2 ECSs do not support specifications modification. - -- P2 ECSs support the following OSs: - - Ubuntu Server 16.04 64bit - -- After you delete a P2 ECS, the data stored in local NVMe SSDs is automatically cleared. - -- By default, P2 ECSs created using a Linux public image do not have a Tesla driver installed. After the ECS is created, install a driver on it for computing acceleration. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -- If a P2 ECS is created using a private image, make sure that the Tesla driver was installed during the private image creation. If not, install the driver for computing acceleration after the ECS is created. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -.. _en-us_topic_0097289624__section1124594913391: - -Computing-accelerated P1 ------------------------- - -**Overview** - -P1 ECSs use NVIDIA Tesla P100 GPUs and provide flexibility, high performance, and cost-effectiveness. These ECSs support GPU Direct for direct communication between GPUs, improving data transmission efficiency. P1 ECSs provide outstanding general computing capabilities and have strengths in deep learning, graphic databases, high-performance databases, Computational Fluid Dynamics (CFD), computing finance, seismic analysis, molecular modeling, and genomics. They are designed for scientific computing. - -**Specifications** - -.. table:: **Table 5** P1 ECS specifications - - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks (GiB) | Virtualization Type | Hardware | - +==============+=======+==============+====================================+===================+=================+==============+==========+==================+===================+=====================+========================================+ - | p1.2xlarge.8 | 8 | 64 | 5/1.6 | 35 | 2 | 12 | 1 x P100 | 1 x 16 | 1×800 | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | p1.4xlarge.8 | 16 | 128 | 8/3.2 | 70 | 4 | 12 | 2 x P100 | 2 x 16 | 2×800 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - | p1.8xlarge.8 | 32 | 256 | 10/6.5 | 140 | 8 | 12 | 4 x P100 | 4 x 16 | 4×800 | KVM | | - +--------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+----------+------------------+-------------------+---------------------+----------------------------------------+ - -**P1 ECS Features** - -- CPU: Intel® Xeon® Processor E5-2690 v4 (2.6 GHz) - -- Up to four NVIDIA Tesla P100 GPUs on a P1 ECS (If eight P100 GPUs are required on an instance, use BMS.) - -- GPU hardware passthrough - -- 9.3 TFLOPS of single-precision computing and 4.7 TFLOPS of double-precision computing - -- Maximum network bandwidth of 10 Gbit/s - -- 16 GiB of HBM2 GPU memory with a bandwidth of 732 Gbit/s - -- 800 GiB NVMe SSDs for temporary local storage - -- Comprehensive basic capabilities - - Networks are user-defined, subnets can be divided, and network access policies can be configured as needed. Mass storage is used, elastic capacity expansion as well as backup and restoration are supported to make data more secure. Auto Scaling allows you to add or reduce the number of ECSs quickly. - -- Flexibility - - Similar to other types of ECSs, P1 ECSs can be provisioned in a few minutes. You can configure specifications as needed. P1 ECSs with two, four, and eight GPUs will be supported later. - -- Excellent supercomputing ecosystem - - The supercomputing ecosystem allows you to build up a flexible, high-performance, cost-effective computing platform. A large number of HPC applications and deep-learning frameworks can run on P1 ECSs. - -**Supported Common Software** - -P1 ECSs are used in computing acceleration scenarios, such as deep learning training, inference, scientific computing, molecular modeling, and seismic analysis. If the software requires GPU CUDA parallel computing, use P1 ECSs. P1 ECSs support the following commonly used software: - -- Deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet -- RedShift for Autodesk 3dsMax, V-Ray for 3ds Max -- Agisoft PhotoScan -- MapD - -**Notes** - -- It is recommended that the system disk of a P1 ECS be greater than 40 GiB. -- The local NVMe SSDs attached to P1 ECSs are dedicated for services with strict requirements on storage I/O performance, such as deep learning training and HPC. Local disks are attached to the ECSs of specified flavors and cannot be separately bought. In addition, you are not allowed to detach a local disk and then attach it to another ECS. - - .. note:: - - Data may be lost on the local NVMe SSDs attached to P1 ECSs due to a fault, for example, due to a disk or host fault. Therefore, you are suggested to store only temporary data in local NVMe SSDs. If you store important data in such a disk, securely back up the data. - -- After a P1 ECS is created, you must install the NVIDIA driver for computing acceleration. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. -- P1 ECSs do not support specifications modification. -- P1 ECSs support the following OSs: - - - Windows Server 2012 R2 Standard 64bit - - Ubuntu Server 16.04 64bit - - CentOS 7.4 64bit - - Debian 9.0 64bit - -- After you delete a P1 ECS, the data stored in local NVMe SSDs is automatically cleared. -- By default, P1 ECSs created using a Windows public image have the Tesla driver installed. -- By default, P1 ECSs created using a Linux public image do not have a Tesla driver installed. After the ECS is created, install a driver on it for computing acceleration. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. -- If a P1 ECS is created using a private image, make sure that the Tesla driver was installed during the private image creation. If not, install the driver for computing acceleration after the ECS is created. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. - -.. _en-us_topic_0097289624__section1846114713182: - -Inference-accelerated PI2 -------------------------- - -**Overview** - -PI2 ECSs use NVIDIA Tesla T4 GPUs dedicated for real-time AI inference. These ECSs use the T4 INT8 calculator for up to 130 TOPS of INT8 computing. The PI2 ECSs can also be used for light-load training. - -**Specifications** - -.. table:: **Table 6** PI2 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Maximum NICs | GPUs | GPU Memory (GiB) | Local Disks | Virtualization Type | Hardware | - +===============+=======+==============+====================================+===================+=================+==============+========+==================+=============+=====================+==================================================================================+ - | pi2.2xlarge.4 | 8 | 32 | 10/4 | 50 | 4 | 4 | 1 x T4 | 1 × 16 GiB | N/A | KVM | CPU: Intel® Xeon® Skylake 6151 3.0 GHz or Intel® Xeon® Cascade Lake 6278 2.6 GHz | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | pi2.4xlarge.4 | 16 | 64 | 15/8 | 100 | 8 | 8 | 2 x T4 | 2 × 16 GiB | N/A | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - | pi2.8xlarge.4 | 32 | 128 | 25/15 | 200 | 16 | 8 | 4 x T4 | 4 × 16 GiB | N/A | KVM | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+--------------+--------+------------------+-------------+---------------------+----------------------------------------------------------------------------------+ - -**PI2 ECS Features** - -- CPU: 2nd Generation Intel® Xeon® Scalable 6278 processors (2.6 GHz of base frequency and 3.5 GHz of turbo frequency), or Intel® Xeon® Scalable 6151 processors (3.0 GHz of base frequency and 3.4 GHz of turbo frequency) -- Up to four NVIDIA Tesla T4 GPUs on an ECS -- GPU hardware passthrough -- Up to 8.1 TFLOPS of single-precision computing on a single GPU -- Up to 130 TOPS of INT8 computing on a single GPU -- 16 GiB of GDDR6 GPU memory with a bandwidth of 320 GiB/s on a single GPU -- One built-in NVENC and two NVDEC GPUs - -**Supported Common Software** - -PI2 ECSs are used in GPU-based inference computing scenarios, such as image recognition, speech recognition, and natural language processing. The PI2 ECSs can also be used for light-load training. - -PI2 ECSs support the following commonly used software: - -- Deep learning frameworks, such as TensorFlow, Caffe, PyTorch, and MXNet - -**Notes** - -- After a PI2 ECS is stopped, basic resources including vCPUs, memory, and images are not billed, but its system disk is billed based on the disk capacity. If other products, such as EVS disks, EIP, and bandwidth are associated with the ECS, these products are billed separately. - - .. note:: - - Resources are released after a PI2 ECS is stopped. If desired resources are insufficient when the PI2 ECS is started after being stopped, starting the ECS might fail. Therefore, if you need to use a PI2 ECS for a long time, keep the ECS running. - -- PI2 ECSs support the following OSs: - - - Windows Server 2019 Standard 64bit - - Windows Server 2016 Standard 64bit - - Windows Server 2012 R2 Standard 64bit - - Ubuntu Server 16.04 64bit - - CentOS 7.8 64bit - -- PI2 ECSs support automatic recovery when the hosts accommodating such ECSs become faulty. -- By default, PI2 ECSs created using a Windows public image have the Tesla driver installed. -- By default, PI2 ECSs created using a Linux public image do not have a Tesla driver installed. After the ECS is created, install a driver on it for computing acceleration. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. -- If a PI2 ECS is created using a private image, make sure that the Tesla driver was installed during the private image creation. If not, install the driver for computing acceleration after the ECS is created. For details, see :ref:`Installing a Tesla Driver and CUDA Toolkit on a GPU-accelerated ECS `. diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/high-performance_computing_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/high-performance_computing_ecss.rst deleted file mode 100644 index 2f47f822..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/high-performance_computing_ecss.rst +++ /dev/null @@ -1,155 +0,0 @@ -:original_name: en-us_topic_0035470100.html - -.. _en-us_topic_0035470100: - -High-Performance Computing ECSs -=============================== - -Overview --------- - -H2 ECSs are designed to meet high-end computational needs, such as molecular modeling and computational fluid dynamics. In addition to the substantial CPU power, the H2 ECSs offer diverse options for low-latency RDMA networking using EDR InfiniBand NICs to support memory-intensive computational requirements. - -HL1 ECSs are the second generation of high-computing ECSs, featuring large memory capacity. They are interconnected with each other using 100 Gbit/s RDMA InfiniBand NICs and support 56 Gbit/s shared high I/O storage. - -Specifications --------------- - -.. table:: **Table 1** H2 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Virtualization Type | Local Disks | Capacity of One Local Disk (TB) | Network Type | Hardware | - +===============+=======+==============+====================================+===================+=================+=====================+=============+=================================+===========================+==============================+ - | h2.3xlarge.10 | 16 | 128 | 13/13 | 90 | 8 | KVM | 1 | 3.2 | 100 Gbit/s EDR InfiniBand | CPU: Intel® Xeon® E5-2667 v4 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - | h2.3xlarge.20 | 16 | 256 | 13/13 | 90 | 8 | KVM | 1 | 3.2 | 100 Gbit/s EDR InfiniBand | | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+-------------+---------------------------------+---------------------------+------------------------------+ - -.. table:: **Table 2** HL1 ECS specifications - - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+---------------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Max. PPS (10,000) | NIC Multi-Queue | Virtualization Type | Network Type | Hardware | - +===============+=======+==============+====================================+===================+=================+=====================+===========================+========================================+ - | hl1.8xlarge.8 | 32 | 256 | 9/9 | 90 | 8 | KVM | 100 Gbit/s EDR InfiniBand | CPU: Intel® Xeon® Processor E5-2690 v4 | - +---------------+-------+--------------+------------------------------------+-------------------+-----------------+---------------------+---------------------------+----------------------------------------+ - -Scenarios ---------- - -- Applications - - H2 and HL1: High-performance computing (HPC), big data, and Artificial Intelligence (AI) - -- Application scenarios - - H2 and HL1 - - - High-performance hardware: The ratio of memory to vCPU is 8:1, and a large number of multi-thread physical CPUs are available to provide high-performance storage I/O and high-throughput network connections. - - Designed for HPC clusters: Multiple HL1 ECSs can be clustered to install scalable, clustered file system, such as Lustre. HPC applications running on H2 ECSs can read and modify the data stored in the ECSs. - - RDMA network connection: Same as H2 ECSs, HL1 ECSs also offer RDMA network using EDR 100 Gbit/s InfiniBand NICs. HL1 ECSs can communicate with H2 ECSs with RDMA protocol. In addition, HL1 ECSs can access EVS disks over the RDMA protocol, which allows up to 56 Gbit/s storage bandwidth. - -- Application scenarios - - H2 and HL1 ECSs provide computing capabilities for clusters with a large memory, good connectivity between nodes, and high storage I/O. The typical application scenarios include HPC, big data, and AI. In HPC solution, HL1 ECSs are perfectly suited for the Lustre parallel distributed file system, generally used for large-scale cluster computing. - - For example, in HPC scenario, H2 ECSs can be used as compute nodes, and HL1 ECSs can be used as storage nodes. - -Features --------- - -High-performance computing ECSs have the following features: - -- Large memory capacity and more processor cores than other types of ECSs - -- Up to 32 vCPUs - -- H2 and HL1 ECSs use InfiniBand NICs that provide a bandwidth of 100 Gbit/s. - -- HL1 ECSs can use the following types of EVS disks as system disk and data disk: - - High I/O (performance-optimized I) - - Ultra-high I/O (latency-optimized) - -- HL1 ECSs support 56 Gbit/s shared high I/O storage. - - To support 56 Gbit/s shared high I/O storage, you only need to attach high I/O (performance-optimized I) or ultra-high I/O (latency-optimized) EVS disks to target HL1 ECSs. - -Notes on Using H2 ECSs ----------------------- - -- H2 ECSs do not support OS reinstallation or change. -- H2 ECSs do not support specifications modification. -- H2 ECSs do not support cold migration, live migration, or HA. -- H2 ECSs support the following OSs: - - - For public images: - - - CentOS 7.3 64bit - - SUSE Linux Enterprise Server 11 SP4 64bit - - SUSE Linux Enterprise Server 12 SP2 64bit - - - For private images: - - - CentOS 6.5 64bit - - CentOS 7.2 64bit - - CentOS 7.3 64bit - - SUSE Linux Enterprise Server 11 SP4 64bit - - SUSE Linux Enterprise Server 12 SP2 64bit - - Red Hat Enterprise Linux 7.2 64bit - - Red Hat Enterprise Linux 7.3 64bit - -- H2 ECSs use InfiniBand NICs that provide a bandwidth of 100 Gbit/s. -- Each H2 ECS uses one PCIe 3.2 TB SSD card for temporary local storage. -- If an H2 ECS is created using a private image, install an InfiniBand NIC driver on the ECS after the ECS creation following the instructions provided by Mellanox. Download the required version (4.2-1.0.0.0) of InfiniBand NIC driver from the official Mellanox website and install the driver by following the instructions provided by Mellanox. - - - InfiniBand NIC type: **Mellanox Technologies ConnectX-4 Infiniband HBA (MCX455A-ECAT)** - - Mellanox official website: http://www.mellanox.com/ - - NIC driver download path: http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux_sw_drivers - -- For SUSE H2 ECSs, if IP over InfiniBand (IPoIB) is required, you must manually configure an IP address for the InfiniBand NIC after installing the InfiniBand driver. For details, see :ref:`How Can I Manually Configure an IP Address for an InfiniBand NIC? ` -- After you delete an H2 ECS, the data stored in SSDs is automatically cleared. Therefore, do not store persistence data into SSDs during ECS running. - -Notes on Using HL1 ECSs ------------------------ - -- HL1 ECSs only support the attachment of high I/O (performance-optimized I) and ultra-high I/O (latency-optimized) EVS disks. - - To support 56 Gbit/s shared high I/O storage, you only need to attach high I/O (performance-optimized I) or ultra-high I/O (latency-optimized) EVS disks to target HL1 ECSs. - -- HL1 ECSs do not support specifications modification. - -- HL1 ECSs use InfiniBand NICs that provide a bandwidth of 100 Gbit/s. - -- HL1 ECSs created using a private image must have the InfiniBand NIC driver installed. Download the required version (4.2-1.0.0.0) of InfiniBand NIC driver from the official Mellanox website and install the driver by following the instructions provided by Mellanox. - - - InfiniBand NIC type: **Mellanox Technologies ConnectX-4 Infiniband HBA (MCX455A-ECAT)** - - Mellanox official website: http://www.mellanox.com/ - -- For SUSE HL1 ECSs, if IPoIB is required, you must manually configure an IP address for the InfiniBand NIC after installing the InfiniBand driver. For details, see :ref:`How Can I Manually Configure an IP Address for an InfiniBand NIC? ` - -- HL1 ECSs support the following OSs: - - - For public images: - - - CentOS 7.3 64bit - - SUSE Linux Enterprise Server 11 SP4 64bit - - SUSE Linux Enterprise Server 12 SP2 64bit - - - For private images: - - - CentOS 6.5 64bit - - CentOS 7.2 64bit - - CentOS 7.3 64bit - - SUSE Linux Enterprise Server 11 SP4 64bit - - SUSE Linux Enterprise Server 12 SP2 64bit - - Red Hat Enterprise Linux 7.2 64bit - - Red Hat Enterprise Linux 7.3 64bit - -- Charging an HL1 ECS is stopped when it is stopped. - -Related Links -------------- - -- :ref:`Enabling NIC Multi-Queue ` -- :ref:`How Can I Check Whether the Network Communication Is Normal Between Two ECSs Equipped with an InfiniBand NIC Driver? ` diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/index.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/index.rst deleted file mode 100644 index 06a3434a..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _en-us_topic_0132345719: - -============================ -ECS Specifications and Types -============================ - -.. toctree:: - :maxdepth: 1 - - ecs_specifications - general-purpose_ecss - dedicated_general-purpose_ecss - memory-optimized_ecss - large-memory_ecss - disk-intensive_ecss - high-performance_computing_ecss - gpu-accelerated_ecss diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/large-memory_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/large-memory_ecss.rst deleted file mode 100644 index 6dd0e345..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/large-memory_ecss.rst +++ /dev/null @@ -1,72 +0,0 @@ -:original_name: en-us_topic_0038024694.html - -.. _en-us_topic_0038024694: - -Large-Memory ECSs -================= - -Overview --------- - -Large-memory ECSs provide an even larger amount of memory than memory-optimized ECSs. They are used for applications that require a large amount of memory, rapid data switching, low latency, and process large volumes of data. Large-memory ECSs provide large memory and high computing, storage, and network performance. - -- Applications - - Large-memory ECSs are suitable for applications that require a large amount of memory, rapid data switching, and low latency, and process large volumes of data. - -- Application scenarios - - E3 ECSs: OLAP and OLTP applications with hyper-threading enabled - -Specifications --------------- - -.. table:: **Table 1** E3 ECS specifications - - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Hardware | - +================+=======+==============+====================================+======================+=================+=====================+================================+ - | e3.7xlarge.12 | 28 | 348 | 25/12 | 280 | 8 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - | e3.14xlarge.12 | 56 | 696 | 25/25 | 500 | 16 | KVM | | - +----------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+--------------------------------+ - -Notes ------ - -- Large-memory ECSs do not support NIC hot swapping. - -- E3 ECSs support the following OSs that have been verified: - - SUSE Enterprise Linux Server 12 SP2 64bit - - SUSE Enterprise Linux Server 12 SP3 64bit - -- E3 ECSs can use ultra-high I/O EVS disks as the system disk and data disks. - -- The primary and extension NICs of a large-memory ECS have specified application scenarios. For details, see :ref:`Table 2 `. - - .. _en-us_topic_0038024694__table1642803151326: - - .. table:: **Table 2** Application scenarios of the NICs of a large-memory ECS - - +---------------+----------------------------------+--------------------------------------------------------------------------------------+ - | NIC Type | Application Scenario | Remarks | - +===============+==================================+======================================================================================+ - | Primary NIC | Vertical layer 3 communication | N/A | - +---------------+----------------------------------+--------------------------------------------------------------------------------------+ - | Extension NIC | Horizontal layer 2 communication | To improve network performance, you can set the MTU of an extension NIC to **8888**. | - +---------------+----------------------------------+--------------------------------------------------------------------------------------+ - -- An ECS can have a maximum of 60 attached disks, including the system disk. For details about constraints, see :ref:`Can I Attach Multiple Disks to an ECS? ` - - An example is provided as follows: - - An E3 ECS is to be created. It can have a maximum of 60 attached disks, where: - - - The number of system disks is 1. - - The number of EVS disks is at most 59. - - .. note:: - - The maximum number of disks attached to an existing large-memory ECS remains unchanged. To attach 60 disks, enable advanced disk. For details, see :ref:`Enabling Advanced Disk `. diff --git a/ecs/umn/result/service_overview/ecs_specifications_and_types/memory-optimized_ecss.rst b/ecs/umn/result/service_overview/ecs_specifications_and_types/memory-optimized_ecss.rst deleted file mode 100644 index 4d30adb2..00000000 --- a/ecs/umn/result/service_overview/ecs_specifications_and_types/memory-optimized_ecss.rst +++ /dev/null @@ -1,74 +0,0 @@ -:original_name: en-us_topic_0035550301.html - -.. _en-us_topic_0035550301: - -Memory-optimized ECSs -===================== - -Overview --------- - -- M4 ECSs use second-generation Intel® Xeon® Scalable processors with technologies optimized to offer powerful and stable computing performance. Using 25GE high-speed intelligent NICs, M4 ECSs provide a maximum memory size of 512 GiB based on DDR4 for memory-intensive applications with high requirements on network bandwidth and Packets Per Second (PPS). -- M3 ECSs are developed based on the KVM virtualization platform and designed for processing large-scale data sets in the memory. They use Intel® Xeon® Scalable processors, network acceleration engines, and DPDK rapid packet processing mechanism to provide higher network performance and up to 512 GiB of DDR4 memory for memory-intensive computing applications. -- M2 ECSs use Intel Xeon E5-2690 v4 CPUs and are designed for memory-optimized applications. - -Specifications --------------- - -.. table:: **Table 1** M4 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+=====================================+ - | m4.large.8 | 2 | 16 | 4/1.2 | 40 | 2 | 2 | KVM | CPU: Intel® Xeon® Cascade Lake 6266 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.xlarge.8 | 4 | 32 | 8/2.4 | 80 | 2 | 3 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.2xlarge.8 | 8 | 64 | 15/4.5 | 150 | 4 | 4 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.3xlarge.8 | 12 | 96 | 17/7 | 200 | 4 | 6 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.4xlarge.8 | 16 | 128 | 20/9 | 280 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.6xlarge.8 | 24 | 192 | 25/14 | 400 | 8 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.8xlarge.8 | 32 | 256 | 30/18 | 550 | 16 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - | m4.16xlarge.8 | 64 | 512 | 40/36 | 1000 | 32 | 8 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+-------------------------------------+ - -.. table:: **Table 2** M3 ECS specifications - - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Maximum NICs | Virtualization Type | Hardware | - +===============+=======+==============+====================================+======================+=================+==============+=====================+================================+ - | m3.large.8 | 2 | 16 | 1.5/0.6 | 30 | 2 | 12 | KVM | CPU: Intel® Xeon® Skylake 6151 | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.xlarge.8 | 4 | 32 | 3/1.1 | 50 | 2 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.2xlarge.8 | 8 | 64 | 5/2 | 90 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.4xlarge.8 | 16 | 128 | 10/4.5 | 130 | 4 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.8xlarge.8 | 32 | 256 | 15/9 | 260 | 8 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - | m3.15xlarge.8 | 60 | 512 | 17/17 | 500 | 16 | 12 | KVM | | - +---------------+-------+--------------+------------------------------------+----------------------+-----------------+--------------+---------------------+--------------------------------+ - -.. table:: **Table 3** M2 ECS specifications - - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - | Flavor | vCPUs | Memory (GiB) | Maximum/Assured Bandwidth (Gbit/s) | Maximum PPS (10,000) | NIC Multi-Queue | Virtualization Type | Hardware | - +==============+=======+==============+====================================+======================+=================+=====================+========================================+ - | m2.4xlarge.8 | 16 | 128 | 8/5 | 40 | 4 | KVM | CPU: Intel® Xeon® Processor E5-2690 v4 | - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - | m2.8xlarge.8 | 32 | 256 | 13/8 | 60 | 8 | KVM | | - +--------------+-------+--------------+------------------------------------+----------------------+-----------------+---------------------+----------------------------------------+ - -Scenarios ---------- - -- High-performance relational (MySQL) and NoSQL (MongoDB and Cassandra) databases -- Distributed web scale cache stores that provide in-memory caching of key-value type data (Memcached and Redis) -- Applications processing big unstructured data in real time (financial services, Hadoop/Spark clusters) -- High-performance computing (HPC) and electronic design automation (EDA) diff --git a/ecs/umn/result/service_overview/evs_disks.rst b/ecs/umn/result/service_overview/evs_disks.rst deleted file mode 100644 index 25b24d49..00000000 --- a/ecs/umn/result/service_overview/evs_disks.rst +++ /dev/null @@ -1,40 +0,0 @@ -:original_name: en-us_topic_0030828256.html - -.. _en-us_topic_0030828256: - -EVS Disks -========= - -What Is Elastic Volume Service? -------------------------------- - -Elastic Volume Service (EVS) offers scalable block storage for ECSs. With high reliability, high performance, and rich specifications, EVS disks can be used for distributed file systems, development and test environments, data warehouse applications, and high-performance computing (HPC) scenarios to meet diverse service requirements. - -Disk Types ----------- - -EVS disk types differ in performance. Choose the disk type based on your requirements. - -For more information about EVS disk specifications and performance, see *Elastic Volume Service User Guide*. - -Device Types ------------- - -EVS disks have two device types, Virtual Block Device (VBD) and Small Computer System Interface (SCSI). - -- VBD - - When you create an EVS disk on the management console, **Device Type** of the EVS disk is VBD by default. VBD EVS disks support only simple SCSI read/write commands. - -- SCSI - - You can create EVS disks whose **Device Type** is SCSI on the management console. These EVS disks support transparent SCSI command transmission, allowing ECS OS to directly access underlying storage media. SCSI EVS disks support both basic and advanced SCSI commands. - - .. note:: - - For more information about how to use SCSI EVS disks, for example, how to install the driver, see "Device Types and Usage Instructions" in *Elastic Volume Service User Guide*. - -Helpful Links -------------- - -- :ref:`Which ECSs Can Be Attached with SCSI EVS Disks? ` diff --git a/ecs/umn/result/service_overview/images.rst b/ecs/umn/result/service_overview/images.rst deleted file mode 100644 index b36fcb31..00000000 --- a/ecs/umn/result/service_overview/images.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: en-us_topic_0030828254.html - -.. _en-us_topic_0030828254: - -Images -====== - -What Is Image? --------------- - -An image is an ECS template that contains an OS and may also contain proprietary software and application software, such as database software. You can use images to create ECSs. - -Images can be public or private. Public images are provided by the system by default, and private images are manually created. You can use any type of image to create an ECS. You can also create a private image using an existing ECS or external image. This provides you with a simple and fast way to create ECSs tailored to your needs. For example, if you use web services, your image can contain web server configurations, static configurations, and dynamic page code. After you use this image to create an ECS, the web server will run on the newly created ECS. - -Image Types ------------ - -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Image Type | Description | -+===================================+=====================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| Public image | A public image is a standard, widely used image. It contains an OS and preinstalled public applications and is available to all users. Public images are very stable and their OS and any included software have been officially authorized for use. If a public image does not contain the application environments or software you need, you can use a public image to create an ECS and then deploy required software as needed. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Private image | A private image contains an OS or service data, preinstalled public applications, and a user's personal applications. Private images are only available to the users who created them. | -| | | -| | A private image can be a system disk image, data disk image, or full-ECS image. | -| | | -| | - A system disk image contains an OS and pre-installed software for various services. You can use a system disk image to create ECSs and migrate your services to the cloud. | -| | - A data disk image contains only service data. You can use a data disk image to create EVS disks and use them to migrate your service data to the cloud. | -| | - A full-ECS image contains an OS, pre-installed software, and service data. A full-ECS image is created using differential backups and the creation takes less time than creating a system or data disk image of the same size. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Shared image | A shared image is a private image another user has shared with you. | -+-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/service_overview/index.rst b/ecs/umn/result/service_overview/index.rst deleted file mode 100644 index 0d4ea60f..00000000 --- a/ecs/umn/result/service_overview/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _en-us_topic_0092494580: - -================ -Service Overview -================ - -.. toctree:: - :maxdepth: 1 - - what_is_ecs - instances/index - ecs_specifications_and_types/index - images - evs_disks - cbr - network - security/index - user_permissions - region_and_az - ecs_and_other_services diff --git a/ecs/umn/result/service_overview/instances/ecs_lifecycle.rst b/ecs/umn/result/service_overview/instances/ecs_lifecycle.rst deleted file mode 100644 index 53a5e7c0..00000000 --- a/ecs/umn/result/service_overview/instances/ecs_lifecycle.rst +++ /dev/null @@ -1,50 +0,0 @@ -:original_name: en-us_topic_0140323150.html - -.. _en-us_topic_0140323150: - -ECS Lifecycle -============= - -The ECS lifecycle refers to the entire journey an ECS goes through, from creation to deletion (or release). - -.. table:: **Table 1** ECS statuses - - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Status | Status Attribute | Description | - +========================+=======================+=========================================================================================================================================+ - | Creating | Intermediate | The ECS is being created but has not been running. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Starting | Intermediate | The ECS is between the **Stopped** and **Running** states. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Running | Stable | The ECS is running properly. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Stopping | Intermediate | The ECS is between the **Running** and **Stopped** states. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Stopped | Stable | The ECS has been properly stopped. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Restarting | Intermediate | The ECS is being restarted. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Resizing | Intermediate | The ECS has received a resizing request and has started to resize. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Verifying resizing | Intermediate | The ECS is verifying the modified configuration. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Deleting | Intermediate | The ECS is being deleted. | - | | | | - | | | If the ECS remains in this state for a long time, exceptions may have occurred. In such a case, contact the administrator. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Deleted | Intermediate | The ECS has been deleted. An ECS in this state cannot provide services and will be promptly cleared from the system. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Faulty | Stable | An exception has occurred on the ECS. Contact the administrator. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Reinstalling OS | Intermediate | The ECS has received a request to reinstall the OS and has begun the reinstallation. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Reinstalling OS failed | Stable | The ECS received a request to reinstall the OS, but due to exceptions, the reinstallation failed. Contact the administrator. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Changing OS | Intermediate | The ECS received a request to change the OS and has begun implementing the changes. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | OS change failed | Stable | The ECS has received a request to change the OS, but due to exceptions, the change failed to be implemented. Contact the administrator. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Forcibly restarting | Intermediate | The ECS is being forcibly restarted. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Rolling back resizing | Intermediate | The ECS is rolling back a resizing operation. | - +------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/ecs/umn/result/service_overview/instances/ecs_types.rst b/ecs/umn/result/service_overview/instances/ecs_types.rst deleted file mode 100644 index f5be00e5..00000000 --- a/ecs/umn/result/service_overview/instances/ecs_types.rst +++ /dev/null @@ -1,61 +0,0 @@ -:original_name: en-us_topic_0035470096.html - -.. _en-us_topic_0035470096: - -ECS Types -========= - -The public cloud provides the following ECS types for different application scenarios: - -- General-purpose -- Dedicated general-purpose -- Memory-optimized -- Large-memory -- Disk-intensive -- High-performance computing -- GPU-accelerated - -ECS Flavor Naming Rules ------------------------ - -ECS flavors are named using the format of "AB.C.D". - -The format is defined as follows: - -- **A** specifies the ECS type. For example, **s** indicates a general-purpose ECS, **c** a computing ECS, and **m** a memory-optimized ECS. -- **B** specifies the type ID. For example, the **3** in **s3** indicates a general-purpose third-generation ECS. -- **C** specifies the flavor size, such as medium, large, xlarge, 2xlarge, 4xlarge, or 8xlarge. -- **D** specifies the ratio of memory to vCPUs expressed in a digit. For example, value **4** indicates that the ratio of memory to vCPUs is 4. - -Obtaining Specifications When Creating an ECS ---------------------------------------------- - -Specifications for the ECS being created are located in the specifications list. - -.. _en-us_topic_0035470096__fig64292023143619: - -.. figure:: /_static/images/en-us_image_0172453607.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** ECS specifications - -Network QoS ------------ - -Network QoS uses basic technologies to improve the quality of network communication. A network with QoS enabled offers predictable network performance and effectively allocates network bandwidth to use network resources. - -To obtain the QoS data of an ECS flavor, including the maximum bandwidth, assured bandwidth, maximum PPS, and NIC multi-queue, see :ref:`ECS Specifications `. - -The intranet bandwidth and PPS of an ECS are determined based on ECS flavors. - -- Assured intranet bandwidth: guaranteed bandwidth allocated to the ECS -- Maximum intranet bandwidth: maximum bandwidth that can be allocated to the ECS -- Maximum intranet PPS: maximum number of packets that the ECS can transmit and receive per second -- NIC multi-queue: allocates NIC interrupt requests to multiple vCPUs for higher PPS performance and bandwidth. - - .. note:: - - - For instructions about how to test PPS, see :ref:`How Can I Test Network Performance? ` - - For instructions about how to enable NIC multi-queue, see :ref:`Enabling NIC Multi-Queue `. diff --git a/ecs/umn/result/service_overview/instances/index.rst b/ecs/umn/result/service_overview/instances/index.rst deleted file mode 100644 index c1ab1ac9..00000000 --- a/ecs/umn/result/service_overview/instances/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _en-us_topic_0271001300: - -========= -Instances -========= - -.. toctree:: - :maxdepth: 1 - - overview - ecs_lifecycle - ecs_types diff --git a/ecs/umn/result/service_overview/instances/overview.rst b/ecs/umn/result/service_overview/instances/overview.rst deleted file mode 100644 index 32f47b4c..00000000 --- a/ecs/umn/result/service_overview/instances/overview.rst +++ /dev/null @@ -1,16 +0,0 @@ -:original_name: en-us_topic_0092435779.html - -.. _en-us_topic_0092435779: - -Overview -======== - -An ECS is a basic computing unit that consists of vCPUs, memory, OS, and EVS disks. - -After creating an ECS, you can use it like using your local computer or physical server, ensuring secure, reliable, and efficient computing. ECSs support self-service creation, modification, and operation. You can create an ECS by specifying its vCPUs, memory, OS, and login authentication. After the ECS is created, you can modify its specifications as required. This ensures a reliable, secure, efficient computing environment. - -The cloud platform provides multiple ECS types for different computing and storage capabilities. One ECS type provides various flavors with different vCPU and memory configurations for you to select. - -- For details about ECS types, see :ref:`ECS Types `. -- For details about all ECS statuses in a lifecycle, see :ref:`ECS Lifecycle `. -- For details about ECS specifications, see :ref:`ECS Specifications `. diff --git a/ecs/umn/result/service_overview/network.rst b/ecs/umn/result/service_overview/network.rst deleted file mode 100644 index adbb4e7a..00000000 --- a/ecs/umn/result/service_overview/network.rst +++ /dev/null @@ -1,109 +0,0 @@ -:original_name: en-us_topic_0030828257.html - -.. _en-us_topic_0030828257: - -Network -======= - -VPC ---- - -Virtual Private Cloud (VPC) allows you to create customized virtual networks in your logically isolated AZ. Such networks are dedicated zones that are logically isolated, providing secure network environments for your ECSs. You can define security groups, virtual private networks (VPNs), IP address segments, and bandwidth for a VPC. This facilitates internal network configuration and management and allows you to change your network in a secure and convenient network manner. You can also customize the ECS access rules within a security group and between security groups to improve ECS security. - -For more information about VPC, see *Virtual Private Cloud User Guide*. - -Subnet ------- - -A subnet is a range of IP addresses in your VPC and provides IP address management and DNS resolution functions for ECSs in it. The IP addresses of all ECSs in a subnet belong to the subnet. - -By default, ECSs in all subnets of the same VPC can communicate with each other, while ECSs in different VPCs cannot. - -Security Group --------------- - -A security group is a collection of access control rules for ECSs that have the same security protection requirements and that are mutually trusted. By adding an ECS to a security group, you apply all the rules defined for this security group to this ECS. - -Your account automatically comes with a default security group. The default security group allows all outbound data, denies all inbound data, and allows all data between ECSs in the group. Your ECSs in the security group can communicate with each other without the need to add rules. - -.. _en-us_topic_0030828257__fig11890174421819: - -.. figure:: /_static/images/en-us_image_0000001230120807.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Default security group - -:ref:`Table 1 ` describes default security group rules. - -.. _en-us_topic_0030828257__table1580115155277: - -.. table:: **Table 1** Default security group rules - - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Direction | Protocol | Port/Range | Source/Destination | Description | - +===========+==========+============+==============================================================+====================================================================================================================+ - | Outbound | All | All | Destination: 0.0.0.0/0 | Allows all outbound traffic. | - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - | Inbound | All | All | Source: the current security group (for example, sg-*xxxxx*) | Allows communications among ECSs within the security group and denies all inbound traffic (incoming data packets). | - +-----------+----------+------------+--------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ - -EIP ---- - -The Elastic IP (EIP) service enables your cloud resources to communicate with the Internet using static public IP addresses and scalable bandwidths. EIPs can be bound to or unbound from ECSs, BMSs, virtual IP addresses, NAT gateways, or load balancers. - -Each EIP can be used by only one cloud resource at a time. - -.. _en-us_topic_0030828257__fig15314318474: - -.. figure:: /_static/images/en-us_image_0178890066.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Accessing the Internet using an EIP - -Network QoS ------------ - -Network QoS uses basic technologies to improve the quality of network communication. A network with QoS enabled offers predictable network performance and effectively allocates network bandwidth to use network resources. - -To obtain the QoS data of an ECS flavor, including the maximum bandwidth, assured bandwidth, maximum PPS, and NIC multi-queue, see :ref:`ECS Specifications `. - -The intranet bandwidth and PPS of an ECS are determined by its flavor. - -- Assured intranet bandwidth: indicates the guaranteed bandwidth allocated to an ECS -- Maximum intranet bandwidth: indicates the maximum bandwidth that can be allocated to an ECS -- Maximum intranet PPS: indicates the maximum ECS capability in transmitting and receiving packets. -- NIC multi-queue: allocates NIC interrupt requests to multiple vCPUs for higher PPS performance and bandwidth. - - .. note:: - - - For instructions about how to test PPS, see :ref:`How Can I Test Network Performance? ` - - For instructions about how to enable NIC multi-queue, see :ref:`Enabling NIC Multi-Queue `. - -**Use case of network QoS:** - -All ECSs of the same hypervisor share the network QoS. There is a hypervisor bucket within the host between the ECS and the hypervisor. So packets from ECSs pass through the bucket to the hypervisor. The bucket size (GB) is determined by the ECS flavor. - -For example, if the maximum bandwidth of a hypervisor bucket is 10 Gbit/s and will be shared by ECS 1 and ECS 2, the assured bandwidth of ECS 1 is 5 Gbit/s and that of ECS 2 is 1 Gbit/s. ECS 1 and ECS 2 share the bandwidth of 10 Gbit/s. - -- If the bandwidth required by ECS 1 is 10 Gbit/s and that required by ECS 2 is 0 Gbit/s, all bandwidths are allocated to ECS 1. -- If the bandwidth required by ECS 1 is 10 Gbit/s and that required by ECS 2 is 1 Gbit/s, the bandwidth allocated to ECS 1 is 9 Gbit/s and that allocated to ECS 2 is 1 Gbit/s. -- If the total bandwidth required by ECS 1 and ECS 2 exceeds the bandwidth of the hypervisor bucket, the assured bandwidth will be allocated to the ECSs first, that is the bandwidth for ECS 1 is 5 Gbit/s and that for ECS 2 is 1 Gbit/s. The remaining 4 Gbit/s of bandwidth will be randomly used by the two ECSs. - -Network QoS: - -- The maximum/assured bandwidth is completely independent of the EIP bandwidth. -- ECSs of the same hypervisor share the total bandwidth of the hypervisor. -- Network QoS applies for both internal and external bandwidth. -- Network QoS has been applied to the existing KVM-based ECSs. -- ECSs of the same hypervisor are preferentially allocated with assured bandwidths. Only when other ECSs of the same hypervisor are not in use, an ECS in use in the hypervisor can have the maximum bandwidth. - -.. note:: - - - Network QoS applies to any program running on an ECS. - - Network QoS applies for both internal and external bandwidth. - - The EIP bandwidth limits the external bandwidth, and the network QoS limits the internal bandwidth. diff --git a/ecs/umn/result/service_overview/region_and_az.rst b/ecs/umn/result/service_overview/region_and_az.rst deleted file mode 100644 index e5351bbe..00000000 --- a/ecs/umn/result/service_overview/region_and_az.rst +++ /dev/null @@ -1,43 +0,0 @@ -:original_name: en-us_topic_0186645877.html - -.. _en-us_topic_0186645877: - -Region and AZ -============= - -Concept -------- - -A region and availability zone (AZ) identify the location of a data center. You can create resources in a specific region and AZ. - -- A region is a physical data center, which is completely isolated to improve fault tolerance and stability. The region that is selected during resource creation cannot be changed after the resource is created. -- An AZ is a physical location where resources use independent power supplies and networks. A region contains one or more AZs that are physically isolated but interconnected through internal networks. Because AZs are isolated from each other, any fault that occurs in one AZ will not affect others. - -:ref:`Figure 1 ` shows the relationship between regions and AZs. - -.. _en-us_topic_0186645877__en-us_topic_0184026189_fig8747114281212: - -.. figure:: /_static/images/en-us_image_0184026531.png - :alt: **Figure 1** Regions and AZs - :figclass: vsd - - - **Figure 1** Regions and AZs - -Selecting a Region ------------------- - -Select a region closest to your target users for lower network latency and quick access. - -Selecting an AZ ---------------- - -When deploying resources, consider your applications' requirements on disaster recovery (DR) and network latency. - -- For high DR capability, deploy resources in different AZs within the same region. -- For lower network latency, deploy resources in the same AZ. - -Regions and Endpoints ---------------------- - -Before you use an API to call resources, specify its region and endpoint. For more details, see `Regions and Endpoints `__. diff --git a/ecs/umn/result/service_overview/security/cloud-init.rst b/ecs/umn/result/service_overview/security/cloud-init.rst deleted file mode 100644 index cec1b238..00000000 --- a/ecs/umn/result/service_overview/security/cloud-init.rst +++ /dev/null @@ -1,64 +0,0 @@ -:original_name: en-us_topic_0048642616.html - -.. _en-us_topic_0048642616: - -Cloud-Init -========== - -Cloud-Init is an open-source cloud initialization program, which initializes some of the customized configurations of a newly created ECS, such as the hostname, key pair, and user data. - -All standard (Standard_xxx) and enterprise (Enterprise_xxx) images support Cloud-Init. Only certain community images (Community_xxx) do not support it. - -Using Cloud-Init to initialize your ECSs will affect your ECS, IMS, and AS services. - -Impact on IMS -------------- - -To ensure that ECSs created using a private image support customized configurations, you must install Cloud-Init or Cloudbase-Init on the ECSs before using them to create private images. - -- For Windows OSs, download and install Cloudbase-Init. -- For Linux OSs, download and install Cloud-Init. - -After Cloud-Init or Cloudbase-Init is installed in an image, Cloud-Init or Cloudbase-Init automatically configures initial attributes for the ECSs created using this image. - -For more information, see *Image Management Service User Guide*. - -Impact on ECS -------------- - -- When creating an ECS, if the selected image supports Cloud-Init, you can use the **User Data** function to specify custom configuration, such as ECS login password to the ECS. Such custom settings will take effect upon ECS initialization. :ref:`Passing User Data to ECSs `\ For details, see :ref:`Passing User Data to ECSs `. -- If Cloud-Init is supported, ECSs do not support password authentication anymore. All newly created ECSs use key pair authentication. This change will influence your ECS logins. For details, see the following sections: - - - :ref:`Login Overview ` - - :ref:`What Is the cloudbase-init Account in Windows ECSs Used for? ` - - :ref:`Why Does the Login to My Linux ECS Using a Key File Fail? ` - - :ref:`Why Does the System Display a Message Indicating that the Password for Logging In to a Windows ECS Cannot Be Viewed? ` - -- If Cloud-Init is supported, you can view and use metadata to configure and manage running ECSs. :ref:`Obtaining Metadata `\ For more information, see :ref:`Obtaining Metadata `. - -Impact on AS ------------- - -- When creating an AS configuration, you can use the **User Data** function to specify ECS configurations for initialization. If the AS configuration has taken effect in an AS group, the ECSs newly created in the AS group will automatically initialize their configurations based on the specified ECS configurations. - -- For an existing AS configuration, if its private image does not have Cloud-Init or Cloudbase-Init installed, the login mode of the ECSs created in the AS group where the AS configuration takes effect may fail to take effect. - - To resolve this issue, see "How Does Cloud-Init Affect the AS Service?" in *Auto Scaling User Guide*. - -Notes ------ - -- When using Cloud-Init, enable DHCP in the VPC to which the ECS belongs. -- When using Cloud-Init, ensure that security group rules for the outbound direction meet the following requirements: - - - **Protocol**: **TCP** - - **Port**: **80** - - **Destination**: **169.254.0.0/16** - - .. note:: - - If you use the default security group rules for the outbound direction, the preceding requirements are met. Then, the metadata can be accessed. Default security group rules for the outbound direction are as follows: - - - **Protocol**: **All** - - **Port**: **All** - - **Destination**: **0.0.0.0/0** diff --git a/ecs/umn/result/service_overview/security/index.rst b/ecs/umn/result/service_overview/security/index.rst deleted file mode 100644 index 750064e7..00000000 --- a/ecs/umn/result/service_overview/security/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _en-us_topic_0092435778: - -======== -Security -======== - -.. toctree:: - :maxdepth: 1 - - user_encryption - cloud-init - license_type - project diff --git a/ecs/umn/result/service_overview/security/license_type.rst b/ecs/umn/result/service_overview/security/license_type.rst deleted file mode 100644 index b8e16439..00000000 --- a/ecs/umn/result/service_overview/security/license_type.rst +++ /dev/null @@ -1,48 +0,0 @@ -:original_name: en-us_topic_0046566932.html - -.. _en-us_topic_0046566932: - -License Type -============ - -Using License from the System ------------------------------ - -You can use the license provided by the public cloud platform. After creating an ECS with a license authorized, you can use the authorized OS. The platform manages license compliance for you. - -BYOL ----- - -**What Is BYOL?** - -Bring your own license (BYOL) allows you to use your existing OS license. In such a case, you do not need to apply for a license again. In BYOL license type, you do not pay for the license fee when creating an ECS. - -**How to Use BYOL?** - -If you select the BYOL license type, you are required to manage licenses by yourself. The public cloud platform provides functions for you to maintain license compliance during the license lifecycle, for example, deploying ECSs on DeHs. If you have obtained an OS license, you do not need to apply for a license any more. - -The OSs supporting BYOL are as follows: - -- SUSE Linux Enterprise Server -- Oracle Enterprise Linux -- Red Hat Enterprise Linux - -**Application Scenarios** - -The system does not support dynamic license type changing. ECSs support BYOL in the following scenarios: - -- Creating an ECS - - After creating an ECS, you cannot change its license type. If the license type must be changed, reinstall or change the ECS OS. - -- Reinstalling an ECS OS - - When reinstalling an ECS OS, you can set the license type for the ECS. - -- Changing an ECS OS - - When changing an ECS OS, you can set the license type for the ECS. - -- Attaching a system disk - - The license type of a system disk is determined by the ECS license type after the ECS is created, the ECS OS is reinstalled, or the ECS OS is changed. If the system disk is detached and then attached to a new ECS or the original ECS, ensure that the ECS license type is the same as the system disk license type. diff --git a/ecs/umn/result/service_overview/security/project.rst b/ecs/umn/result/service_overview/security/project.rst deleted file mode 100644 index fe3fa03c..00000000 --- a/ecs/umn/result/service_overview/security/project.rst +++ /dev/null @@ -1,10 +0,0 @@ -:original_name: en-us_topic_0070518971.html - -.. _en-us_topic_0070518971: - -Project -======= - -A project groups and isolates OpenStack computing, storage, and network resources. A project can be a department or a team. - -Multiple projects can be created for one account. diff --git a/ecs/umn/result/service_overview/security/user_encryption.rst b/ecs/umn/result/service_overview/security/user_encryption.rst deleted file mode 100644 index 6d1cdb42..00000000 --- a/ecs/umn/result/service_overview/security/user_encryption.rst +++ /dev/null @@ -1,76 +0,0 @@ -:original_name: en-us_topic_0046912051.html - -.. _en-us_topic_0046912051: - -User Encryption -=============== - -User encryption allows you to use the encryption feature provided on the public cloud platform to encrypt ECS resources, improving data security. User encryption includes image encryption and EVS disk encryption. - -Image Encryption ----------------- - -Image encryption supports encrypting private images. When creating an ECS, if you select an encrypted image, the system disk of the created ECS is automatically encrypted, improving data security. - -Use either of the following methods to create an encrypted image: - -- Use an external image file. -- Use an existing encrypted ECS. - -For more information about image encryption, see *Image Management Service User Guide*. - -EVS Disk Encryption -------------------- - -EVS disk encryption supports system disk encryption and data disk encryption. - -- When creating an ECS, if you select an encrypted image, the system disk of the created ECS automatically has encryption enabled, and the encryption mode complies with the image encryption mode. -- When creating an ECS, you can encrypt its system disk. -- When creating an ECS, you can encrypt added data disks. - -For more information about EVS disk encryption, see *Elastic Volume Service User Guide*. - -Impact on AS ------------- - -If you use an encrypted ECS to create an Auto Scaling (AS) configuration, the encryption mode of the created AS configuration complies with the ECS encryption mode. - -About Keys ----------- - -The key used for encryption relies on the Key Management Service (KMS). KMS uses a data encryption key (DEK) to encrypt data and a customer master key (CMK) to encrypt the DEK. - -.. _en-us_topic_0046912051__fig66853906172350: - -.. figure:: /_static/images/en-us_image_0174076025.png - :alt: **Figure 1** Data encryption process - :figclass: vsd - - - **Figure 1** Data encryption process - -:ref:`Table 1 ` describes the keys involved in the data encryption process. - -.. _en-us_topic_0046912051__table58453122162120: - -.. table:: **Table 1** Keys - - +-----------------------+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ - | Name | Description | Function | - +=======================+========================================================================================================+====================================================================+ - | DEK | An encryption key that is used for encrypting data. | Encrypts specific data. | - +-----------------------+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ - | CMK | An encryption key created using KMS for encrypting DEKs. | Supports CMK disabling and scheduled deletion. | - | | | | - | | A CMK can encrypt multiple DEKs. | | - +-----------------------+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ - | Default CMK | A master key automatically generated by the system when you use KMS for encryption for the first time. | - Supports viewing details of the default CMK on the KMS console. | - | | | - Does not support CMK disabling or scheduled deletion. | - | | The name extension of a default CMK is **/default**, for example, **evs/default**. | | - +-----------------------+--------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------+ - -.. note:: - - After disabling a CMK or scheduling the deletion of a CMK takes effect, the EVS disk encrypted using this CMK can still be used until the disk is detached from and then attached to an ECS again. During this process, the disk fails to be attached to the ECS because the CMK cannot be obtained. Therefore, the EVS disk becomes unavailable. - -For details about KMS, see *Key Management Service User Guide*. diff --git a/ecs/umn/result/service_overview/user_permissions.rst b/ecs/umn/result/service_overview/user_permissions.rst deleted file mode 100644 index bacc21d7..00000000 --- a/ecs/umn/result/service_overview/user_permissions.rst +++ /dev/null @@ -1,13 +0,0 @@ -:original_name: en-us_topic_0054121392.html - -.. _en-us_topic_0054121392: - -User Permissions -================ - -Two types of permissions are provided by default: user management and resource management. - -- User management refers to the management of users, user groups, and user group rights. -- Resource management refers to the control operations that can be performed by users on cloud service resources. - -For further details, see `Permissions `__. diff --git a/ecs/umn/result/service_overview/what_is_ecs.rst b/ecs/umn/result/service_overview/what_is_ecs.rst deleted file mode 100644 index 5e8211ef..00000000 --- a/ecs/umn/result/service_overview/what_is_ecs.rst +++ /dev/null @@ -1,47 +0,0 @@ -:original_name: en-us_topic_0013771112.html - -.. _en-us_topic_0013771112: - -What Is ECS? -============ - -An Elastic Cloud Server (ECS) is a basic computing unit that consists of vCPUs, memory, OS, and Elastic Volume Service (EVS) disks. After an ECS is created, you can use it on the cloud similarly to how you would use your local PC or physical server. - -ECSs support self-service creation, modification, and operation. You can create an ECS by specifying its vCPUs, memory, OS, and login mode. After an ECS is created, you can modify its specifications if necessary. ECS works with other services to provide a reliable, secure, efficient computing environment. - -System Architecture -------------------- - -ECS works with other products and services to provide computing, storage, and network resources. You can quickly migrate and replicate existing ECSs using images. - -- ECSs can be deployed in multiple availability zones (AZs) connected with each other through an internal network. If one AZ becomes faulty, other AZs in the same region will not be affected. -- With the Virtual Private Cloud (VPC) service, you can build your own dedicated network on the cloud. You can also set subnets and security groups within your VPC for further isolation. You can allow your VPC to communicate with the external network through an EIP (bandwidth support required). -- With the Image Management Service (IMS), you can use an image to create ECSs. Alternatively, you can use an existing ECS to create a private image and use the private image to create the same ECSs for rapid service deployment. -- Elastic Volume Service (EVS) provides storage space and Volume Backup Service (VBS) provides data backup and restoration functions. -- Cloud Eye lets you keep a close eye on the performance and resource utilization of ECSs, ensuring ECS reliability and availability. -- Volume Backup Service (VBS) allows you to create data backups for EVS disks and use the backups to restore the EVS disks. This maximizes user data correctness and security. -- Cloud Server Backup Service (CSBS) backs up all EVS disks of an ECS, including the system disk and data disks, and uses the backup to restore the ECS. - -.. _en-us_topic_0013771112__fig36062790113621: - -.. figure:: /_static/images/en-us_image_0071898891.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** System architecture - -Access Methods --------------- - -The public cloud provides a web-based service management platform. You can access ECSs through HTTPS-compliant application programming interfaces (APIs) or the management console. - -- Accessing ECSs through APIs - - Use this method if you are required to integrate the ECSs on the public cloud platform into a third-party system for secondary development. For detailed operations, see *Elastic Cloud Server API Reference*. - -- Accessing ECSs through the management console - - Use this method if you are not required to integrate ECSs with a third-party system. - - After registering on the public cloud platform, log in to the management console and click **Elastic Cloud Server** under **Compute** on the homepage. diff --git a/ecs/umn/result/troubleshooting/how_can_i_handle_slow_ecs_startup.rst b/ecs/umn/result/troubleshooting/how_can_i_handle_slow_ecs_startup.rst deleted file mode 100644 index f8cbddaa..00000000 --- a/ecs/umn/result/troubleshooting/how_can_i_handle_slow_ecs_startup.rst +++ /dev/null @@ -1,46 +0,0 @@ -:original_name: en-us_topic_0117006217.html - -.. _en-us_topic_0117006217: - -How Can I Handle Slow ECS Startup? -================================== - -If an ECS requires a long period of time to start, you can change the default timeout to speed up the startup. - -#. Log in to the ECS. - -#. Run the following command to switch to user **root**: - - **sudo su** - -#. Run the following command to obtain the grub version: - - **rpm -qa \| grep grub** - - .. _en-us_topic_0117006217__fig165801156121217: - - .. figure:: /_static/images/en-us_image_0117031082.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Viewing the grub version - -#. Change the timeout in the grub file to 0s. - - - If the grub version is earlier than 2: - - Open the **/boot/grub/grub.cfg** or **/boot/grub/menu.lst** file and change the **timeout** value to **0**. - - - If the grub version is 2: - - Open the **/boot/grub2/grub.cfg** file and change the **timeout** value to **0**. - - .. _en-us_topic_0117006217__fig109003411818: - - .. figure:: /_static/images/en-us_image_0117031548.gif - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Changing timeout duration diff --git a/ecs/umn/result/troubleshooting/how_do_i_configure_atop_and_kdump_on_linux_ecss_for_performance_analysis.rst b/ecs/umn/result/troubleshooting/how_do_i_configure_atop_and_kdump_on_linux_ecss_for_performance_analysis.rst deleted file mode 100644 index a25ad90d..00000000 --- a/ecs/umn/result/troubleshooting/how_do_i_configure_atop_and_kdump_on_linux_ecss_for_performance_analysis.rst +++ /dev/null @@ -1,501 +0,0 @@ -:original_name: en-us_topic_0000001143214829.html - -.. _en-us_topic_0000001143214829: - -How Do I Configure atop and kdump on Linux ECSs for Performance Analysis? -========================================================================= - -Scenarios ---------- - -This section describes how you can configure atop and kdump on Linux ECSs for performance analysis. - -The method for configuring atop varies with the OS version. - -atop - -- :ref:`Introduction to atop ` -- :ref:`Configuring atop for CentOS 8 or RHEL 8 ` -- :ref:`Configuring atop for CentOS 7, RHEL 7, or EulerOS ` -- :ref:`Configuring atop for SUSE 12 or SUSE 15 ` -- :ref:`Configuring atop Using Its Source Package for SUSE, Fedora, Debian or Ubuntu ` - -kdump - -- :ref:`Precautions for Configuring kdump ` -- :ref:`Introduction to kdump ` -- :ref:`Configuring kdump ` -- :ref:`Checking Whether kdump Configurations Have Taken Effect ` - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section0959133015350: - -Introduction to atop --------------------- - -atop is a monitor for Linux that can report the activity of all processes and resource consumption by all processes at regular intervals. It shows system-level activity related to the CPU, memory, disks, and network layers for every process. It also logs system and process activities daily and saves the logs in disks for long-term analysis. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section18897192721320: - -Configuring atop for CentOS 8 or RHEL 8 ---------------------------------------- - -#. Run the following command to download the atop package: - - **# wget https://www.atoptool.nl/download/atop-2.6.0-1.el8.x86_64.rpm** - -#. Run the following command to install the package: - - **# rpm -ivh atop-2.6.0-1.el8.x86_64.rpm** - -#. Run the following command to modify the configuration file of atop: - - **# vi /etc/default/atop** - - Modify the following parameters, save the modification, and exit: - - - Change the value of **LOGINTERVAL** to, for example, **15**. The default value of **LOGINTERVAL** is **600**, in seconds. - - - Change the value of **LOGGENERATIONS** if needed. The default retention period of atop logs is **28** days. - - .. code-block:: - - LOGINTERVAL=15 - LOGGENERATIONS=28 - -4. Run the following command to restart atop: - - **# systemctl restart atop** - -5. Run the following command to check the status of atop. If **active (running)** is displayed in the output, atop is running properly. - - **# systemctl status atop** - - .. code-block:: - - atop.service - Atop advanced performance monitor - Loaded: loaded (/usr/lib/systemd/system/atop.service; enabled; vendor preset: disabled) - Active: active (running) since Sat 2021-06-19 14:46:10 CST; 8s ago - Docs: man:atop(1) - Process: 6391 ExecStartPost=/usr/bin/find ${LOGPATH} -name atop_* -mtime +${LOGGENERATIONS} -exec rm -v {} ; (code=exited, status=0/SUCCESS) - Process: 6388 ExecStartPre=/bin/sh -c test -n "$LOGGENERATIONS" -a "$LOGGENERATIONS" -eq "$LOGGENERATIONS" (code=exited, status=0/SUCCESS) - Process: 6387 ExecStartPre=/bin/sh -c test -n "$LOGINTERVAL" -a "$LOGINTERVAL" -eq "$LOGINTERVAL" (code=exited, status=0/SUCCESS) - Main PID: 6390 (atop) - Tasks: 1 (limit: 23716) - Memory: 4.1M - CGroup: /system.slice/atop.service - └─6390 /usr/bin/atop -w /var/log/atop/atop_20210619 15 - - Jun 19 14:46:10 ecs-centos8 systemd[1]: atop.service: Succeeded. - Jun 19 14:46:10 ecs-centos8 systemd[1]: Stopped Atop advanced performance monitor. - Jun 19 14:46:10 ecs-centos8 systemd[1]: Starting Atop advanced performance monitor... - Jun 19 14:46:10 ecs-centos8 systemd[1]: Started Atop advanced performance monitor. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section1972319582310: - -Configuring atop for CentOS 7, RHEL 7, or EulerOS -------------------------------------------------- - -#. Run the following command to download the atop package: - - **# wget https://www.atoptool.nl/download/atop-2.6.0-1.el7.x86_64.rpm** - - Upload the **atop-2.6.0-1.el7.x86_64.rpm** package to the target ECS. - -#. Run the following command to install atop: - - **# rpm -ivh atop-2.6.0-1.el7.x86_64.rpm --nodeps** - -#. Run the following command to modify the configuration file of atop: - - **# vi /etc/default/atop** - - Modify the following parameters, save the modification, and exit: - - - Change the value of **INTERVAL** to, for example, **15**. The default value of **INTERVAL** is **600**, in seconds. - - Change the value following **-mtime** if needed. The default retention period of atop logs is **28** days. - - .. code-block:: - - LOGINTERVAL=15 - LOGGENERATIONS=28 - -#. Run the following command to start atop: - - **# systemctl start atop** - -#. Run the following command to check the status of atop. If **active (running)** is displayed in the output, atop is running properly. - - **# systemctl status atop** - - atop will sample system performance data based on the specified interval and save the data to the **/var/log/atop/** directory. - - .. code-block:: - - atop.service - Atop advanced performance monitor - Loaded: loaded (/usr/lib/systemd/system/atop.service; enabled; vendor preset: disabled) - Active: active (running) since Sat 2021-06-19 11:49:47 CST; 2h 27min ago - Docs: man:atop(1) - Process: 8231 ExecStartPost=/usr/bin/find ${LOGPATH} -name atop_* -mtime +${LOGGENERATIONS} -exec rm -v {} ; (code=exited, status=0/SUCCESS) - Process: 8225 ExecStartPre=/bin/sh -c test -n "$LOGGENERATIONS" -a "$LOGGENERATIONS" -eq "$LOGGENERATIONS" (code=exited, status=0/SUCCESS) - Process: 8223 ExecStartPre=/bin/sh -c test -n "$LOGINTERVAL" -a "$LOGINTERVAL" -eq "$LOGINTERVAL" (code=exited, status=0/SUCCESS) - Main PID: 8229 (atop) - CGroup: /system.slice/atop.service - └─8229 /usr/bin/atop -w /var/log/atop/atop_20210619 15 - - Jun 19 11:49:47 ecs-centos7 systemd[1]: Stopped Atop advanced performance monitor. - Jun 19 11:49:47 ecs-centos7 systemd[1]: Starting Atop advanced performance monitor... - Jun 19 11:49:47 ecs-centos7 systemd[1]: Started Atop advanced performance monitor. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section3205824181917: - -Configuring atop for SUSE 12 or SUSE 15 ---------------------------------------- - -#. Run the following command to download the atop source package: - - **# wget https://www.atoptool.nl/download/atop-2.6.0-1.src.rpm** - -#. Run the following command to install the package: - - **# rpm -ivh atop-2.6.0-1.src.rpm** - -#. Run the following command to install atop dependencies. - - **# zypper -n install rpm-build ncurses-devel zlib-devel** - -#. Run the following command to compile atop: - - **# cd /usr/src/packages/SPECS** - - **# rpmbuild -bb atop-2.6.0.spec** - -#. Run the following command to install atop: - - **# cd /usr/src/packages/RPMS/x86_64** - - **# rpm -ivh atop-2.6.0-1.x86_64.rpm** - -#. Run the following command to modify the configuration file of atop: - - **# vi /etc/default/atop** - - Modify the following parameters, save the modification, and exit: - - - Change the value of **LOGINTERVAL** to, for example, **15**. The default value of **LOGINTERVAL** is **600**, in seconds. - - Change the value of **LOGGENERATIONS** if needed. The default retention period of atop logs is **28** days. - - .. code-block:: - - LOGINTERVAL=15 - LOGGENERATIONS=28 - -7. Run the following command to restart atop: - - **# systemctl restart atop** - -8. Run the following command to check the status of atop. If **active (running)** is displayed in the output, atop is running properly. - - **# systemctl status atop** - - .. code-block:: - - atop.service - Atop advanced performance monitor - Loaded: loaded (/usr/lib/systemd/system/atop.service; enabled; vendor preset: disabled) - Active: active (running) since Sat 2021-06-19 16:50:01 CST; 6s ago - Docs: man:atop(1) - Process: 2242 ExecStartPost=/usr/bin/find ${LOGPATH} -name atop_* -mtime +${LOGGENERATIONS} -exec rm -v {} ; (code=exited, status=0/SUCCESS) - Process: 2240 ExecStartPre=/bin/sh -c test -n "$LOGGENERATIONS" -a "$LOGGENERATIONS" -eq "$LOGGENERATIONS" (code=exited, status=0/SUCCESS) - Process: 2239 ExecStartPre=/bin/sh -c test -n "$LOGINTERVAL" -a "$LOGINTERVAL" -eq "$LOGINTERVAL" (code=exited, status=0/SUCCESS) - Main PID: 2241 (atop) - Tasks: 1 (limit: 4915) - CGroup: /system.slice/atop.service - └─2241 /usr/bin/atop -w /var/log/atop/atop_20210619 15 - - Jun 19 16:50:01 ecs-suse15 systemd[1]: Starting Atop advanced performance monitor... - Jun 19 16:50:01 ecs-suse15 systemd[1]: Started Atop advanced performance monitor. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section012793312620: - -Configuring atop Using Its Source Package for SUSE, Fedora, Debian or Ubuntu ----------------------------------------------------------------------------- - -#. Download the atop source package. - - **# wget https://www.atoptool.nl/download/atop-2.6.0.tar.gz** - -2. Decompress the source package. - - **# tar -zxvf atop-2.6.0.tar.gz** - -3. Query the systemctl version. - - **# systemctl --version** - - If the version is 220 or later, go to the next step. - - Otherwise, delete parameter **--now** from the Makefile of atop. - - **# vi atop-2.6.0/Makefile** - - Delete parameter **--now** following the systemctl command. - - .. code-block:: - - then /bin/systemctl disable atop 2> /dev/null; \ - /bin/systemctl disable atopacct 2> /dev/null; \ - /bin/systemctl daemon-reload; \ - /bin/systemctl enable atopacct; \ - /bin/systemctl enable atop; \ - /bin/systemctl enable atop-rotate.timer; \ - -4. Install atop dependencies. - - - SUSE 12 or SUSE 15 - - **# zypper -n install make gcc zlib-devel ncurses-devel** - - - Fedora - - **# yum install make gcc zlib-devel ncurses-devel -y** - - - Debian 9, Debian 10, or Ubuntu - - **# apt install make gcc zlib1g-dev libncurses5-dev libncursesw5-dev -y** - -5. Compile and install atop. - - **# cd atop-2.6.0** - - **# make systemdinstall** - -6. Modify the configuration file of atop. - - **# vi /etc/default/atop** - - Make the following modifications, save the file, and exit. - - - Change the value of **LOGINTERVAL** to, for example, **15**. The default value of **LOGINTERVAL** is **600**, in seconds. - - - Change the value of **LOGGENERATIONS** if needed. The default retention period of atop logs is **28** days. - - .. code-block:: - - LOGOPTS="" - LOGINTERVAL=15 - LOGGENERATIONS=28 - LOGPATH=/var/log/atop - -7. Restart atop. - - **# systemctl restart atop** - -8. Run the following command to check the status of atop. If **active (running)** is displayed in the output, atop is running properly. - - **# systemctl status atop** - - .. code-block:: - - atop.service - Atop advanced performance monitor - Loaded: loaded (/lib/systemd/system/atop.service; enabled) - Active: active (running) since Sun 2021-07-25 19:29:40 CST; 4s ago - Docs: man:atop(1) - Process: 5192 ExecStartPost=/usr/bin/find ${LOGPATH} -name atop_* -mtime +${LOGGENERATIONS} -exec rm -v {} ; (code=exited, status=0/SUCCESS) - Process: 5189 ExecStartPre=/bin/sh -c test -n "$LOGGENERATIONS" -a "$LOGGENERATIONS" -eq "$LOGGENERATIONS" (code=exited, status=0/SUCCESS) - Process: 5188 ExecStartPre=/bin/sh -c test -n "$LOGINTERVAL" -a "$LOGINTERVAL" -eq "$LOGINTERVAL" (code=exited, status=0/SUCCESS) - Main PID: 5191 (atop) - CGroup: /system.slice/atop.service - └─5191 /usr/bin/atop -w /var/log/atop/atop_20210725 15 - - Jul 25 19:29:40 atop systemd[1]: Starting Atop advanced performance monitor... - Jul 25 19:29:40 atop systemd[1]: Started Atop advanced performance monitor. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section1410131164120: - -Precautions for Configuring kdump ---------------------------------- - -The method for configuring kdump described in this section applies to KVM ECSs running EulerOS or CentOS 7.x. For details, see `Documentation for kdump `__. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section18450171174120: - -Introduction to kdump ---------------------- - -kdump is a feature of the Linux kernel that creates crash dumps in the event of a kernel crash. In the event of a kernel crash, kdump boots another Linux kernel and uses it to export an image of RAM, which is known as vmcore and can be used to debug and determine the cause of the crash. - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section134381494320: - -Configuring kdump ------------------ - -#. Run the following command to check whether kexec-tools is installed: - - **# rpm -q kexec-tools** - - If it is not installed, run the following command to install it: - - **# yum install -y kexec-tools** - -#. Run the following command to enable kdump to run at system startup: - - **# systemctl enable kdump** - -#. Configure the parameters for the crash kernel to reserve the memory for the capture kernel. - - Check whether the parameters are configured. - - **# grep crashkernel /proc/cmdline** - - If the command output is displayed, this parameter has been configured. - - Edit the **/etc/default/grub** file to configure the following parameters: - - .. code-block:: - - GRUB_TIMEOUT=5 - GRUB_DEFAULT=saved - GRUB_DISABLE_SUBMENU=true - GRUB_TERMINAL_OUTPUT="console" - GRUB_CMDLINE_LINUX="crashkernel=auto rd.lvm.lv=rhel00/root rd.lvm.lv=rhel00/swap - rhgb quiet" - GRUB_DISABLE_RECOVERY="true" - - Locate parameter **GRUB_CMDLINE_LINUX** and add **crashkernel=auto** after it. - -#. Run the following command for the configuration to take effect: - - **# grub2-mkconfig -o /boot/grub2/grub.cfg** - -#. Open the **/etc/kdump.conf** file, locate parameter **path**, and add **/var/crash** after it. - - .. code-block:: - - path /var/crash - - By default, the file is saved in the **/var/crash** directory. - - You can save the file to another directory, for example, **/home/kdump**. Then add **/home/kdump** after parameter **path**: - - .. code-block:: - - path /home/kdump - - .. note:: - - There must be enough space in the specified path for storing the vmcore file. It is recommended that the available space be greater than or equal to the RAM size. You can also store the vmcore file on a shared device such as SAN or NFS. - -#. Set the vmcore dump level. - - Add the following content to file **/etc/kdump.conf**. If the content already exists, skip this step. - - .. code-block:: - - core_collector makedumpfile -d 31 -c - - where - - **-c** indicates compressing the vmcore file. - - **-d** indicates leaving out irrelevant data. Generally, the value following **-d** is **31**, which is calculated based on the following values. You can adjust the value if needed. - - .. code-block:: - - zero pages = 1 - cache pages = 2 - cache private = 4 - user pages = 8 - free pages = 16 - -#. Set kernel parameters. - - Some kernel parameters control when kdump will be triggered. It is recommended that you set all the parameters as follows: - - .. code-block:: - - kernel.hardlockup_panic=1 - kernel.panic=5 - kernel.panic_on_oops=1 - kernel.softlockup_panic=1 - kernel.unknown_nmi_panic=1 - kernel.nmi_watchdog=1 - -#. Modify the preceding parameters in file **/etc/sysctl.conf** file and save the file. You can also add the following parameters to the **/etc/sysctl.conf** file: - - .. code-block:: - - kernel.panic_on_io_nmi=1 - kernel.panic_on_warn=1 - -#. Run the following command to restart the system for the configurations to take effect: - - **# reboot** - -.. _en-us_topic_0000001143214829__en-us_topic_0178319250_section1296112934412: - -Checking Whether kdump Configurations Have Taken Effect -------------------------------------------------------- - -#. Run the following command and check whether **crashkernel=auto** is displayed: - - **#** **cat /proc/cmdline \|grep crashkernel** - - .. code-block:: - - BOOT_IMAGE=/boot/vmlinuz-3.10.0-514.44.5.10.h142.x86_64 root=UUID=6407d6ac-c761-43cc-a9dd-1383de3fc995 ro crash_kexec_post_notifiers softlockup_panic=1 panic=3 reserve_kbox_mem=16M nmi_watchdog=1 rd.shell=0 fsck.mode=auto fsck.repair=yes net.ifnames=0 spectre_v2=off nopti noibrs noibpb crashkernel=auto LANG=en_US.UTF-8 - -#. Run the following command and check whether the values of the parameters in bold are the same as the following: - - # **sysctl -a \|grep panic** - - .. code-block:: - - kernel.hardlockup_panic = 1 - kernel.hung_task_panic = 0 - kernel.panic = 5 - kernel.panic_on_io_nmi = 0 - kernel.panic_on_oops = 1 - kernel.panic_on_stackoverflow = 0 - kernel.panic_on_unrecovered_nmi = 0 - kernel.panic_on_warn = 0 - kernel.softlockup_panic = 1 - kernel.unknown_nmi_panic = 1 - vm.panic_on_oom = 0 - -#. Run the following command and check whether the configuration in the output is correct: - - **# grep core_collector /etc/kdump.conf \|grep -v ^"#"** - - .. code-block:: - - core_collector makedumpfile -l --message-level 1 -d 31 - -#. Run the following command and check whether the path configuration in the output is correct: - - **# grep path /etc/kdump.conf \|grep -v ^"#"** - - .. code-block:: - - path /var/crash - -#. Run the following command and check whether the value of **Active** in the output is **active (exited)**: - - **# systemctl status kdump** - - .. code-block:: - - ● kdump.service - Crash recovery kernel arming - Loaded: loaded (/usr/lib/systemd/system/kdump.service; enabled; vendor preset: enabled) - Active: active (exited) since Tue 2019-04-09 19:30:24 CST; 8min ago - Process: 495 ExecStart=/usr/bin/kdumpctl start (code=exited, status=0/SUCCESS) - Main PID: 495 (code=exited, status=0/SUCCESS) - CGroup: /system.slice/system-hostos.slice/kdump.service - -#. Run the following test command: - - **# echo c > /proc/sysrq-trigger** - - After the command is executed, kdump will be triggered, the system will be restarted, and the generated vmcore file will be saved to the path specified by **path**. - -#. Run the following command to check whether the vmcore file has been generated in the specified path, for example, **/var/crash/**: - - **# ll /var/crash/** diff --git a/ecs/umn/result/troubleshooting/index.rst b/ecs/umn/result/troubleshooting/index.rst deleted file mode 100644 index 1c0b9ab4..00000000 --- a/ecs/umn/result/troubleshooting/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _en-us_topic_0096170524: - -=============== -Troubleshooting -=============== - -.. toctree:: - :maxdepth: 1 - - what_can_i_do_if_switching_from_a_non-root_user_to_user_root_times_out - what_should_i_do_if_error_command_gcc_failed_with_exit_status_1_occurs_during_pip-based_software_installation - what_should_i_do_if_packages_are_downloaded_using_pip_or_wget_at_a_low_rate - how_can_i_handle_slow_ecs_startup - how_do_i_configure_atop_and_kdump_on_linux_ecss_for_performance_analysis diff --git a/ecs/umn/result/troubleshooting/what_can_i_do_if_switching_from_a_non-root_user_to_user_root_times_out.rst b/ecs/umn/result/troubleshooting/what_can_i_do_if_switching_from_a_non-root_user_to_user_root_times_out.rst deleted file mode 100644 index 84d0362c..00000000 --- a/ecs/umn/result/troubleshooting/what_can_i_do_if_switching_from_a_non-root_user_to_user_root_times_out.rst +++ /dev/null @@ -1,51 +0,0 @@ -:original_name: en-us_topic_0094801708.html - -.. _en-us_topic_0094801708: - -What Can I Do If Switching from a Non-root User to User root Times Out? -======================================================================= - -Symptom -------- - -When you run the **sudo** command to switch to user **root** on an Ubuntu or Debian ECS, the system prompts connection timeout. - -.. _en-us_topic_0094801708__fig727412824411: - -.. figure:: /_static/images/en-us_image_0094801740.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Connection timeout - -Solution --------- - -#. Log in to the ECS. - -#. Run the following command to edit the hosts configuration file: - - **vi /etc/hosts** - -#. Press **i** to enter editing mode. - -#. Add the IP address and hostname to the last line of the hosts configuration file. - - *Private IP address hostname* - - An example is provided as follows: - - If the ECS hostname is **hostname** and the private IP address of the ECS is 192.168.0.1, add the following statement: - - 192.168.0.1 hostname - -#. Press **Esc** to exit editing mode. - -#. Run the following command to save the configuration and exit: - - **:wq** - -.. note:: - - To update the hostname of an Ubuntu or Debian ECS, set the value of parameter **manage_etc_hosts** in the **/etc/cloud/cloud.cfg** file to **false** and update the new hostname in the **/etc/hosts** file. When editing the **/etc/hosts** file, do not delete the statement in the line where **127.0.0.1** is located. Otherwise, switching from a non-root user to user **root** will time out. diff --git a/ecs/umn/result/troubleshooting/what_should_i_do_if_error_command_gcc_failed_with_exit_status_1_occurs_during_pip-based_software_installation.rst b/ecs/umn/result/troubleshooting/what_should_i_do_if_error_command_gcc_failed_with_exit_status_1_occurs_during_pip-based_software_installation.rst deleted file mode 100644 index 1671dac9..00000000 --- a/ecs/umn/result/troubleshooting/what_should_i_do_if_error_command_gcc_failed_with_exit_status_1_occurs_during_pip-based_software_installation.rst +++ /dev/null @@ -1,54 +0,0 @@ -:original_name: en-us_topic_0107412162.html - -.. _en-us_topic_0107412162: - -What Should I Do If Error "command ´gcc´ failed with exit status 1" Occurs During PIP-based Software Installation -================================================================================================================= - -Symptom -------- - -When installing the Python library software, you need to configure the PIP source. Take the official image source as an example: - -.. code-block:: - - [root@test home]# cat /root/.pip/pip.conf - [global] - index-url = https://pypi.python.org/simple - trusted-host = pypi.python.org - -During the installation, the system displays the message "command ´gcc´ failed with exit status 1". However, GCC has been installed by running the yum command before the Python library software is installed using the PIP. - -.. _en-us_topic_0107412162__fig15547217122815: - -.. figure:: /_static/images/en-us_image_0107414257.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** Installation error - -Possible Causes ---------------- - -openssl-devel is not supported. - -Solution --------- - -The following operations use psutil as an example: - -#. Run the following command to install openssl-devel: - - **yum install gcc libffi-devel python-devel openssl-devel -y** - -#. Use PIP to install the Python library software again. The error message is cleared. - - .. _en-us_topic_0107412162__fig850134793413: - - .. figure:: /_static/images/en-us_image_0107415055.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 2** Successful installation diff --git a/ecs/umn/result/troubleshooting/what_should_i_do_if_packages_are_downloaded_using_pip_or_wget_at_a_low_rate.rst b/ecs/umn/result/troubleshooting/what_should_i_do_if_packages_are_downloaded_using_pip_or_wget_at_a_low_rate.rst deleted file mode 100644 index cf99ab1d..00000000 --- a/ecs/umn/result/troubleshooting/what_should_i_do_if_packages_are_downloaded_using_pip_or_wget_at_a_low_rate.rst +++ /dev/null @@ -1,32 +0,0 @@ -:original_name: en-us_topic_0107490388.html - -.. _en-us_topic_0107490388: - -What Should I Do If Packages Are Downloaded Using PIP or wget at a Low Rate? -============================================================================ - -Symptom -------- - -When a user runs the wget command to download software packages, the download rate is far less than the bandwidth. - -.. _en-us_topic_0107490388__fig17394493307: - -.. figure:: /_static/images/en-us_image_0107505891.png - :alt: Click to enlarge - :figclass: imgResize - - - **Figure 1** wget-based package downloading - -Possible Causes ---------------- - -The official PIP website is accessed using HTTPS. Each time PIP is used to install a third-party Python module, the source code package must be downloaded at the official PIP website. Therefore, openssl packages are required. - -Solution --------- - -Run the following command to install openssl packages: - -**yum install openssl openssl-devel** diff --git a/modelarts/api-ref/result/api_overview.rst b/modelarts/api-ref/result/api_overview.rst deleted file mode 100644 index 1a9c0067..00000000 --- a/modelarts/api-ref/result/api_overview.rst +++ /dev/null @@ -1,158 +0,0 @@ -.. _modelarts_03_0002: - -API Overview -============ - -All ModelArts APIs are proprietary. - -You can use these APIs to manage datasets, training jobs, models, and services. - -Data Management APIs --------------------- - -Data management APIs include the APIs for managing datasets, dataset versions, samples, and labels. Use these APIs to create datasets and label data. For details, see :ref:`Data Management APIs `. - -Development Environment APIs ----------------------------- - -.. table:: **Table 1** Development environment APIs - - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | API | Description | - +============================================================================================+============================================================================+ - | :ref:`Creating a Development Environment Instance ` | Create a development environment instance for code development. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | :ref:`Querying a List of Development Environment Instances ` | Query the development environment instances that meet the search criteria. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | :ref:`Querying the Details About a Development Environment Instance ` | Query the details about a development environment instance. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | :ref:`Modifying the Description of a Development Environment Instance ` | Modify the description of a development environment instance. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | :ref:`Deleting a Development Environment Instance ` | Delete a development environment instance. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - | :ref:`Managing a Development Environment Instance ` | Start or stop a development environment instance. | - +--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------+ - -Training Management APIs ------------------------- - -.. table:: **Table 2** Training management APIs - - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | Type | API | Description | - +======================================+====================================================================================+==============================================================================+ - | Training Jobs | :ref:`Creating a Training Job ` | Create a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying a Training Job List ` | Query the created training jobs that meet the search criteria. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying the Details About a Training Job Version ` | Query the details about a specified training job based on the job ID. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Deleting a Version of a Training Job ` | Delete a version of a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying a List of Training Job Versions ` | Query the version of a specified training job based on the job ID. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Creating a Version of a Training Job ` | Create a version of a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Stopping a Training Job ` | Stop a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Modifying the Description of a Training Job ` | Modify the description of a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Deleting a Training Job ` | Delete a training job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Obtaining the Name of a Training Job Log File ` | Obtain the name of a training job log file. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying a Built-in Algorithm ` | Query the details about a built-in model. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying Training Job Logs ` | Query detailed information about training job logs by row. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | Training Job Parameter Configuration | :ref:`Creating a Training Job Configuration ` | Create a training job configuration. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying a List of Training Job Configurations ` | Query the created training job configurations that meet the search criteria. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Modifying a Training Job Configuration ` | Modify a training job configuration. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Deleting a Training Job Configuration ` | Delete a training job configuration. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying the Details About a Training Job Configuration ` | Query the details about a specified training job configuration. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | Visualization Job Management | :ref:`Creating a Visualization Job ` | Create a visualization job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying a Visualization Job List ` | Query the visualization jobs that meet the search criteria. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying the Details About a Visualization Job ` | Query the details about a specified visualization job based on the job name. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Modifying the Description of a Visualization Job ` | Modify the description of a visualization job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Deleting a Visualization Job ` | Delete a visualization job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Stopping a Visualization Job ` | Stop a visualization job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Restarting a Visualization Job ` | Restart a visualization job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | Resource and Engine Specifications | :ref:`Querying Job Resource Specifications ` | Query the resource specifications of a specified job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | | :ref:`Querying Job Engine Specifications ` | Query the engine type and version of a specified job. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - | Job Statuses | :ref:`Job Statuses ` | View job statuses and status description. | - +--------------------------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------+ - -Model Management APIs ---------------------- - -.. table:: **Table 3** Model management APIs - - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | API | Description | - +===============================================================+=============================================================================================================+ - | :ref:`Importing a Model ` | Import a model. | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying a Model List ` | Query the models that meet the search criteria. | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying the Details About a Model ` | Query details about a model based on the model ID. | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - | :ref:`Deleting a Model ` | Delete a specified model based on the model ID. All versions of the model can be deleted in cascading mode. | - +---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ - -Service Management APIs ------------------------ - -.. table:: **Table 4** Service management APIs - - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | API | Description | - +=================================================================================+==============================================================================================================================+ - | :ref:`Deploying a Model as a Service ` | Deploy a model service. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying a Service List ` | Query model services. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying the Details About a Service ` | Query the details about a model service based on the service ID. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Updating Service Configurations ` | Update a model service. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying Service Monitoring Information ` | Query service monitoring information. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying Service Update Logs ` | Query the update logs of a real-time service. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying Service Event Logs ` | Query service event logs, including service operation records, key actions during deployment, and deployment failure causes. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Deleting a Service ` | Delete a model service. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Querying Supported Service Deployment Specifications ` | Query supported service deployment specifications. | - +---------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------+ - -Authorization Management APIs ------------------------------ - -.. table:: **Table 5** Workspace management APIs - - +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | API | Description | - +============================================================+=========================================================================================================================================================================================================================+ - | :ref:`Viewing an Authorization List ` | View an authorization list. | - +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Configuring Authorization ` | Configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. | - +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Deleting Authorization ` | Delete the authorization of a specified user or all users. | - +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Creating a ModelArts Agency ` | Create a ModelArts agency for dependent services such as OBS, SWR, and IEF. | - +------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/api-ref/result/application_cases/creating_a_training_job_using_the_tensorflow_framework.rst b/modelarts/api-ref/result/application_cases/creating_a_training_job_using_the_tensorflow_framework.rst deleted file mode 100644 index f5e3b762..00000000 --- a/modelarts/api-ref/result/application_cases/creating_a_training_job_using_the_tensorflow_framework.rst +++ /dev/null @@ -1,459 +0,0 @@ -.. _modelarts_03_0401: - -Creating a Training Job Using the TensorFlow Framework -====================================================== - -Overview --------- - -This section describes how to train a model on ModelArts by calling a series of APIs. - -The process for creating a training job using the TensorFlow framework is as follows: - -#. Call the API in :ref:`Authentication ` to obtain the user token, which will be put into the request header for authentication in a subsequent request. -#. Call the API in :ref:`Querying Job Resource Specifications ` to obtain the resource flavors available for training jobs. -#. Call the API in :ref:`Querying Job Engine Specifications ` to view the engine types and versions available for training jobs. -#. Call the API in :ref:`Creating a Training Job ` to create a training job. -#. Call the API in :ref:`Querying the Details About a Training Job Version ` to query the details about the training job based on the job ID. -#. Call the API in :ref:`Obtaining the Name of a Training Job Log File ` to obtain the name of the training job log file. -#. Call the API in :ref:`Querying Training Job Logs ` to view the log details of the training job. -#. Call the API in :ref:`Deleting a Training Job ` to delete the training job if it is no longer needed. - -Prerequisites -------------- - -- You have obtained the endpoints of and :ref:`ModelArts `. -- You have located the region where the service is deployed and obtained . -- You have obtained the project ID. For details, see :ref:`Obtaining a Project ID and Name `. -- You have prepared the training code for TensorFlow. For example, you have stored the boot file **train_mnist_tf.py** in the **/test-modelarts/mnist-tensorflow-code/** directory of OBS. -- You have prepared a dataset for the training job. For example, you have stored a training dataset in the **/test-modelarts/dataset-mnist/** directory of OBS. -- You have created the output path of the training job, for example, **/test-modelarts/mnist-model/output/**. - -Procedure ---------- - -#. .. _modelarts_03_0401__en-us_topic_0000001073831232_li1438114133315: - - Call the API in :ref:`Authentication ` to obtain the user token. - - a. Request body: - - URI format: POST https://**{iam_endpoint}**/v3/auth/tokens - - Request header: Content-Type → application/json - - Request body: - - .. code-block:: - - { - "auth": { - "identity": { - "methods": ["password"], - "password": { - "user": { - "name": "username", - "password": "**********", - "domain": { - "name": "domainname" - } - } - } - }, - "scope": { - "project": { - "name": "" - } - } - } - } - - Set the italic fields in bold based on the site requirements. - - - Replace **iam_endpoint** with the IAM endpoint. - - Replace **username** with the IAM username. - - Replace **\*******\*** with the login password of the user. - - Replace **domainname** with the account to which the user belongs. - - Replace with the project name, which indicates the zone where the service is deployed. - - b. The status code **201 Created** is returned. The value of **X-Subject-Token** in the response header is the token. - - .. code-block:: - - x-subject-token →MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX... - -#. .. _modelarts_03_0401__en-us_topic_0000001073831232_li384513468342: - - Call the API in :ref:`Querying Job Resource Specifications ` to obtain the resource flavors available for training jobs. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/job/resource-specs?job_type=train - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - - Replace **ma_endpoint** with the ModelArts endpoint. - - Replace **project_id** with the project ID of the user. - - Set **X-auth-Token** to the token obtained in :ref:`1 `. - - b. The status code **200 OK** is returned. The response body is as follows: - - .. code-block:: - - { - "specs": [ - ...... - { - "spec_id": 7, - "core": "2", - "cpu": "8", - "gpu_num": 0, - "gpu_type": "", - "spec_code": "modelarts.vm.cpu.2u", - "unit_num": 1, - "max_num": 1, - "storage": "", - "interface_type": 1, - "no_resource": false - }, - { - "spec_id": 27, - "core": "8", - "cpu": "32", - "gpu_num": 0, - "gpu_type": "", - "spec_code": "modelarts.vm.cpu.8u", - "unit_num": 1, - "max_num": 1, - "storage": "", - "interface_type": 1, - "no_resource": false - } - ], - "is_success": true, - "spec_total_count": 5 - } - - - Select and record the flavor type required for creating the training job based on the **spec_code** field. This section uses **modelarts.vm.cpu.8u** as an example and records the value of the **max_num** field as **1**. - - The **no_resource** field is used to determine whether resources are sufficient. Value **false** indicates that resources are available. - -#. .. _modelarts_03_0401__en-us_topic_0000001073831232_li12845104623418: - - Call the API in :ref:`Querying Job Engine Specifications ` to view the engine types and versions available for training jobs. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/job/ai-engines?job_type=train - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - - Replace **ma_endpoint** with the ModelArts endpoint. - - Replace **project_id** with the project ID of the user. - - Set **X-auth-Token** to the token obtained in :ref:`1 `. - - b. The status code **200 OK** is returned. The response body is as follows: - - .. code-block:: - - { - "engines": [ - { - "engine_type": 13, - "engine_name": "Ascend-Powered-Engine", - "engine_id": 130, - "engine_version": "TF-1.15-python3.7-aarch64" - }, - ...... - { - "engine_type": 1, - "engine_name": "TensorFlow", - "engine_id": 3, - "engine_version": "TF-1.8.0-python2.7" - }, - { - "engine_type": 1, - "engine_name": "TensorFlow", - "engine_id": 4, - "engine_version": "TF-1.8.0-python3.6" - }, - ...... - { - "engine_type": 9, - "engine_name": "XGBoost-Sklearn", - "engine_id": 100, - "engine_version": "XGBoost-0.80-Sklearn-0.18.1-python3.6" - } - ], - "is_success": true - } - - Select the engine flavor required for creating a training job based on the **engine_name** and **engine_version** fields and record **engine_id**. This section describes how to create a job based on the TensorFlow engine. Record **engine_id** as **4**. - -#. .. _modelarts_03_0401__en-us_topic_0000001073831232_li5845144683416: - - Call the API in :ref:`Creating a Training Job ` to create a training job named **jobtest_TF** based on the TensorFlow framework. - - a. Request body: - - URI format: POST https://**{ma_endpoint}**/v1/**{project_id}**/training-jobs - - Request header: - - - X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Content-Type →application/json - - Request body: - - .. code-block:: - - { - "job_name": "jobtest_TF", - "job_desc": "using TensorFlow for handwritten digit recognition", - "config": { - "worker_server_num": 1, - "parameter": [], - "flavor": { - "code": "modelarts.vm.cpu.8u" - }, - "train_url": "/test-modelarts/mnist-model/output/", - "engine_id": 4, - "app_url": "/test-modelarts/mnist-tensorflow-code/", - "boot_file_url": "/test-modelarts/mnist-tensorflow-code/train_mnist_tf.py", - "data_source": [ - { - "type": "obs", - "data_url": "/test-modelarts/dataset-mnist/" - } - ] - }, - "notification": { - "topic_urn": "", - "events": [] - }, - "workspace_id": "0" - } - - Set the italic fields in bold based on the site requirements. - - - Set **job_name** and **job_desc** to the name and description of the training job. - - Set **worker_server_num** and **code** to the values of **max_num** and **spec_code** obtained in :ref:`2 `. - - Set **engine_id** to the engine ID obtained in :ref:`3 `. - - Set **train_url** to the output directory of the training job. - - Set **app_url** and **boot_file_url** to the code directory and code boot file of the training job, respectively. - - Set **data_url** to the dataset directory used by the training job. - - b. The status code **200 OK** is returned, indicating that the training job has been created. The response body is as follows: - - .. code-block:: - - { - "version_name": "V0001", - "job_name": "jobtest_TF", - "create_time": 1609121837000, - "job_id": 567524, - "resource_id": "jobaedef089", - "version_id": 1108482, - "is_success": true, - "status": 1 - } - - - Record the values of **job_id** (training job ID) and **version_id** (training job version ID) for future use. - - The value of **status** is **1**, indicating that the training job is being initialized. - -#. Call the API in :ref:`Querying the Details About a Training Job Version ` to query the details about the training job based on the job ID. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/training-jobs/**567524**/versions/**1108482** - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - - Replace *567524* with the value of **job_id** recorded in :ref:`4 `. - - Replace *1108482* with the value of **version_id** recorded in :ref:`4 `. - - b. The status code **200 OK** is returned. The response body is as follows: - - .. code-block:: - - { - "dataset_name": null, - "duration": 1326, - "spec_code": "modelarts.vm.cpu.8u", - "parameter": [], - "start_time": 1609121913000, - "model_outputs": [], - "engine_name": "TensorFlow", - "error_result": null, - "gpu_type": "", - "user_frame_image": null, - "gpu": null, - "dataset_id": null, - "nas_mount_path": null, - "task_summary": {}, - "max_num": 1, - "model_metric_list": "{}", - "is_zombie": null, - "flavor_code": "modelarts.vm.cpu.8u", - "gpu_num": 0, - "train_url": "/test-modelarts/mnist-model/output/", - "engine_type": 1, - "job_name": "jobtest_TF", - "nas_type": "efs", - "outputs": null, - "job_id": 567524, - "data_url": "/test-modelarts/dataset-mnist/", - "log_url": null, - "boot_file_url": "/test-modelarts/mnist-tensorflow-code/train_mnist_tf.py", - "volumes": null, - "dataset_version_id": null, - "algorithm_id": null, - "worker_server_num": 1, - "pool_type": "SYSTEM_DEFINED", - "autosearch_config": null, - "job_desc": "using TensorFlow for handwritten digit recognition", - "inputs": null, - "model_id": null, - "dataset_version_name": null, - "pool_name": "hec-train-pub-cpu", - "engine_version": "TF-1.8.0-python3.6", - "system_metric_list": { - "recvBytesRate": [ - "0", - "0" - ], - "cpuUsage": [ - "0", - "0" - ], - "sendBytesRate": [ - "0", - "0" - ], - "memUsage": [ - "0", - "0" - ], - "gpuUtil": [ - "0", - "0" - ], - "gpuMemUsage": [ - "0", - "0" - ], - "interval": 1, - "diskWriteRate": [ - "0", - "0" - ], - "diskReadRate": [ - "0", - "0" - ] - }, - "retrain_model_id": null, - "version_name": "V0001", - "pod_version": "1.8.0-cp36", - "engine_id": 4, - "status": 10, - "cpu": "32", - "user_image_url": null, - "spec_id": 27, - "is_success": true, - "storage": "", - "nas_share_addr": null, - "version_id": 1108482, - "no_resource": false, - "user_command": null, - "resource_id": "jobaedef089", - "core": "8", - "npu_info": null, - "app_url": "/test-modelarts/mnist-tensorflow-code/", - "data_source": [ - { - "type": "obs", - "data_url": "/test-modelarts/dataset-mnist/" - } - ], - "pre_version_id": null, - "create_time": 1609121837000, - "job_type": 1, - "pool_id": "pool7d1e384a" - } - - You can learn about the version details of the training job based on the response. The value of **status** is **10**, indicating that the training job is successful. - -#. .. _modelarts_03_0401__en-us_topic_0000001073831232_li52217241518: - - Call the API in :ref:`Obtaining the Name of a Training Job Log File ` to obtain the name of the training job log file. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/training-jobs/**567524**/versions/**1108482**/log/file-names - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - b. The status code **200 OK** is returned. The response body is as follows: - - .. code-block:: - - { - "is_success": true, - "log_file_list": [ - "job-jobtest-tf.0" - ] - } - - Only one log file named **job-jobtest-tf.0** exists. - -#. Call the API in :ref:`Querying Training Job Logs ` to query details about eight rows in the training job log file. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/training-jobs/**567524**/versions/**1108482**/aom-log?log_file=\ **job-jobtest-tf.0**\ &lines=\ **8**\ &order=\ **desc** - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - - Set **log_file** to the name of the log file obtained in :ref:`6 `. - - Set **lines** to the rows to be obtained in the log file. - - Set **order** to the log query direction. - - b. The status code **200 OK** is returned. The response body is as follows: - - .. code-block:: - - { - "start_line": "1609121886518240330", - "lines": 8, - "is_success": true, - "end_line": "1609121900042593083", - "content": "Done exporting!\n\n[Modelarts Service Log]Training completed.\n\n[ModelArts Service Log]modelarts-pipe: will create log file /tmp/log/jobtest_TF.log\n\n[ModelArts Service Log]modelarts-pipe: will create log file /tmp/log/jobtest_TF.log\n\n[ModelArts Service Log]modelarts-pipe: will write log file /tmp/log/jobtest_TF.log\n\n[ModelArts Service Log]modelarts-pipe: param for max log length: 1073741824\n\n[ModelArts Service Log]modelarts-pipe: param for whether exit on overflow: 0\n\n[ModelArts Service Log]modelarts-pipe: total length: 23303\n" - } - -#. Call the API in :ref:`Deleting a Training Job ` to delete the training job if it is no longer needed. - - a. Request body: - - URI format: GET https://**{ma_endpoint}**/v1/**{project_id}**/training-jobs/**567524** - - Request header: X-auth-Token →\ **MIIZmgYJKoZIhvcNAQcCoIIZizCCGYcCAQExDTALBglghkgBZQMEAgEwgXXXXXX...** - - Set the italic fields in bold based on the site requirements. - - b. The status code **200 OK** is returned, indicating that the job has been deleted. The response is as follows: - - .. code-block:: - - { - "is_success": true - } diff --git a/modelarts/api-ref/result/application_cases/index.rst b/modelarts/api-ref/result/application_cases/index.rst deleted file mode 100644 index 89a5e71e..00000000 --- a/modelarts/api-ref/result/application_cases/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_03_0400: - -================= -Application Cases -================= - -.. toctree:: - :maxdepth: 1 - - creating_a_training_job_using_the_tensorflow_framework diff --git a/modelarts/api-ref/result/authorization_management/configuring_authorization.rst b/modelarts/api-ref/result/authorization_management/configuring_authorization.rst deleted file mode 100644 index 03d81408..00000000 --- a/modelarts/api-ref/result/authorization_management/configuring_authorization.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _CreateAuthorization: - -Configuring Authorization -========================= - -Function --------- - -This API is used to configure ModelArts authorization. ModelArts functions such as training management, development environment, data management, and real-time services can be properly used only after required permissions are assigned. The administrator can use this API to set an agency for IAM users and set the access key of the current user. - -URI ---- - -POST /v2/{project_id}/authorizations - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+====================================================================================================================================================+ - | user_id | No | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID `. | - | | | | | - | | | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. | - | | | | | - | | | | This parameter is mandatory only if the authorization type is set to **agency**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Authorization type. **Agency** is recommended. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **agency**: authorization through an agency | - | | | | | - | | | | - **credential**: authorization through an access Key (AK/SK) | - | | | | | - | | | | Default: **agency** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | content | Yes | String | Authorization content. | - | | | | | - | | | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. | - | | | | | - | | | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | secret_key | No | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Upload authorization. - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/authorizations - - { - "user_id" : "****d80fb058844ae8b82aa66d9fe****", - "type" : "agency", - "content" : "modelarts_agency" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "result" : "true" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/authorization_management/creating_a_modelarts_agency.rst b/modelarts/api-ref/result/authorization_management/creating_a_modelarts_agency.rst deleted file mode 100644 index d706d457..00000000 --- a/modelarts/api-ref/result/authorization_management/creating_a_modelarts_agency.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _CreateModelArtsAgency: - -Creating a ModelArts Agency -=========================== - -Function --------- - -This API is used to create an agency so that ModelArts can access dependent services such as OBS, SWR, and IEF. - -URI ---- - -POST /v2/{project_id}/agency - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+============================================================================================================================+ - | agency_name_suffix | No | String | Agency name suffix. | - | | | | | - | | | | The parameter contains a maximum of 50 characters. | - | | | | | - | | | | The agency name prefix is consistently to be **ma_agency**. | - | | | | | - | | | | For example, if the value of this parameter is **iam-user01**, the name of the created agency is **ma_agency_iam-user01**. | - | | | | | - | | | | The value of this parameter is left blank by default, indicating that an agency named **modelarts_agency** is created. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Create a ModelArts agency. - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/agency - - { - "agency_name_suffix" : "iam-user01" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "agency_name" : "ma_agency_iam-user01" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/authorization_management/deleting_authorization.rst b/modelarts/api-ref/result/authorization_management/deleting_authorization.rst deleted file mode 100644 index caed8d81..00000000 --- a/modelarts/api-ref/result/authorization_management/deleting_authorization.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _DeleteAuthorizations: - -Deleting Authorization -====================== - -Function --------- - -This API is used to delete the authorization of a specified user or all users. - -URI ---- - -DELETE /v2/{project_id}/authorizations - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===================================================================================================+ - | user_id | No | String | User ID. If this parameter is set to **all**, the authorization of all IAM users will be deleted. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Delete the authorization of a specified user. - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/authorizations?user_id=****d80fb058844ae8b82aa66d9fe**** - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "result" : "true" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/authorization_management/index.rst b/modelarts/api-ref/result/authorization_management/index.rst deleted file mode 100644 index 28e91579..00000000 --- a/modelarts/api-ref/result/authorization_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _authorization: - -======================== -Authorization Management -======================== - -.. toctree:: - :maxdepth: 1 - - configuring_authorization - viewing_an_authorization_list - deleting_authorization - creating_a_modelarts_agency diff --git a/modelarts/api-ref/result/authorization_management/viewing_an_authorization_list.rst b/modelarts/api-ref/result/authorization_management/viewing_an_authorization_list.rst deleted file mode 100644 index 56b85f73..00000000 --- a/modelarts/api-ref/result/authorization_management/viewing_an_authorization_list.rst +++ /dev/null @@ -1,155 +0,0 @@ -.. _GetAuthorizations: - -Viewing an Authorization List -============================= - -Function --------- - -This API is used to view an authorization list. - -URI ---- - -GET /v2/{project_id}/authorizations - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain a project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================+ - | sort_by | No | String | Sorting field. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **user_name**: IAM user | - | | | | | - | | | | - **create_time**: creation time | - | | | | | - | | | | Default: **user_name** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ - | order | No | String | Sorting method. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order | - | | | | | - | | | | Default: **asc** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. Default value: **1000** | - | | | | | - | | | | The value ranges from 1 to 1000. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-------------+---------------------------------------------------------------------------------------------------+---------------------------------+ - | Parameter | Type | Description | - +=============+===================================================================================================+=================================+ - | total_count | Number | Authorization information. | - +-------------+---------------------------------------------------------------------------------------------------+---------------------------------+ - | auth | Array of :ref:`AuthorizationResponse ` objects | Authorization information list. | - +-------------+---------------------------------------------------------------------------------------------------+---------------------------------+ - -.. _getauthorizations__response_authorizationresponse: - -.. table:: **Table 4** AuthorizationResponse - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+====================================================================================================================================================+ - | user_id | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID `. | - | | | | - | | | If **user_id** is set to **all**, all IAM users are authorized. If some IAM users have been authorized, the authorization setting will be updated. | - | | | | - | | | This parameter is mandatory only if the authorization type is set to **agency**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Authorization type. **Agency** is recommended. | - | | | | - | | | Options: | - | | | | - | | | - **agency**: authorization through an agency | - | | | | - | | | - **credential**: authorization through an access Key (AK/SK) | - | | | | - | | | Default: **agency** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | content | String | Authorization content. | - | | | | - | | | - If **Authorization Type** is set to **Agency**, this field indicates the agency name. | - | | | | - | | | - If **Authorization Type** is set to **AK/SK**, this field indicates the access key ID (AK). | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | secret_key | String | Secret Access Key (SK). This field is required only when **Authorization Method** is set to **AK/SK**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Timestamp when the quality job was created. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -View an authorization list. - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/authorizations - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_count" : 1, - "auth" : [ { - "user_id" : "****d80fb058844ae8b82aa66d9fe****", - "user_name" : "iam-user01", - "type" : "agency", - "content" : "modelarts_agency", - "create_time" : 15657747821288 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -400 Bad Request -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/before_you_start/api_calling.rst b/modelarts/api-ref/result/before_you_start/api_calling.rst deleted file mode 100644 index bfef0b57..00000000 --- a/modelarts/api-ref/result/before_you_start/api_calling.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_03_0140: - -API Calling -=========== - -ModelArts supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see :ref:`Calling APIs `. diff --git a/modelarts/api-ref/result/before_you_start/basic_concepts.rst b/modelarts/api-ref/result/before_you_start/basic_concepts.rst deleted file mode 100644 index 0cbb8c7c..00000000 --- a/modelarts/api-ref/result/before_you_start/basic_concepts.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _modelarts_03_0143: - -Basic Concepts -============== - -- Account - - An account is created upon successful registration with the cloud platform. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. - -- Region - - A region is a physical location where a cloud service is deployed. Availability zones (AZ) in the same region can communicate with each other over an intranet but AZs in different regions cannot communicate with each other. By creating cloud resources in different regions, you can design applications to better meet customer requirements and comply with local laws and regulations. - -- AZ - - An AZ contains one or more physical data centers. It has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow users to build cross-AZ high-availability systems. - -- Project - - Projects group and isolate compute, storage, and network resources across physical regions. A default project is provided for each region, and subprojects can be created under each default project. Users can be granted permissions to access all resources in a specific project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects. - - .. _modelarts_03_0143__en-us_topic_0171316292_en-us_topic_0170640577_en-us_topic_0169294976_fig1189614168311: - - .. figure:: /_static/images/en-us_image_0171392261.gif - :alt: **Figure 1** Project isolation model - - - **Figure 1** Project isolation model diff --git a/modelarts/api-ref/result/before_you_start/endpoints.rst b/modelarts/api-ref/result/before_you_start/endpoints.rst deleted file mode 100644 index 39770524..00000000 --- a/modelarts/api-ref/result/before_you_start/endpoints.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _modelarts_03_0141: - -Endpoints -========= - -Endpoints are **request address** for calling APIs. Endpoints vary depending on services and regions. To obtain the regions and endpoints, contact the enterprise administrator. - -A service endpoint consists of the service name, region ID, and external domain name in the format of "{service_name}.{region_id}.{external_domain_name}". For details about how to obtain each parameter, see :ref:`Table 1 `. - -.. _modelarts_03_0141__en-us_topic_0000001072357044_table8700253831: - -.. table:: **Table 1** Obtaining an endpoint - - +----------------------+-------------------------------------------------+------------------------------------------+ - | Parameter | Description | How to Obtain | - +======================+=================================================+==========================================+ - | service_name | Abbreviation of a case-insensitive service name | **modelarts** for ModelArts by default. | - +----------------------+-------------------------------------------------+------------------------------------------+ - | region_id | Region ID | Obtain the value from the administrator. | - +----------------------+-------------------------------------------------+------------------------------------------+ - | external_domain_name | External domain name suffix | Obtain the value from the administrator. | - +----------------------+-------------------------------------------------+------------------------------------------+ - -.. important:: - - If an endpoint uses a domain name, configure the hosts file in the format of "{float-ip} {service_name}.{region_id}.{external_domain_name}" on the local PC. Obtain **float-ip** from the administrator. diff --git a/modelarts/api-ref/result/before_you_start/index.rst b/modelarts/api-ref/result/before_you_start/index.rst deleted file mode 100644 index 803dfb99..00000000 --- a/modelarts/api-ref/result/before_you_start/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_03_0139: - -================ -Before You Start -================ - -.. toctree:: - :maxdepth: 1 - - overview - api_calling - endpoints - basic_concepts diff --git a/modelarts/api-ref/result/before_you_start/overview.rst b/modelarts/api-ref/result/before_you_start/overview.rst deleted file mode 100644 index 6e5cf4f4..00000000 --- a/modelarts/api-ref/result/before_you_start/overview.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_03_0001: - -Overview -======== - -ModelArts is a one-stop AI development platform geared toward developers and data scientists of all skill levels. It enables you to rapidly build, train, and deploy models anywhere (from the cloud to the edge), and manage full-lifecycle AI workflows. ModelArts accelerates AI development and fosters AI innovation with key capabilities, including data preprocessing and auto labeling, distributed training, automated model building, and one-click workflow execution. You can use ModelArts through open APIs. For details about all ModelArts APIs, see :ref:`API Overview `. diff --git a/modelarts/api-ref/result/calling_apis/authentication.rst b/modelarts/api-ref/result/calling_apis/authentication.rst deleted file mode 100644 index 47e2f161..00000000 --- a/modelarts/api-ref/result/calling_apis/authentication.rst +++ /dev/null @@ -1,197 +0,0 @@ -.. _modelarts_03_0004: - -Authentication -============== - -Requests for calling an API can be authenticated using either of the following methods: AK/SK-based authentication: Requests are authenticated by encrypting the request body using an AK/SK pair. - -- Token-based authentication: Requests are authenticated using a token. -- AK/SK authentication: Requests are encrypted using the access key ID (AK) and secret access key (SK). - -Token-based Authentication --------------------------- - -.. note:: - - The validity period of a token is 24 hours. When using a token for authentication, cache it to prevent frequently calling the IAM API used to obtain a user token. - -A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API. - -In :ref:`Making an API Request `, the process of calling the API used to obtain a user token is described. - -.. code-block:: - - { - "auth": { - "identity": { - "methods": [ - "password" - ], - "password": { - "user": { - "name": "user_name", - "password": "user_password", - "domain": { - "name": "domain_name" - } - } - } - }, - "scope": { - "project": { - "name": "project_name" - } - } - } - } - -After a token is obtained, the **X-Auth-Token** header field must be added to requests to specify the token when calling other APIs. For example, if the token is **ABCDEFJ....**, **X-Auth-Token: ABCDEFJ....** can be added to a request as follows: - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/services - Content-Type: application/json - X-Auth-Token: ABCDEFJ.... - -AK/SK-based Authentication --------------------------- - -An AK/SK is used to verify the identity of a request sender. In AK/SK-based authentication, a signature needs to be obtained and then added to requests. - -.. note:: - - AK: access key ID, which is a unique identifier used in conjunction with a secret access key to sign requests cryptographically. - - SK: secret access key used in conjunction with an AK to sign requests cryptographically. It identifies a request sender and prevents the request from being modified. - -The following uses a demo project to show how to sign a request and use an HTTP client to send an HTTPS request. - -Download the demo project at https://github.com/api-gate-way/SdkDemo. - -If you do not need the demo project, visit the following URL to download the API Gateway signing SDK: - -Obtain the API Gateway signing SDK from the enterprise administrator. - -Decompress the downloaded package and reference the obtained JAR files as dependencies, as highlighted in the following figure. - -|image1| - -#. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be **credentials.csv**.) - - a. Log in to ManageOne Operation Portal. - b. In the upper right corner of the page, click your account avatar and choose **My Settings** from the drop-down list. - c. On the **My Settings** page, the **Project List** tab page is displayed by default. Click the **Manage Access Key** tab page. - d. Click **Add Access Key** to create an AK/SK pair. - e. Click **OK**. The certificate is automatically downloaded. - f. After the certificate is downloaded, obtain the AK and SK information from the **credentials** file. - - .. important:: - - - Only two access keys can be added for each user. - - To ensure access key security, access keys are automatically downloaded only when they are generated for the first time and cannot be obtained from the management console later. Keep them properly. - -#. Download and decompress the demo project. - -#. .. _modelarts_03_0004__en-us_topic_0129435566_li94791126103617: - - Import the demo project to Eclipse. - - .. _modelarts_03_0004__en-us_topic_0129435566_fig10881944183710: - - .. figure:: /_static/images/en-us_image_0150917346.gif - :alt: **Figure 1** Selecting Existing Projects into Workspace - - - **Figure 1** Selecting Existing Projects into Workspace - - .. _modelarts_03_0004__en-us_topic_0129435566_fig15961458113717: - - .. figure:: /_static/images/en-us_image_0150917350.gif - :alt: **Figure 2** Selecting the demo project - - - **Figure 2** Selecting the demo project - - .. _modelarts_03_0004__en-us_topic_0129435566_fig74501929113815: - - .. figure:: /_static/images/en-us_image_0150917353.gif - :alt: **Figure 3** Structure of the demo project - - - **Figure 3** Structure of the demo project - -#. Sign the request. - - The request signing method is integrated in the JAR files imported in :ref:`3 `. The request needs to be signed before it is sent. The signature will then be added as part of the HTTP header to the request. - - The demo code is classified into the following classes to demonstrate signing and sending the HTTP request: - - - **AccessService**: abstract class that merges the GET, POST, PUT, and DELETE methods into the **access** method - - **Demo**: execution entry used to simulate the sending of GET, POST, PUT, and DELETE requests - - **AccessServiceImpl**: implementation of the **access** method, which contains the code required for communication with API Gateway - - The following describes how to call a POST method to sign the request. - - a. (Optional) Add request header fields. - - Uncomment the following code snippet in the **AccessServiceImpl.java** file, and specify the project ID and account ID. - - .. code-block:: - - //TODO: Add special headers. - //request.addHeader("X-Project-Id", "xxxxx"); - //request.addHeader("X-Domain-Id", "xxxxx"); - - b. Edit the **main()** method in the Demo.java file, and replace the bold text with actual values. - - As shown in the following code, if you use other methods such as POST, PUT, and DELETE, see the corresponding comment. Replace the values of **region**, **serviceName**, **ak**, **sk**, and **url**. The URL for obtaining the VPC is used in the sample project. Replace it with the actual URL. Contact the administrator to obtain the endpoint. - - .. code-block:: - - //TODO: Replace the value of region with the actual region where the service to be accessed is located. - private static final String region = ""; - - //TODO: Replace vpc with the name of the service you want to access. For example, ecs, vpc, iam, and elb. - private static final String serviceName = ""; - - public static void main(String[] args) throws UnsupportedEncodingException - { - //TODO: Replace the values of ak and sk with the AK/SK obtained on the My Credentials page. - String ak = "ZIRRKMTWP******1WKNKB"; - String sk = "Us0mdMNHk******YrRCnW0ecfzl"; - - //TODO: To specify a project ID (multi-project scenarios), add the X-Project-Id header. - //TODO: To access a global service, such as IAM, DNS, CDN, and TMS, add the X-Domain-Id header to specify an account ID. - //TODO: To add a header, find "Add special headers" in the AccessServiceImple.java file. - - //TODO: Test the API. - String url = "https://{Endpoint}/v1/{project_id}/vpcs"; - get(ak, sk, url); - - //TODO: When creating a VPC, replace {project_id} in postUrl with the actual value. - //String postUrl = "https://serviceEndpoint/v1/{project_id}/cloudservers"; - //String postbody ="{\"vpc\": {\"name\": \"vpc\",\"cidr\": \"192.168.0.0/16\"}}"; - //post(ak, sk, postUrl, postbody); - - //TODO: When querying a VPC, replace {project_id} in url with the actual value. - //String url = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; - //get(ak, sk, url); - - //TODO: When updating a VPC, replace {project_id} and {vpc_id} in putUrl with the actual values. - //String putUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; - //String putbody ="{\"vpc\":{\"name\": \"vpc1\",\"cidr\": \"192.168.0.0/16\"}}"; - //put(ak, sk, putUrl, putbody); - - //TODO: When deleting a VPC, replace {project_id} and {vpc_id} in deleteUrl with the actual values. - //String deleteUrl = "https://serviceEndpoint/v1/{project_id}/vpcs/{vpc_id}"; - //delete(ak, sk, deleteUrl); - } - - c. Compile the code and call the API. - - In the **Package Explorer** area on the left, right-click **Demo.java** and choose **Run AS** > **Java Application** from the shortcut menu to run the demo code. - - You can view the API call logs on the console. - -.. |image1| image:: /_static/images/en-us_image_0150916848.gif - diff --git a/modelarts/api-ref/result/calling_apis/index.rst b/modelarts/api-ref/result/calling_apis/index.rst deleted file mode 100644 index ce98ee42..00000000 --- a/modelarts/api-ref/result/calling_apis/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_03_0144: - -============ -Calling APIs -============ - -.. toctree:: - :maxdepth: 1 - - making_an_api_request - authentication - response diff --git a/modelarts/api-ref/result/calling_apis/making_an_api_request.rst b/modelarts/api-ref/result/calling_apis/making_an_api_request.rst deleted file mode 100644 index 1d0438d7..00000000 --- a/modelarts/api-ref/result/calling_apis/making_an_api_request.rst +++ /dev/null @@ -1,163 +0,0 @@ -.. _modelarts_03_0005: - -Making an API Request -===================== - -This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained token can then be used to authenticate the calling of other APIs. - -.. _modelarts_03_0005__en-us_topic_0129435569_en-us_topic_0170917207_en-us_topic_0168405763_section1849899574: - -Request URI ------------ - -The format of a request URI is as follows: - -**{URI-scheme} :// {Endpoint} / {resource-path} ? {query-string}** - -.. table:: **Table 1** Request URI - - +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===============+=====================================================================================================================================================================================================================================================================+ - | URI-scheme | Protocol used to transmit requests. All APIs use HTTPS. | - +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Endpoint | Domain name or IP address of the server for the REST service endpoint. The endpoint varies depending on services in different regions. It can be obtained in :ref:`Endpoints `. | - +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource-path | Access path of an API for performing a specified operation. Obtain the path from the URI of an API. For example, the **resource-path** of the API used to obtain a user token is **/v3/auth/tokens**. | - +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query-string | Query parameter, which is optional. Ensure that a question mark (?) is included before each query parameter that is in the format of "*Parameter name=Parameter value*". For example, **? limit=10** indicates that a maximum of 10 data records will be displayed. | - +---------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -For example, to obtain an IAM token in a region, obtain the endpoint of IAM for this region and the **resource-path** (**/v3/auth/tokens**) in the URI of the API used to obtain a user token. Then, construct the URI as follows: - -.. code-block:: - - https://{iam-endpoint}/v3/auth/tokens - -.. note:: - - To simplify the URI display in this document, each API is provided only with a **resource-path** and a request method. The **URI-scheme** of all APIs is **HTTPS**, and the endpoints of all APIs in the same region are identical. - -Request Methods ---------------- - -The HTTP protocol defines the following request methods that can be used to send a request to the server: - -.. table:: **Table 2** HTTP methods - - +-----------------------------------+----------------------------------------------------------------------------+ - | Method | Description | - +===================================+============================================================================+ - | GET | Requests the server to return specified resources. | - +-----------------------------------+----------------------------------------------------------------------------+ - | PUT | Requests the server to update specified resources. | - +-----------------------------------+----------------------------------------------------------------------------+ - | POST | Requests the server to add resources or perform special operations. | - +-----------------------------------+----------------------------------------------------------------------------+ - | DELETE | Requests the server to delete specified resources, for example, an object. | - +-----------------------------------+----------------------------------------------------------------------------+ - | HEAD | Same as GET except that the server must return only the response header. | - +-----------------------------------+----------------------------------------------------------------------------+ - | PATCH | Requests the server to update partial content of a specified resource. | - | | | - | | If the resource does not exist, a new resource will be created. | - +-----------------------------------+----------------------------------------------------------------------------+ - -For example, in the case of the API used to obtain a user token, the request method is POST. The request is as follows: - -.. code-block:: - - POST https://{iam-endpoint}/v3/auth/tokens - -Request Header --------------- - -You can also add additional header fields to a request, such as the fields required by a specified URI or HTTP method. For example, to request for the authentication information, add **Content-Type**, which specifies the request body type. - -:ref:`Table 3 ` describes the common request header fields to be added to the request. - -.. _modelarts_03_0005__en-us_topic_0129435569_table139019272562: - -.. table:: **Table 3** Common request header fields - - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Header | Description | Mandatory | Example | - +=================+=====================================================================================================================================+=======================================================================================+===================================================================================================================================================================================================+ - | Content-type | Request body type or format. The default value is **application/json**. | Yes | application/json | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Content-Length | Length of the request body. The unit is byte. | Mandatory for POST and PUT requests but must be left blank for GET requests | 3495 | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | X-Project-Id | Project ID. This parameter is used to obtain the token for each project. | No | e9993fc787d94b6c886cbaa340f9c0f4 | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | X-Auth-Token | User token. It is a response to the API used to obtain a user token. This API is the only one that does not require authentication. | Mandatory for token-based authentication | None | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | X-Sdk-Date | Time when the request is sent. The time is in *YYYYMMDD*\ **'T'**\ *HHMMSS*\ **'Z'** format. | Mandatory for AK/SK-based authentication, optional for PKI token-based authentication | 20190307T101459Z | - | | | | | - | | The value is the current Greenwich Mean Time (GMT) time of the system. | | | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Authorization | Authentication information. | Mandatory for AK/SK-based authentication | SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994 | - | | | | | - | | The value is obtained from the request signature result and is required when the AK/SK are used to encrypt the signature. | | | - | | | | | - | | Type: string | | | - | | | | | - | | Default value: none | | | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Host | Information about the requested server. The value can be obtained from the URL of the service API. | Mandatory for AK/SK-based authentication | code.test.com | - | | | | | - | | This value is *host name*\ [:*port number*]. | | or | - | | | | | - | | If the port number is not specified, the default port is used. The default port number for **https** is **443**. | | code.test.com:443 | - +-----------------+-------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. note:: - - In addition to supporting authentication using tokens, APIs support authentication using AK/SK, which uses SDK to sign a request. During the signature, the **Authorization** (signature authentication) and **X-Sdk-Date** (time when a request is sent) headers are automatically added to the request. - -The API for obtaining a user token does not require authentication. Therefore, this API only requires adding the **Content-Type** field. The request with the added **Content-Type** header is as follows: - -.. code-block:: - - POST https://{iam-endpoint}/v3/auth/tokens - Content-Type: application/json - -Request Body ------------- - -The body of a request is often sent in a structured format as specified in the Content-Type header field. The request body transfers content except the request header. If the request body contains Chinese characters, these characters must be encoded in UTF-8. - -The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods. - -If an API is used to obtain a user token, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *user_name*, *domain_name*, and *user_password* with the actual username, account name, and login password, respectively. **project_name** is the project name. For details, see :ref:`Obtaining a Username `, :ref:`Obtaining an Account Name and ID `, and :ref:`Obtaining a Project Name `. - -.. note:: - - The **scope** parameter specifies where a token takes effect. In the example, the token takes effect only for the resources in a specified project. ModelArts uses a region-specific endpoint to call this API. Set **scope** to **project**. You can set **scope** to an account or a project under an account. In the following example, the token takes effect only for the resources in a specified project. For more information about this API, see "Obtaining a User Token". - -.. code-block:: - - POST https://{iam-endpoint}/v3/auth/tokens - Content-Type:application/json - { - "auth": { - "identity": { - "methods": ["password"], - "password": { - "user": { - "name": "Username", - "password": "User password", - "domain": { - "name": "Domain name" - } - } - } - }, - "scope": { - "project": { - "name": "Project name" - } - } - } - } - -If all data required for the API request is available, you can send the request to call the API through `curl `__, `Postman `__, or coding. In the response to the API used to obtain a user token, **x-subject-token** is the desired user token. This token can then be used to authenticate the calling of other APIs. diff --git a/modelarts/api-ref/result/calling_apis/response.rst b/modelarts/api-ref/result/calling_apis/response.rst deleted file mode 100644 index cb783aaf..00000000 --- a/modelarts/api-ref/result/calling_apis/response.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. _modelarts_03_0003: - -Response -======== - -After sending a request, you will receive a response, including the status code, response header, and response body. - -Status Code ------------ - -A status code is a group of digits, ranging from 1\ *xx* to 5\ *xx*. It indicates the status of a request. For more information, see :ref:`Status Code `. - -For example, if status code **201** is returned for calling the API used to obtain a user token, the request is successful. - -Response Header ---------------- - -Similar to a request, a response also has a header, for example, **Content-type**. - -.. table:: **Table 1** Common response header fields - - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | Header | Description | Mandatory | - +=======================+================================================================================================================================================================================================================================+=======================+ - | Content-Type | Media type of the message body sent to a receiver | Yes | - | | | | - | | Type: string | | - | | | | - | | Default value: **application/json; charset=UTF-8** | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | X-request-id | This field carries the request ID for task tracing. | No | - | | | | - | | Type: string **request_id-timestamp-hostname** (**request_id** is the UUID generated on the server, **timestamp** indicates the current timestamp, and **hostname** is the name of the server that processes the current API.) | | - | | | | - | | Default value: none | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | X-ratelimit | This field carries the total number of flow control requests. | No | - | | | | - | | Type: integer | | - | | | | - | | Default value: none | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | X-ratelimit-used | This field carries the number of remaining requests. | No | - | | | | - | | Type: integer | | - | | | | - | | Default value: none | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - | X-ratelimit-window | This field carries the flow control unit. | No | - | | | | - | | Type: string The unit is minute, hour, or day. | | - | | | | - | | Default value: hour | | - +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------+ - -:ref:`Figure 1 ` shows the response header fields for the API used to obtain a user token. - -**x-subject-token** is the desired user token. This token can then be used to authenticate the calling of other APIs. - -.. _modelarts_03_0003__en-us_topic_0171310283_en-us_topic_0170917209_en-us_topic_0168405765_fig4865141011511: - -.. figure:: /_static/images/en-us_image_0171113090.png - :alt: **Figure 1** Header fields of the response to the request for obtaining a user token - - - **Figure 1** Header fields of the response to the request for obtaining a user token - -Response Body -------------- - -The body of a response is often returned in structured format as specified in the **Content-Type** header field. The response body transfers content except the response header. - -The following is part of the response body for the API used to obtain a user token. - -.. code-block:: - - { - "token": { - "expires_at": "2019-02-13T06:52:13.855000Z", - "methods": [ - "password" - ], - "catalog": [ - { - "endpoints": [ - { - "region_id": "aaa", - ...... - -If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body. - -.. code-block:: - - { - "error_message": "The format of message is error", - "error_code": "AS.0001" - } - -In the error response body, **error_code** is an error code, and **error_message** provides information about the error. For more details, see :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/change_history.rst b/modelarts/api-ref/result/change_history.rst deleted file mode 100644 index 670b4895..00000000 --- a/modelarts/api-ref/result/change_history.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_03_0097: - -Change History -============== - -=========== =================================== -Released On Description -=========== =================================== -2021-04-30 This is the first official release. -=========== =================================== diff --git a/modelarts/api-ref/result/common_parameters/error_codes.rst b/modelarts/api-ref/result/common_parameters/error_codes.rst deleted file mode 100644 index 54143be0..00000000 --- a/modelarts/api-ref/result/common_parameters/error_codes.rst +++ /dev/null @@ -1,1136 +0,0 @@ -.. _modelarts_03_0095: - -Error Codes -=========== - -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Status Code | Error Codes | Error Message | Description | Solution | -+=============+================+===========================================================================================================================================================+===============================================================================================================================================================+======================================================================================================================================================================================================================+ -| 400 | ModelArts.0104 | Parameter error. | Parameter error. | Check the parameter settings. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0113 | Create Notebook failed. Quota: {} is exhausted. | Failed to create the notebook instance due to the exhausted quota. | Contact the administrator for a higher quota. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6301 | The instance already exists. | The instance already exists. | Enter another instance name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6302 | The instance count already reaches the maximum value. | The maximum number of instances has been reached. | Delete unnecessary instances. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6303 | The field does not support sorting. | This field does not support sorting. | Delete the field from the sorting parameters. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6304 | Please stop the instance before deleting. | Failed to delete the instance in the running state. | Refresh the page. Stop the instance and then delete it. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6305 | The instance is already running. | The instance is in the running state. | Do not start it again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6306 | The instance is starting. | Other operations cannot be performed because the instance is being started. | Perform other operations later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6307 | The instance has already been stopped. | The instance has been stopped. | Refresh the page and view the instance state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6308 | The instance is stopping. | The instance is being stopped. | Refresh the page and view the instance state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6309 | The instance does not exist. | The instance does not exist. | Ensure that the instance has been deleted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6316 | The param 'storage' is needed for creating notebook instance. | Incorrect parameters during instance creation. | Add the storage parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6317 | The 'path' parameter is required when the storage type is OBS. | Incorrect parameters during instance creation. | Add the path parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6318 | The param 'path' needs to end with /. | Incorrect parameters during instance creation. | Ensure that the value of the path parameter ends with a slash (/). | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6319 | There is no ak/sk in the global settings. Please add it by access ModelArts console. | The AK/SK have not been configured in the global settings of ModelArts. | Configure the AK/SK in the global settings of ModelArts. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6320 | Access obs error. Reason is {}. | OBS access error. | Ensure that the OBS path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6323 | The flavor is not supported, please check it. | The flavor is not supported. | Ensure that the flavor is correctly configured. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6324 | This location type is not supported. Please check it. | The storage type is not supported. | Ensure that the storage type is correctly configured. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6326 | The instance is frozen. Check whether your account is in arrears in Billing Center. | The instance has been frozen. | Check the account balance and top up the account. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6327 | The instance is not in running. Please refresh the page and start it. | The instance is not in the running state. | Refresh the page and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6328 | Sorry, you currently do not have permission for this flavor. Please apply it firstly. | You do not have permission to use the flavor. | Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6329 | Sorry, this flavor specification is sold out. Please try others. | The flavor is sold out. | Use another flavor or try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6330 | The flavor type of profile does not match the type of flavor. Please check it. | The types are not matched. | Ensure that the flavor type matches the profile type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6331 | The evs volume size ranges from {} GB to {} GB. | The EVS disk size exceeds the upper limit. | Check the EVS disk size. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6332 | Incorrect parameter type. The '{}' parameter must be of the '{}' type. | Parameter type error. | Ensure that the parameter type meets the requirements. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6333 | The notebook is being restored. Refresh the page and wait for several minutes. The fault may be caused by instance overload. | Notebook instance fault. | The instance is recovering. Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6334 | Invalid value for name or description. The character \`{}\` is not allowed. | The description parameter is incorrect. | Enter a valid description value. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6335 | '{}' is a required property. | Parameter missing. | Ensure that the corresponding parameter is available. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6336 | '{}' property value is incorrect. | Incorrect parameter value. | Ensure that the corresponding parameter is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6341 | The repository does not exist or has been deleted. | The Git repository does not exist or has been deleted. | Check the corresponding parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6343 | The repository name already exists. | The Git repository already exists. | Check the corresponding parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6344 | Delete failed. Please delete the associated development environment instance first. | Failed to delete the repository. | Delete the corresponding notebook instance first. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6345 | Currently the OBS type instance does not support git capability. | The Git repository cannot be used for OBS instances. | Use notebook instances of the EVS type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6346 | The timestamp of auto stop must be later than the current timestamp. | This parameter cannot be modified. | Check the corresponding parameter and ensure that the automatic end time is later than the current time. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6347 | When the instance is in the '{}' status, the '{}' parameter cannot be modified. | Failed to modify the parameter. | Check the corresponding parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6348 | The 'duration' parameter is mandatory for enabling auto stop. | The description parameter is missing. | Configure the duration parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6349 | The 'duration' parameter is incorrect. The value ranges from {} to {}. | The value of duration parameter exceeds the threshold. | Configure the duration parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6350 | Failed to access OBS because of incorrect AK/SK or insufficient permissions. | Access to OBS is rejected. | Ensure that the AK/SK is correct and you have the permission to access OBS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6353 | Failed to verify the AK/SK. Please check and try again. | Incorrect AK/SK. | Ensure that the AK/SK in the global settings of ModelArts is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6354 | The AK/SK do not belong to the user. Please check and enter the correct ones. | Incorrect AK/SK. | Ensure that the AK/SK in the global settings of ModelArts is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6355 | The resource is initializing. Please wait one minute and try again. | Resources in the dedicated resource pool are being initialized. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6357 | The operation is not allowed because another operation is being performed on the instance or the instance is in the target state. | The operation is not allowed. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6358 | The path parameter is incorrect. It cannot be the root directory of an OBS bucket, but must be a specific directory in the OBS bucket. | The OBS path parameter is incorrect. | Ensure that the path parameter is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6361 | ModelArts internal service or configuration error. Submit a service ticket to get professional technical support. | Internal error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6371 | Currently, notebooks support only OBS buckets whose Storage Class is Standard. Change the OBS bucket and try again. | Notebook instances support only standard OBS buckets. | Use standard OBS buckets. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6374 | The credential can be added only when type is set to AK/SK or agency. | The authentication type can only be AK/SK or agency. | Ensure that the authentication type is AK/SK or agency. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6376 | Please make sure agency exists. | The IAM agency does not exist. | Ensure that the agency exists on IAM. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6377 | The user id cannot be left blank. | The user ID cannot be left blank. | Ensure that the user ID parameter is available. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6378 | The agency name cannot be left blank. | The agency name cannot be left blank. | Ensure that the agency name parameter is available. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6379 | No IAM agency created in Settings. Create an IAM agency on the ModelArts management console. | No agency is created in the global settings. | Create an agency in the global settings. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6528 | No EVS available. Please try again later. | The EVS disk has been sold out. | Try again later or contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.6201 | The user's account has been suspended. | The user account is frozen. | Check the account balance and top up the account. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.6203 | The user's account has been restricted. | The user account is restricted. | Check the account balance and top up the account. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.0112 | Policy doesn't allow {} {} to be performed. | The permission on the workspace is restricted. | Ensure that you have the permission on the workspace. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 408 | ModelArts.6100 | The request timed out. Please try again. | Timeout. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 429 | ModelArts.6101 | The system is busy now. Please try again later. | The system is busy. | The system is busy. Please try again. If the retry still fails, contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.6102 | The server has encountered an error and fails to process the request. Please try again later or submit a service ticket. | Internal error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.6200 | No resources available. Please try again later or submit a service ticket. | Internal error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6600 | Check whether the parameter is valid. | Failed to verify the parameters. | Ensure that the parameter is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6651 | Unsupport entity. | Unsupported project objects. | Ensure that the project object is supported. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6652 | Please delete resources from the project first. | Failed to delete the project resources. | Delete the datasets and notebook instances under the project and ensure that all training jobs have been completed. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.6690 | The image size cannot exceed 8 MB. | The image size exceeds 8 MB. | Ensure that the image size does not exceed 8 MB. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.6608 | Please refresh user info. | Failed to obtain the user information. | Refresh the user information. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.6620 | Please refresh the user token. | Invalid user token. | Refresh the user token. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.6653 | Contact the project owner. | You are not authorized to operate the project. | Contact the project owner to obtain the authorization. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.6623 | Ensure that the dataset already exists. | Failed to find the corresponding dataset. | Ensure that the dataset already exists. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.6624 | Ensure that the storage path already exists. | Failed to find the corresponding storage path. | Ensure that the storage path already exists. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.6650 | Ensure that the project already exists. | Failed to find the corresponding project. | Ensure that the project already exists. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.6655 | Can't find ai project template. | Failed to find the corresponding project template. | Ensure that the corresponding project template already exists. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 417 | ModelArts.6654 | Project with the same name already exists. | A project with the same name already exists. | Use another project name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.6691 | System error. Check the service status. | The algorithm service is abnormal. | System error. Check the service state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.6692 | System error. Check the service status. | The dataset service is abnormal. | System error. Check the service state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.6699 | Internal error. | Network error. | Check network connectivity. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4205 | A subdirectory must be specified as the dataset input or output path. | A subdirectory must be specified as the dataset input or output path. | A subdirectory must be specified as the dataset input or output path. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4311 | OBS bucket does not exist | The OBS bucket does not exist. | Ensure that the bucket name is correct and that the bucket name exists in OBS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4312 | OBS path does not exist | Incorrect or invalid bucket name. | Ensure that the bucket name is correct and that the bucket name exists in OBS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4313 | OBS path is invalid | Invalid characters in the OBS path. | Ensure that the OBS path consists of valid characters, including digits, letters, hyphens (-), underscores (_), slashes (/), and Chinese characters. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4314 | Obs error | OBS access error. | Ensure that you have the permission to access OBS and that the OBS path is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4338 | The resource not exists | The dataset ID or labeling task ID does not exist. | Ensure that the input dataset ID or labeling task ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4340 | Import path does not contain valid file | No valid file exists in the import path. | Ensure that the file in the OBS path is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4342 | Dataset publish with splitting annotated samples error | Incorrect splitting for labeled samples. | Ensure that the labeled samples and labels meet splitting criteria. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4343 | Dataset is publishing, the operation is forbidden | Do not switch, import, synchronize, or publish a dataset version because there is an ongoing publish task. | Perform the operations after the ongoing publish task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4344 | Dataset is being deleted, annotation is forbidden | No labeling task is allowed because the dataset is being deleted. | Ensure that the dataset ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4345 | File not found | The HDFS file does not exist. | Ensure that the OBS path is correct and that the file is available in the OBS path. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4347 | List files failed | Failed to obtain HDFS files. | Ensure that the OBS path is correct and that the files are available in the OBS path. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4349 | Dataset is switching version, the operation is forbidden | Do not switch, import, synchronize, or publish a dataset version because there is an ongoing version switching task. | Perform the operations after the ongoing version switching task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4350 | The work_path is too long, please select shorter folder | The value of work_path exceeded the limit. | Change the value of work_path to a valid one. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4351 | Dataset already exists | A dataset whose name is the value of dataset_name already exists. | Change the value of dataset_name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4352 | Dataset does not exist | The dataset ID does not exist. | Ensure that the imported dataset ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4353 | Dataset version does not exist | The dataset version ID does not exist. | Check dataset version parameters. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4355 | Sync data source task exist | A data synchronization task is being executed for the dataset. | Perform the operations after the ongoing data synchronization task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4356 | Dataset already has running import task | A data import task is being executed for the dataset. | Perform the operations after the ongoing data import task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4357 | Parse AI annotation result file name error | Failed to parse the labeling file name. | Ensure that the file name in the OBS auto labeling result path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4358 | Invalid export path | Invalid OBS export path. | Ensure that the export path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4359 | Export task does not exist | The export task ID does not exist. | Ensure that the export task ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4361 | Import AI annotation error | Failed to synchronize the auto labeling task result. | Ensure that the auto labeling task result is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4362 | Import data error | Failed to import data. | Ensure that the authentication information and the request parameters for creating an import task are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4364 | Dataset workPath subdir already exists | The work_path subdirectory already exists in the dataset directory. | Ensure that the subdirectory in the dataset directory is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4365 | Dataset labels not set | The label set of the dataset is empty. | Create labels for the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4368 | Parse pc bin file error | Failed to parse the point cloud binary file. | Ensure that the point cloud binary file is not damaged. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4369 | Parse pc prelabel json file error | Failed to parse the point cloud pre-labeling file. | Ensure that the point cloud pre-labeling file is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4370 | One dataset version can be released in a minute, please try again later | Frequent dataset version creation. | Do not frequently create dataset versions. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4371 | Dataset version already exists | The value of version_name is the same as an existing version. | Change the value of version_name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4372 | Valid image not found | No point cloud data image found. | Ensure that the point cloud data image is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4374 | Invalid path | Invalid OBS path. | Ensure that the OBS path is correct and that the file is available in the OBS path. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4375 | Parse pc obs image error | Failed to parse the point cloud data image in OBS. | Ensure that the point cloud data image is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4376 | Unsupported pc pcd format error | The PCD attribute is not supported. | Check the point cloud data in PCD format. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4377 | Pc pcd format error | Failed to parse the point cloud data in PCD format. | Ensure that the PCD file is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4378 | Parse pc pcd file error | Failed to parse the point cloud data in PCD format. | Ensure that the PCD file is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4379 | Unsupported pc file format error | The point cloud data format is not supported. | Ensure that the imported point cloud data is in BIN or PCD format. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4380 | Parse kitti calibration file error | Failed to parse the Kitti data. | Ensure that the data is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4381 | Dataset is publishing, annotation is forbidden | Sample labeling is not allowed because a publish task is being executed in the dataset. | Wait until the publish task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4382 | Generate 2d image error | Failed to generate a 2D image. | Ensure that the point cloud data is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4384 | Invalid export parameter | Invalid parameter. | Ensure that all mandatory parameters are included and valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4391 | Task name is invalid | An auto deploy task whose name is the task_name value already exists in the dataset. | Ensure that the task name is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4392 | Task failed | Failed to create or run the dataset. | Ensure that the parameters and task resources are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4393 | Task stopped | The dataset task has been stopped. | Check the status of the dataset task with the specified ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4396 | Parameter is invalid | Invalid parameter. | Ensure that the import task parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4399 | Type match error | The dataset type does not match the algorithm model. | Ensure that the algorithm model is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4400 | Can not get table schema | Failed to obtain the schema information from the OBS directory. | Ensure that the CSV file in the OBS directory is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4404 | Can not get table schema from DLI | Failed to obtain the schema information from DLI. | Ensure that the request parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4405 | Dataset must contains labels to start automation labeling | Labeled samples must be available for enabling auto labeling. | Add new labeled samples to the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4406 | Dataset must contains labels with at least five images to start automation labeling | The number of samples to be labeled for each label cannot be less than 5. | Ensure that each label has at least five samples. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4407 | Dataset must contains unlabeled files | The dataset must contain samples that have not been labeled. | Ensure that there are unlabeled samples in the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4408 | Dataset contains labels shape not bndbox | The label shape cannot be bounding box. | Ensure that the shape attribute is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4409 | Running tasks has exceed the max threshold | The number of tasks that are being executed in the dataset has reached the maximum allowed limit. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4410 | Label not found | The label does not exist. | Ensure that the label name is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4411 | Label already exists | The new label list contains existing label names. | Ensure that the label names are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4412 | Label shortcut already exists | The label shortcut already exists. | Change the label shortcut. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4413 | Label is incompatible with annotation rules | The label attribute does not comply with specifications. | Ensure that the label attribute complies with specifications. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4414 | Triplet label's from_entity or to_entity does not exist | The entity label does not exist in the triplet label. | Ensure that the entity label in the triplet label is available. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4415 | Entity label can not be deleted because it is used by triplet label | Failed to delete the entity label because it is being used in the triplet label. | Wait until the label is not used in the triplet label and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4416 | Sync tags error | Failed to synchronize labels in the team labeling task. | Ensure that the synchronization task parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4417 | Update sample labels failed when upload sample and labels | Failed to update the sample labels. | Ensure that the labels are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4418 | Label property mask_gray_value already exists | Duplicate tag mask_gray_value. | Ensure that the tag mask_gray_value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4420 | Sample not found | The sample with the specified ID does not exist. | Ensure that the sample ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4421 | Upload sample failed | Failed to upload the sample to the dataset. | Ensure that the uploaded sample type and data are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4422 | Sample already exists | The sample that is being imported already exists. | Enter that the imported sample is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4423 | Get sample size failed, please input size manually | Incorrect size of the image obtained from the object detection dataset. | Manually set the image size. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4425 | Label property mask_gray_value is incompatible with defined value | The mask_gray_value value cannot be changed. | Ensure that the mask_gray_value value is not changed. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4426 | Dataset must contains tags to start auto deploy | The label set of the dataset cannot be empty. | Create labels for the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4427 | Dataset must contains tags with at least five images to start auto deploy | The number of samples to be labeled for each label cannot be less than 5. | Ensure that each label has at least five samples. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4502 | The IAM agency name already exists, please delete the agency in IAM first and retry | The default IAM agency already exists. | Delete the IAM agency and create a new one. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4601 | The workforce does not exist | The team ID does not exist. | Ensure that the team ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4602 | The workforce already exists | A team whose name is the workforce_name value already exists. | Ensure that the workforce_name value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4603 | Update workforce state failed | Failed to delete the team. | Check whether the team has been deleted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4604 | The worker does not exist | The team member specified by work_id does not exist. | Ensure that the workforce_id and work_id values are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4605 | The worker already exists | The team member whose value is the email value already exists. | Ensure that the email value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4609 | Change password failed | Failed to change the account password. | Ensure that the new password complies with specifications. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4612 | Task not found | The task ID does not exist. | Ensure that the task ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4615 | Workforce task is unfinished | The version cannot be switched because the team labeling task has not been completed. | Wait until the team labeling task is complete and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4617 | The number of manager should be one | The team manager already exists. | Ensure that the roles of the team members are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4618 | Can not delete yourself | You cannot delete yourself from the team. | Ensure that the request parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4619 | Workforce task does not exist | No team labeling task whose ID is the workforce_task_id value is allowed. | Ensure that the workforce_task_id value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4620 | The workforce task already exists | A team labeling task whose name is the task_name value already exists. | Ensure that the task_name value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4622 | Invalid n_clusters, should less than the total number of samples | The number of groups has reached the maximum allowed limit. | Check whether the number of groups is less than the total number of samples. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4623 | Workforce task is checking | Only one review task is allowed at a time. | Wait until all existing review tasks are complete and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4627 | Request notify too frequently | Frequent notification request submission. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4628 | Can not delete worker who has task | The team member cannot be deleted because the labeling task has not been completed. | Notify the member to complete the task. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4650 | Interactive operations not found | Incorrect interactive_operations value. | Ensure that the interactive_operations value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4651 | Get obs sample error | Failed to read the sample from OBS. | Ensure that the sample in OBS is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4700 | Task does not exist | The task ID does not exist. | Ensure that the task ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4701 | Can not start data analysis task, dataset version annotation type must be 'Image Classification' or 'Object Detection' | The dataset type does not support feature analysis. | Ensure that the dataset type is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4702 | Can not start data analysis task, dataset version must be 'Default' format | The dataset format does not support feature analysis. | Use the default dataset format. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4703 | Can not start data analysis task, dataset version must contains annotated samples | Feature analysis cannot be performed because there is no labeled sample in the dataset. | Ensure that there are labeled samples in the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4704 | Currently unable to start data analysis task, Please try again later | Feature analysis cannot be performed because a dataset version is being published. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4706 | Can not start data analysis task, dataset version status must be normal | Feature analysis cannot be performed because the dataset version is not in normal state. | Ensure that the current dataset version is in normal state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4709 | Data preprocessing task already exists | A training task whose name is the name value already exists. | Ensure that the name value is correct in the request for creating in the task. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4710 | Dataset export file error | Failed to publish or export the dataset. | Ensure that the task export or publish parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4711 | Publishing requires splitting but annotated samples do not satisfied for splitting rules | Failed to publish because the dataset label samples do not meet splitting requirements. | Ensure that the number of dataset labels and the number of labeled samples meet the splitting requirements. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4712 | Dataset publish version failed | Failed to publish the dataset version. | Ensure that the task export or publish parameters are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4800 | The label task already exists | A labeling task whose name is the task_name value already exists. | Ensure that the task_name value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4801 | The label task not exists | The labeling task specified by the ID does not exist. | Ensure that the imported task ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4820 | Unsupported operation, label task type is %s | The labeling task type does not support the operation. | Ensure that the labeling task type is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4822 | The number of labelers must exceed 1 | At least two annotators are available in the team. | Check the number of annotators in the team. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4823 | Import to dataset version error | No data can be imported to a table dataset version. | Ensure that the dataset type is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4824 | Dataset version status must be normal | Abnormal dataset version state. | Check the version publish state of the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4825 | Dataset version is empty | No sample is available in the dataset version. | Check the version publish result of the dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4827 | Dataset version delete failed | Failed to delete the dataset version because there is a labeling task based on the dataset version. | Check whether there is any labeling task that is created using the dataset version. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.4851 | Task version not found | The version specified by version_id does not exist. | Ensure that the version_id value is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.4504 | Iam error | IAM error. | Ensure that the AK/SK or token is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4310 | OBS action is forbidden, please check iam agency or OBS and so on | You do not have permission to access OBS. | Grant the permission to access OBS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4335 | Iam agency is invalid | Invalid IAM agency. | Check the IAM permission. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4336 | The user hasn't permission | Restricted user permission. | Check the user permission. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4348 | Check dli agency failed | Failed to create the agency for checking DLI. | Check the agency permission for checking DLI. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4419 | File is too large | The size of the file imported from OBS or to be parsed has reached the maximum allowed limit. | Ensure that the file is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4500 | The number of iam agencies has reached the maximum | The number of IAM agencies exceeded the upper limit. | Delete unused IAM agencies. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4501 | The iam agency create action is forbidden | Failed to create the IAM agency. | Ensure that you have permission to create an IAM agency. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4600 | The worker action is forbidden | The team member cannot perform the operation. | Check whether the team member has permission to perform the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4613 | Task not finish | Failed to obtain the task result because the task execution has not been completed. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4803 | Dataset has unfinished label tasks, the operation is forbidden | Failed to delete data because the labeling task in the dataset has not been completed. | Ensure that all labeling tasks in the dataset are complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4821 | Task is publishing, the operation is forbidden | The auto labeling task cannot be started because a labeling task is being published. | Try again after the labeling task is published. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.4850 | Process task is initializing, the operation is forbidden | Failed to delete the task because the processor task is being initialized. | Check the task status. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 429 | ModelArts.4395 | Too many dataset requests | Frequent dataset or labeling task creation in a unit time. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4354 | Insufficient quota | The number of created datasets has reached the maximum allowed limit. | Delete unused datasets or apply for a higher quota. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4360 | Sync data source error | Failed to synchronize the data source. | Check the synchronization task status and result. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4367 | Update dataset state failed | Failed to delete the dataset. | Check the dataset status. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4373 | No migratory job | Failed to create the dataset migration task. | Check whether the source dataset of the migration task is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4424 | Delete sample failed | Failed to delete the dataset sample. | Ensure that the sample to be deleted is correct and that there is unfinished import or synchronization task. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.4614 | Task failed | Failed to run the task. | Check the execution result of the processor task. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | ModelArts.4383 | Unsupported operation, dataset %s type is %s | The operation cannot be performed in the dataset. | Check whether the dataset supports the current operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | ModelArts.4385 | Auto deploy task exist | Failed to start the deploy task because an auto deploy task is being executed in the dataset. | Start a new deploy task after the current task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | ModelArts.4386 | Auto labeling task exist | Failed to start the auto labeling task because an auto labeling task is being executed in the dataset. | Start a new auto labeling task after the current task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | ModelArts.4387 | Pre-label task exist | Failed to start the pre-labeling task because a pre-labeling task is being executed in the dataset. | Start a new pre-labeling task after the current task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 501 | ModelArts.4394 | Task is running | Failed to obtain the migration result because a migration task is being executed in the dataset. | Wait until the migration task is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0116 | Free train job reached the limit | The number of free jobs exceeds the upper limit. | Create the job again after the running job or the queuing job is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0806 | download log failed | No log is found. | Ensure that the configured log storage duration exceeds the log storage duration. View the job running parameters and ensure that the job is started successfully. If the fault persists, contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0901 | Get dataset url failed | An error occurred when obtaining the dataset URL. | Ensure that the dataset URL is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.2605 | The number of available nodes in the resource pool is illegal: ${nodeCount} | No compute node is available in the selected resource pool. | Select another resource pool. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.2606 | ${obsUrl} should not be bucket | The selected dataset path is invalid. | Select a valid path or select another dataset. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.2607 | parameter length reaches the max limit ${BATCH_CMD_LENGTH_LIMIT} | The number of characters in the running parameter exceeds the upper limit. | Check the running parameters and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.2608 | ${url} should not contains | Invalid OBS path. | Ensure that the OBS path does not contain the following characters: '{} [] and spaces try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.2701 | There is already a peer connection | The VPC peering connection already exists in the resource pool. | Use the existing connection or create another one. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.2702 | Invalid vpc or subnet | The specified VPC CIDR block overlaps with the dedicated resource pool CIDR block, and no VPC peering connection can be created. | Change the VPC CIDR block. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.2703 | network of pool is not ready | There are multiple peering connections in the dedicated resource pool. These peering connections may have been manually operated. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.3000 | volumes of config are used in dedicated pools | You do not have the permission to access the volume in the dedicated resource pool. | Access a common volume. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.0015 | The resource you requested is not exist | The queried resource does not exist. | Ensure that the URL is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.2700 | ${operator} failed. Response status is ${status}.Detail error msg: $agentErrorMsg | Failed to call the VPC interface. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.2704 | Update sfs turbo info of pool failed. Error msg: {ex.getMessage} | Failed to create the VPC peering connection and call the VPC interface. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.2800 | ${operator} failed. Response status is $status. Detail error msg: ${agentErrorMsg} | Failed to access the SFS Turbo interface. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5011 | Invalid parameter | Invalid parameter. | Modify the parameter. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5012 | Invalid product attribute | Invalid product attribute. | Modify the product attribute. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5016 | The original model ({0}) does not exist during model release | The product source model does not exist. | Select another source model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5022 | Unsupported model type | The model type is not supported. | Select another source model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5025 | Incorrect verification code | Incorrect verification code. | Enter the correct verification code. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5026 | Verification code expired | Verification code expired. | Obtain a new verification code. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5027 | The verification code does not match the email address. | The email address and verification code do not match. | Obtain a new verification code. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5038 | You must first get a verification code | You have not obtained the verification code. | Specify your email address and obtain the verification code by email. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5041 | Duplicate version. Refresh the page and try again | Duplicate version. | Refresh the page and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5047 | Hilens product name duplicated. | Duplicate HiLens name. | Enter another product name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5048 | Hilens skill version duplicated. | Duplicate HiLens version. | Select another version. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5049 | Incorrect Hilens skill. Select the skill corresponding to the offering. | Incorrect HiLens skill. | Select the correct HiLens skill. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5051 | The HiLens skill type is not supported. Release the skill type in HiLens Studio. | The HiLens skill is currently unavailable. Publish the skill in HiLens Studio. | Select the correct HiLens skill. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5052 | The user does not have the agency permission | You do not have the agency permission. | Set an agency and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5303 | The obs source data is empty | Empty source data. | Select other source data. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5304 | The maximum number of files has been exceeded | The number of files has reached the maximum allowed limit. | Select other source data or reduce the data volume. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5305 | The maximum size of files has been exceeded | The file size has reached the maximum allowed limit. | Select other source data or reduce the data volume. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5306 | The maximum depth of files has been exceeded | The file depth has reached the maximum allowed limit. | Select other source data or reduce the data depth. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5309 | Only allow edge service published to AIHub. | Only edge VAS can be published. | Select the edge VAS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5312 | Only allow market category service published to AIHub. | Only market VAS can be published. | Select the market VAS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5313 | Only allow released service published to AIHub. | Only published VAS is allowed. | Select the published VAS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.5314 | Only allow 'closed Beta Test' stage service published to AIHub. | Only Closed Beta Test VAS can be published. | Select the Closed Beta Test VAS. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.5001 | Token is blank | The token does not exist. | Add the token and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.5002 | Token is invalid | Invalid token. | Obtain a token and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.5056 | You do not have the permission to access the requested resource. | You have not subscribed to HiLens. | Log in to the HiLens management console and subscribe to the service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5013 | The user is not registered. Please release a product first to complete the registration | You have not registered with AI Gallery. | Publish a product in AI Gallery for registration. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5014 | Permission deny | You do not have permission to access the resource. | Access other resources. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5017 | Account suspended. | Suspended account. | Ensure that the account is not restricted and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5040 | Your usage has exceeded the maximum quota | The resource usage has reached the maximum allowed limit. | Wait until the system is idle and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5043 | Challenge applications submit failed | Failed to submit the contest. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5053 | Product has been recycled. | The product has been reclaimed. | Select another product. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5054 | At least one available version must exist. | At least one available version is required for the product. | Perform other operations. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5055 | The subscription has expired. | The subscription has expired. | Initiate a new subscription. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.5057 | The free package is sold out. | The free package has been sold out. | Select another package. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.5058 | Object ({0}) does not exit. | The object does not exist. | Select another object. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.5015 | The product is being reviewed | The product is being reviewed. | Perform operations after the review is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.5044 | Operations conflict, please try again later | Failed to perform the operation. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5000 | Please try again later or contact customer service to solve the problem | Internal error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5003 | Internal Error: access IAM service failed | Failed to access IAM. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5004 | Internal Error: access moderation service failed. | Failed to access Text Moderation. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5005 | Internal Error: access ModelArts service failed | Failed to access ModelArts. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5006 | Internal Error: access AI service failed | Failed to access the managed services in AI Gallery. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5007 | Internal Error: access AI manager failed | Failed to access the manager services in AI Gallery. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5008 | Internal Error: access SMN service failed | Failed to access SMN. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5009 | Database operation failed | Database operation error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5010 | OBS operation failed | Failed to access OBS. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5019 | Internal Error: access CBC service failed | Failed to access CBC. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5021 | Internal Error: access LCS service failed | Failed to access LCS. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5039 | Dear User,the traffic is a little busy. Please try again later | Excessive requests. | Try again later. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5050 | Internal Error: access Hilens service failed | Failed to access HiLens. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5300 | Failed to explore the user source address. | Failed to traverse user source addresses. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5301 | Failed to download the source file from OBS. | Failed to download the source file from OBS. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5302 | Failed to upload the source file to the destination address. | Failed to upload the source file to the destination address. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5308 | Internal Error: access VAS service failed | Failed to access VAS. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.5311 | Failed to get market category id. | No market category ID found. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0101 | Invalid Argument. | Invalid parameter. | Enter the correct parameter as prompted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0107 | The values of the request parameters ({0},{1}) are invalid. | Invalid parameter values ({0}, {1}). | Check whether the parameter values are valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.0204 | Token must contain projectId info. | No project ID included in the token. | Ensure that the project token is used. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3015 | Config json file does not conform to the specification. | The model configuration file does not comply with file specifications. | Check whether config.json or initial_config complies with the specifications. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3016 | Failed to parse config json file because of unsupported fields, types, or formats({0}, {1}). | Failed to parse the configuration file because the field, type, or format is not supported. | Check whether the field is correct as prompted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3017 | Failed to publish model because source location noncompliance. | Failed to publish the model because the model source path does not meet specifications. | Check whether the source_location value complies with the specifications. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3023 | Invalid labels({0}) of model. | Invalid model label {0}. | Ensure that a model label starts with a letter or a Chinese character and contains a maximum of 64 characters, including letters, digits, underscores (_), and Chinese characters. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3024 | The templateInputs field is incorrectly configured, check if the input is consistent with the template requirements. | Incorrect configuration. Check whether the configuration complies with the template requirements. | The parameter configuration does not comply with the template requirements. Modify the configuration. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3025 | User ({0}) has only a single share permission and cannot be shared with all users. | User {0} does not have permission to share data with all users. | Only the administrator or accounts in the whitelist have permission to share data with all users. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3026 | Failed to delete infer format, infer format ({0}) already be used by template. | Failed to delete input/output mode {0} because it is being used by a template. | Find the template that is using the input/output mode, disassociate the mode from the template, and delete the mode again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3027 | The model used by the template ({0}) is private and belongs to other users and cannot be shared. | Input/Output mode {0} used by the template cannot be shared. | Select another mode. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3028 | Failed to publish model, please select input and output mode. | Failed to publish the model. Select an input/output mode. | Select another input/output mode and publish the model again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3029 | Model publishing failed because the Template model must provide the template ID used. | Failed to publish the model because the template ID is unavailable. | Enter the template ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3030 | Model publishing failed, template ({0}) does not support modifying its built-in input and output mode. | Failed to publish the model because the built-in input/output mode of template {0} cannot be changed. | Do not change the input/output mode of a template when publishing the template model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3031 | Cancel sharing failed, ({0}) has not been shared with other tenants. | Failed to cancel the sharing because image {0} is not shared with other users. | Ensure that image {0} is not shared with other users. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3032 | Image ({0}) cannot be shared to admin ({1}), please check the image permissions. | Failed to share image {0} with the administrator {0}. Check the image permission. | Perform operations according to the error message. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3033 | Template publishing failed, please provide template label. | Failed to publish the template model because its label is left blank. | Set the model label. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3034 | Template model failed to be published, template field is required. | Failed to publish the template model because the template field is left blank. | Set template. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3035 | Profile preview failed, sourceLocation and previewConfig fields need to provide at least one. | Failed to preview the configuration file. | Either source_location or preview_config must be specified. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3036 | Parameter verification failed, parameter ({0}) is required. | Failed to check parameter {0} because it is left blank. | Set parameters according to the error message. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3037 | Parameter ({0}:{1}) is invalid. | Invalid parameter {0}:{1}. | Modify passwords as prompted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3038 | When isSpecific is true, domainId is required. | Failed to perform the operation because domain_id is left blank. | Set domain_id as prompted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3039 | Template input input_id cannot be repeated. | Failed to perform the operation because input_id is repetitive. | Ensure that the input_id value is unique. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3040 | When the installer installer is yum or apt-get, and the version packageVersion exists, the version constraint restraint can only be EXACT. | Failed to perform the operation because restraint can only be EXACT. | Change the restraint value to EXACT. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3041 | When the installer installer is conda or pip, and the version packageVersion exists, the version constraint restraint can only be EXACT, ATLEAST, ATMOST. | Failed to perform the operation because restraint can only be EXACT, ATLEAST, or ATMOST. | Change the restraint value to EXACT, ATLEAST, or ATMOST. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3063 | Mode unshared failed, the template using this mode has been shared, you need to cancel the sharing of the template first. | Failed to cancel mode sharing because the template using the mode is being shared. | Perform operations according to the error message. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3070 | There is a model name that does not belong to this tenant: ({0}). | The model does not belong to user {0}. | The domain ID of the subscribed model is different from the entered domain ID. Contact the model subscription service and check whether the entered domain ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3072 | The domain id is the same and does not support subscribing to your own model. | You cannot subscribe to your own model. | Use another account to subscribe to the model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3074 | Unable to delete subscribed model. | Failed to delete the subscribed model. | Unsubscribe from the model and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3076 | Model does not support deploying edge services and cannot broadcast. | Failed to perform the operation because the model cannot be deployed as an edge service. | The install_type of the model does not support edge service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3077 | Model is a subscription model that cannot be broadcast. | Failed to perform the operation because the model has been subscribed. | The model_source of the model has been set to subscribe. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3078 | The model status is not normal and cannot be broadcast. | Failed to perform the operation because the model status is abnormal. | Check the model status. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3079 | Purchased license, can't cancel subscription. | Failed to unsubscribe from the model because a license has been configured for the model. | Delete the license and unsubscribe from the model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.0108 | You are not authorized to perform the ({0}) operation. | You do not have permission to perform {0}. | Check whether you are authorized to perform operations on OBS or APIs. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.0203 | Invalid token. | Invalid token. | Obtain a new token and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.0206 | Invalid AK/SK. | Invalid AK/SK. | Check whether the token is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.3010 | Failed to copy model, you don't have permission to copy the model ({0}). | You do not have the permission to copy model {0}. | Check whether the entered token or model ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.3075 | Model ({0}) is a subscription model and cannot create a new version. | Failed to create a new version because model {0} has been subscribed. | No new version can be created for a subscribed model. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3001 | Model ({0}) does not exist. | Model {0} does not exist. | Check whether the entered model ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3003 | Failed to get model names list. | Failed to obtain the model name list. | Check whether the account is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3019 | Infer format ({0}) does not exist. | Input/Output mode {0} does not exist. | Change the input/output mode. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3021 | Template ({0}) does not exists. | Template {0} does not exist. | Select another template. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3071 | The subscription ({0}) does not exist. | Subscription {0} does not exist. | Subscribe to the model and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3080 | Model optimization job ({0}) does not exist. | Model optimization task {0} does not exist. | The task is unavailable. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3002 | Model ({0}, {1}) already exists. | Model ({0}, {1}) already exists. | Change the model name or version and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3020 | Infer format ({0}) already exists. | Input/Output mode {0} already exists. | Change the input/output mode. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3022 | Template ({0}) already exists. | Template {0} already exists. | Select another template. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3073 | model ({0}) already exists, no subscription required. | Model {0} already exists. | Do not subscribe to another model with the same name. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.0010 | Internal error. | Internal error. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.0109 | Unauthorized account. | Unauthorized account. | Only the administrator can call alarm APIs. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3006 | Failed to publish model. | Failed to publish the model. | The model metadata failed to be stored to the database. Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3009 | Failed to delete model, model ({0}) already deploy service. | Failed to delete model {0} because it has been deployed as a service. | Delete the deployed service and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3043 | User ({0}) does not have obs: object: PutObjectAcl permission. | User {0} does not have the obs:object:PutObjectAcl permission. | Add the permission and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3044 | Model file ({0}) is larger than 5G and cannot be imported. | Failed to import model file {0}. | Ensure that the file is at most 5 GB in size. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3045 | Parameter ({0}) is null. | Parameter {0} is left blank. | Check the parameter setting as prompted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3047 | ExeML model({0}) cannot be converted. | Failed to convert model {0}. | ExeML models cannot be converted. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3048 | Model({0}) is being imported and cannot be converted. | Failed to convert model {0} because the model status is abnormal. | Convert the model after the model status changes to normal. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3049 | Cannot convert models belonging to other users. | Models of other users cannot be converted. | You can only convert your models. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3050 | Get user temporary credential failed. | Failed to obtain the temporary user certificate. | Check whether the token is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3052 | Chip Type ({0}) not support. | Chip type {0} is not supported. | Check whether the chip is of Ascend, GPU, Arm, or general type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3053 | Model Type ({0}) not support. | Model type {0} is not supported. | This type of model is not supported. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3054 | Task ({0}) does not exists. | Task {0} does not exist. | The task is unavailable. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3055 | Task ({0}) is running cannot be deleted. | Failed to delete task {0} because it is running. | Delete the task after it is complete. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3056 | Task name ({0}) not meeting the specification. | Task name {0} does not comply with specifications. | Ensure that a task name starts with a lowercase letter, ends with a lowercase letter or digit, and contains 2 to 24 characters, including lowercase letters, digits, and hyphens (-). | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3057 | Task description ({0}) not meeting the specification. | Task description {0} does not comply with specifications. | Ensure that task description contains 1 to 100 characters and cannot contain the following characters: &,!\"<>=. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3058 | Task input ({0}) not meeting the specification. | Task input {0} does not comply with specifications. | Perform operations according to the error message. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3059 | Task output ({0}) not meeting the specification. | Task output {0} does not comply with specifications. | Ensure that the task output is a valid HTTP or HTTPS address. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3060 | Task spec ({0}) not meeting the specification. | Advanced task option {0} does not comply with specifications. | Ensure that the advanced option does not contain Chinese characters or the following characters: (|)&$?<>. Ensure that the value is less than 4000. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3061 | get Task ({0}) log parameter not meeting the specification. | Log parameters of task {0} do not comply with specifications. | Ensure that the offset or lines value is greater than or equal to 0. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3062 | Task ({0}) exists. | Task {0} already exists. | Change the name and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3064 | DL Framework Type ({0}) not support. | Deep learning framework {0} is not supported. | This type of framework is not supported. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3065 | The image of the model is being built so the runtime cannot be updated. | Failed to update runtime because the model image is being created. | Wait until the image is created. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3301 | Failed to build image. | Failed to create the image. | Check the image, or contact R&D and O&M personnel to rectify the fault. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3801 | invalid token, can not get template ak/sk. | Failed to obtain the template AK/SK due to an invalid token. | Obtain a new token and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3802 | create encrypt path or file failed. | Failed to create the encryption path or file. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3803 | download file from obs failed. | Failed to download the file from OBS. | Check whether the OBS path is available. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3804 | upload file to obs failed. | Failed to upload the file to OBS. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3805 | file can not be empty. | The file cannot be left blank. | Set file. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3901 | license id ({0}) is not exist. | License ID {0} does not exist. | Check whether the license ID is valid. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3902 | Failed to get license info because ({0}). | Failed to obtain the license because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3903 | Renew license failed because ({0}). | Failed to renew the license because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3904 | Upload data failed because ({0}). | Failed to report the used quota because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3905 | Failed to get app key. | Failed to obtain the app key. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3906 | Failed to create license because ({0}). | Failed to create the license because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3907 | Failed to delete license because ({0}). | Failed to delete the license because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3908 | Failed to get CBC resources. | Failed to obtain CBC resources. | Check the license ID or the associated license configuration. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3909 | access CBC failed. | Failed to access CBC. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3910 | Check CBC auth failed because ({0}). | Failed to authorize CBC operations because {Reason}. | Locate the fault based on the failure cause. Renewal authentication fails because cloudservicetype is not provided. Unsubscription authentication fails because an instance is being deployed. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7001 | Internal error occurred in workspace manager. | An internal error occurred in the workspace manager. | Contact R&D and O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3514 | Field [input_params] must be set for the model that is used to deploy the batch service. | The input_params parameter for the batch service model is left blank. | Set input_params. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3515 | The model {id} cannot be used for deploying services because it is still being published. | Failed to deploy the service because model {ID} is not ready. | Try again after the model is ready. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3516 | Failed to deploy services because the version of the model that is used for deploying services is the same. | Failed to deploy the service due to duplicate model versions. | Correct the model version list to ensure that no duplicate model versions exist. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3518 | The {service_type} service has not been enabled or authorized. | Service {type} has not been enabled or authorized. | Enable or authorize the service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3519 | Services only in one of states in [deploying, running, stopping, deleting] can be updated. | Services in the deploying, running, stopping, or deleting state cannot be updated. | Do not update services in the deploying, running, stopping, or deleting state. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3520 | A maximum of {number} {service_type} services are allowed. | The total number of {type} services has reached the maximum allowed limit {quantity}. | Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3521 | A maximum of {number} {service_type} services in running status are allowed. | The total number of {type} services in the running state has reached the maximum allowed limit {quantity}. | Delete the services that are no longer used or contact service O&M personnel to increase the quantity quota. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3522 | A maximum of {number} {service_type} service instances are allowed. | The total number of {type} service instances has reached the maximum allowed limit {quantity}. | Delete the service instances that are no longer used or contact service O&M personnel to increase the quantity quota. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3523 | Service {name} has been subscribed. | Service {name} has been subscribed. | Directly use the subscribed service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3524 | Failed to subscribe to the service because {reason}. | Failed to subscribe to the service because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3525 | Forbidden to update service {name} because it is a shared service. | Failed to update service {name} because it is a shared service. | Do not update a shared service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3527 | Forbidden to subscribe to service {id} because it is a {service_type} service. | Failed to subscribe to service {ID} because it is a {type} service. | The service of this type cannot be subscribed to. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3528 | Forbidden to subscribe to service {id} because it is released by yourself. | Failed to subscribe to service {ID} because it is your service. | You cannot subscribe to services published by yourself. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3529 | Model {id} under service {id} does not exist. | Model {ID} of service {ID} does not exist. | Ensure that the model ID is correctly set and that the model belongs to the target service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3531 | Service {id} has created the QR code. | A QR code has been created for service {ID}. | The QR code has been created for the service and does not need to be created again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3532 | No QR code found for service {id}. | A QR code has not been created for service {ID}. | Create a QR code for the service and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3533 | The selected edge node does not support {GPU/NPU}. | The selected edge node flavor does not support {GPU/NPU}. | Add the target hardware support to the selected edge node, or use another edge node that supports the target hardware. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3534 | The security group must contain at least one inbound rule to allow the TCP request from source address 0.0.0.0/0 and port 8080. | The security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is 0.0.0.0/0, and port number is 8080. | Add the inbound rule to the security group. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3535 | Subservice {name} of service {name} does not exist. | Subservice {name} of service {name} does not exist. | Ensure that the subservice name is correctly set and that the subservice belongs to the target service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3536 | Subservice {name} of service {name} has been subscribed. | You have subscribed to subservice {name} of service {name}. | Directly use the subscribed subservice. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3538 | The requirement notification of service {name} should not exceed one. | At most one requirement notification is allowed for service {name}. | Check the configuration and ensure that no more than one requirement notification is configured for service {name}. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3540 | Operation failed because you are not the owner of service {name}. | You are not the owner of service {name}. | This operation can be performed only by the service owner. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3541 | Error code {error_code} of service {name} does not exist. | Error code {error code} of service {name} does not exist. | Ensure that the error code is correctly set and that the error code belongs to the target service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3542 | Error code {error_code} of service {name} already exists. | Error code {error code} of service {name} already exists. | Change the error code and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3544 | URL domain CNAME resolution failed. | Failed to parse the CNAME domain. | Check whether the URL is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3545 | Invalid certificate or private key. | Invalid certificate or private key. | Check whether the certificate or private key is correctly configured. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3547 | Cluster {id} does not exist. | Cluster {ID} does not exist. | Check whether the cluster ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3548 | Path {path} is not a valid regex. | Path {path} is not a valid regular expression. | Check whether the path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3549 | Error code {code} is duplicated. | Duplicate error code {error code} in the request body. | Modify the error code to ensure that the error code is unique. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3550 | Domain {name} has been used. | Domain {noun} has been used. | Change the domain name and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3551 | OBS path {path} does not exist. | OBS path {path} does not exist. | Check whether the OBS path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3552 | The length of [resource_id] must be in the range of [0, 64]. | The resource_id value is not in the range from 0 to 64. | Check whether RESOURCE_SPEC_CODE is too long. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3553 | Service {name} not subscribed yet. | Service {name} has not been subscribed to. | Subscribe to the service and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3554 | Cluster name {name} has been used. | Cluster name {name} has been used. | Change the cluster name and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3556 | Forbidden to share ai-service {id} because ai-service is unsharable. | AI service {ID} cannot be shared. | AI services cannot be shared. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3559 | Source error code {error_code} of service {name} already exists. | Source error code {error code} of service {name} already exists. | Change the source error code and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3560 | Project {project_id} has not subscribed to subservice {id}. | Subservice {ID} has not been subscribed for project {ID}. | Subscribe to the subservice and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3561 | Insufficient node quota. | Insufficient node quota. | Contact service O&M personnel to increase the quota or delete unnecessary nodes to release resources. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3562 | The value of field {due_time} must be a future time. | The due_time value must be later than the current time. | Set the due_time parameter to a time later than the current time. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3564 | The sample collection task has been created for service {id}. | Sample collection for service {ID} has been created. | Do not create the task again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3565 | No sample collection task is created for service {id}. | Sample collection for service {ID} has not been created. | Create a service sample collection task and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3566 | Forbidden to modify the default workspace. | The default workspace cannot be modified. | Do not modify the default workspace. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3567 | OBS error occurs because {reason}. | OBS error because {cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3568 | OBS client error occurs. | The OBS client is abnormal. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3572 | Invalid OBS URL {url}. | Invalid OBS path {path}. | Check whether the OBS path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3573 | Failed to obtain the bucket name from OBS URL {url}. | Failed to obtain the bucket name from OBS path {path}. | Check whether the OBS path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3574 | Failed to validate the correctness of OBS URL {url}. | Failed to check OBS path {path}. | Check whether the OBS path is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3576 | Failed to query the model quota. | Failed to obtain the model quota. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3577 | Failed to update the model quota. | Failed to update the model quota. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3578 | Insufficient model quota. Increase the quota or delete any unnecessary services. | Insufficient model quota. | Increase the quota or delete the models that are no longer used, and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3580 | Model not purchased. | The model has not been purchased. | Purchase the model and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3582 | Failed to create edge configurations. | Failed to create edge configurations. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3583 | Failed to create the edge application due to IEF error. | Failed to create the edge application due to an IEF platform error. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3584 | Failed to update the edge application. | Failed to update the edge application. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3585 | The host port has been used by another edge application. | The host port has been used by another edge application. | Use another port or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3586 | Failed to create the edge application. | Failed to create the edge application. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3587 | Failed to delete the edge application. | Failed to delete the edge application. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3588 | Failed to create edge volumes and environments. | Failed to create edge parameters. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3589 | Model {id} cannot be used to deploy {service_type} service. | Model {ID} cannot be used to deploy the {type} service. | Select another deployment type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3590 | Invalid expression rule. Create a rule using Spring Expression Language and the desired result type is Boolean. | Invalid expression rule. | Ensure that the rule complies with the Spring expression language syntax, and the expected result is of Boolean type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3591 | There are duplicate rules in the extend-configs. | Duplicate rules in extend-configs. | Modify the expression specifications to prevent duplicate expressions. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3592 | Incorrect model health configuration. | Incorrect model health check parameters. | Check whether the health check parameters of the model are correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3593 | The model has been expired. | The model has expired. | Purchase or subscribe to the model again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3594 | Failed to query IEF instances. | Failed to obtain the edge instance. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3595 | Failed to create the IEF application mesh. | Failed to create the application mesh. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3596 | Failed to update the IEF application mesh. | Failed to update the application mesh. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3597 | Please authorize the development environment to use and store your AK and SK. | Failed to use the service because the development environment has not been authorized to store and use your AK and SK. | Authorize the development environment to store and use your AK and SK. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3598 | Only nodes in the [Running] state can be selected. | Only running nodes can be selected. | Select a running node and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3610 | Parameter {name} cannot be empty. | Parameter {name} cannot be left blank. | Set the parameter and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3611 | Failed to query the batch task run log. | Failed to obtain batch processing task logs. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3612 | Failed to {create/update} the service payload due to error code {code}. Please try later or submit a service ticket for professional technical support. | Failed to {create/update} service workload. The error code is {error code}. Try again later or submit a service ticket. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3613 | Failed to register the API. Please try later or submit a service ticket for professional technical support. | Failed to register the service API. Try again later or submit a service ticket. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3620 | Failed to get the number of associated services. | Failed to obtain the number of associated services. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3811 | Failed to query the agency because {reason}. | Failed to obtain the agency because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3812 | Failed to create AI resource specification code {code} because {reason}. | Failed to create resource flavor code {code} because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3813 | Failed to update AI resource specification code {code} because {reason}. | Failed to update resource flavor code {code} because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3814 | Failed to delete AI resource specification code {code} because {reason}. | Failed to delete resource flavor code {code} because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3815 | Failed to delete AI subservice {id} because {reason}. | Failed to delete subservice {ID} because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3816 | Failed to create the AI proxy mapping because {reason}. | Failed to create the proxy mapping because {reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3817 | Failed to update the AI proxy mapping because {reason}. | Failed to update the proxy mapping path because {reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3818 | The agency of service {name} has been defined. | The agency of service {name} has been configured. | Do not repeat the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3822 | The batch service task does not exist. | The batch service does not exist. | Enter the correct batch service ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3825 | Failed to generate the SDR data because {reason}. | Failed to generate CDR data because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3826 | Failed to create the API because {reason}. | Failed to create the API because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3827 | Failed to subscribe to the API because {reason}. | Failed to subscribe to the API because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3828 | Failed to unsubscribe from the API because {reason}. | Failed to unsubscribe from the API because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3829 | Failed to modify the API subscription status because {reason}. | Failed to update the API subscription because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3830 | Operation not allowed. Change the charging mode from postpaid to prepaid in CBC. | You are not allowed to change the billing mode from postpaid to prepaid. | Change the billing mode in CBC. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3831 | Operation not allowed. Change the charging mode from prepaid to postpaid in CBC. | You are not allowed to change the billing mode from prepaid to postpaid. | Change the billing mode in CBC. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3832 | The subscription configuration is not modified and does not need to be updated. Please check. | Failed to perform the operation because the subscription configuration has not modified. | Change the subscription configuration and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3833 | Failed to delete the API because {reason}. | Failed to delete the API because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3834 | Failed to update metedata in CBC because {reason}. | Failed to update the CBC metadata because {Reason}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3835 | Resource specification code {code} of service {name} does not exist. | Resource flavor code {code} of service {name} does not exist. | Ensure that the resource flavor code is correctly set and that the code belongs to the target service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3836 | Resource specification code {code} of project {id} does not exist. | Resource flavor code {code} of project {1} does not exist. | Ensure that the resource flavor code is correctly set and that the code belongs to the target project. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3837 | Resource ID {id} of project {id} does not exist. | Resource {ID} of project {1} does not exist. | Ensure that the resource ID is correctly set and that the resource belongs to the target project. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3838 | The hard-select has not been enabled for service {id}. | Hard example filtering of service {0} has not been enabled. | Enable hard example filtering for the service and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3839 | The hard-select has been enabled for service {id}. | Hard example filtering of service {0} has been enabled. | You do not need to enable it again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3840 | Only one algorithm can be set for the service model. | Service {0} has more than one labeling type. | Modify the configuration to ensure that there is only one labeling type. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3841 | The value of [dataset_type] must be one of values in [image_classification, object_detection]. | The labeling type is not object detection or image classification. | Change the labeling type to object detection or image classification. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3842 | The labeling type of service algorithm {name} does not match that of dataset {type}. | The labeling type of service algorithm {0} does not match that of dataset {1}. | Modify the labeling type or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3843 | Failed to query the information about dataset {id}. | Failed to obtain database {0}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3844 | Failed to import samples to dataset {id}. | Failed to import the sample to dataset {0}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3845 | No sample is available for import under the OBS path {path} of service {id}. | No sample is available to be imported to OBS path {path} of service {ID}. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3846 | Failed to add the OBS bucket lifecycle rule for service {id}. | Failed to add the lifecycle rule for the OBS bucket of service {ID}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3847 | Failed to delete the OBS bucket lifecycle rule for service {id}. | Failed to delete the lifecycle rule for the OBS bucket of service {ID}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3848 | Service {id} in the information of dataset {import_type} already exists. | The service {ID} of the {import type} dataset already exists. | Check the request and select the correct service ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3849 | Service {id} in the information of dataset {import_type} does not exist. | The service {ID} of the {import type} dataset does not exist. | Check whether the service ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3850 | The hard-sample-select task {id} of service {id} does not exist. | Hard example task {ID} of service {ID} does not exist. | Ensure that the hard example task ID is correctly set and that the task belongs to the target service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3851 | The status of hard-sample-select task {name} cannot be changed from {status} to {status}. | The status {status value} of the hard example task {name} cannot be updated to {status value}. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3852 | Failed to start hard-sample-select task {id} because related OBS files have been deleted. | Failed to start hard example task {ID} because key OBS files have been deleted. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3853 | The hard-sample-select quota of project {id} does not exist. | The quota for selecting hard samples for project {ID} does not exist. | Create the quota and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3854 | The hard-sample-select quota of project {id} already exists. | The quota for selecting hard samples for project {ID} already exists. | You do not need to create it again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3856 | A maximum of {number} free services are allowed. | The number of free services has reached the maximum allowed limit {Number}. | Delete unnecessary free services to release resources. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3857 | A maximum of {number} free service instances are allowed. | The number of free services has reached the maximum allowed limit {Number}. | Delete unnecessary free services to release resources. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3862 | Subservice {id} has been added to whitelist URL {url}. | The URL {URL} has been added to the whitelist of the sub-service {ID}. | Do not repeat the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3863 | Whitelist URL {id} of service {name} does not exist. | The whitelist URL {ID} of the service {name} does not exist. | Ensure that the URL ID in the whitelist is correct and that the URL belongs to the corresponding service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3864 | Subservice {id} of service {name} does not exist. | The sub-service {ID} of service {name} does not exist. | Ensure that the sub-service ID is correct and that the sub-service belongs to the corresponding service. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3865 | The size of the download whitelist of service {name} exceeds the maximum number {number} allowed. | The number of the whitelist records downloaded by service {name} exceeds the upper limit {value}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3866 | Domain ID {id} and user ID {id} already exist. | The domain ID {ID} and user ID {ID} already exist. | Do not repeat the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3867 | Domain ID {id} does not exist. | The domain ID {ID} does not exist. | Check the request and enter the correct domain ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3868 | Domain ID {id} and user ID {id} do not exist. | The domain ID {ID} and user ID {ID} do not exist. | Check the request and enter the correct domain ID and user ID. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3869 | Failed to delete the task type because {reason}. | Failed to delete the task type. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3870 | Failed to subscribe to the API because {reason}. | Failed to subscribe to the API. Fault cause: {fault cause}. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3871 | Forbidden to subscribe to postpaid QPS for the task type. | You are not allowed to subscribe to postpaid QPS for the task type. | Check the request parameter or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3872 | Forbidden to change the charging mode for the task type from prepaid to postpaid QPS. | You are not allowed to change the billing mode of the task type from prepaid mode to postpaid QPS mode. | Check the request parameter or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3873 | No corresponding subservice is found in cluster {name}. | The cluster {0} does not have the corresponding sub-service. | Check the request parameter or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3880 | Failed to create the AS policy because {reason}. | Failed to create the AS policy. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3890 | The total number of AS policies exceeds the maximum number {number} allowed. | The number of AS policies exceeds the upper limit {0}. | Delete unnecessary AS policies. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3892 | Calling failed due to invalid CBS request. | Failed to call the API due to the invalid CBC request. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3894 | The specification configuration information of runtime environment {name} does not exist. | The specification configurations of the running environment {0} does not exist. | Set the flavor configurations for the running environment and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3895 | The specification configuration information of runtime environment {name} already exists. | The specification configurations of the running environment {0} already exist. | Do not repeat the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3896 | Resource specification code {0} for user {1} already exists. | The records of the resource specification code {0} in project {1} already exist. | Do not repeat the operation. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3897 | Failed to {create/obtain/remove} the AS policy due to error code {code}. | Failed to request {create/obtain/delete} the AS. Error code: {0}. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3950 | Failed to obtain the AI service list. | Failed to obtain the AI service list. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3951 | Failed to parse file {name}. | Failed to parse the file {name}. | Ensure that the file name is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3952 | Insufficient resources. Please try later. | Insufficient resources. | Try again later or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3953 | Failed to delete online service {id} because it has been associated with AI service {name}. Please disassociate it and try again. | Failed to delete real-time service {ID} because it has been associated with AI service {name}. | Cancel the association between the real-time service and all AI services and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3954 | AI resource specification {id} does not exist. | The cloud resource specification {ID} does not exist. | Ensure that the cloud resource specification ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.3955 | Field [resource_id_components] of AI resource specification {id} cannot be empty. | The ID components in the cloud resource specification {ID} cannot be left blank. | Set the resource_id_components parameter and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7002 | You are not authorized to operate dataset {id}. | You do not have the permission to operate the dataset {ID}. | Check the permission or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 401 | ModelArts.3801 | User credential (AK and SK) does not exist. | The user certificate does not exist. | Add the AK/SK again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.0210 | The project id in the request URL does not match the token. | The project ID in the request URL and the token do not match. | Use the correct project ID to generate a token. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.3555 | Forbidden to access ECS. | You do not have the permission to access the ECS. | Authorize access to the ECS and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 403 | ModelArts.3936 | The app-auth API {id} does not belong to service {id}. | The API {ID} that supports application authentication does not belong to the service {ID}. | Check the request parameter or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3502 | Service {name} does not exist. | The service {name} does not exist. | Ensure that the service name is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3507 | Model {name} does not exist. | The model {ID} does not exist. | Ensure that the model ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3923 | Application {id} does not exist. | The application {ID} does not exist. | Ensure that the application ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 404 | ModelArts.3935 | The app-auth API {id} does not exist. | The API {ID} that supports application authentication does not exist. | Ensure that the interface ID is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3503 | Service {name} already exists. | The service {name} already exists. | Change the service name and try again. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 409 | ModelArts.3929 | Failed to create the application because {reason}. | Failed to create the application. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3501 | Failed to deploy the service. | Failed to deploy the service. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3504 | Failed to delete the service. | Failed to delete the service. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3505 | Failed to update the service. | Failed to query the service. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3506 | Model {id} does not exist. | Failed to update the service. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3508 | Failed to query the service monitoring information. | Failed to obtain the service monitoring information. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3509 | Failed to query edge nodes. | Failed to query the node. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3511 | Failed to query edge tags. | Failed to query the edge label. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3537 | Failed to handle the CBC request. | Failed to process the CBC request. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3539 | Failed to initialize service URL {url}. | Failed to initialize the service URL {URL}. | Ensure that the service URL is correct. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3543 | Invalid CBC request. | The CBC request is invalid. | Try again or contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3546 | Failed to create the cluster. | Failed to create the dedicated resource pool. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3579 | Failed to query the model information. | Failed to query the model information. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3581 | Failed to create edge certificates. | Failed to create the edge certificate. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3802 | Failed to create API group {name} because {reason}. | Failed to create the API group {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3803 | Failed to register API {name} because {reason}. | Failed to register the API {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3805 | Failed to create AI service {name} because {reason}. | Failed to create the AI service {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3806 | Failed to update AI service {name} because {reason}. | Failed to update the AI service {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3807 | Failed to delete AI service {name} because {reason}. | Failed to delete the AI service {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3808 | Failed to create AI subservice {name} because {reason}. | Failed to create the sub-service {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3809 | Failed to update AI subservice {name} because {reason}. | Failed to update the sub-service {name}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3810 | Failed to create the agency because {reason}. | Failed to create the agency. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3819 | Failed to delete the agency definition. | Failed to delete the service agency definition. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3858 | Failed to bind task type to API {id} because {reason}. | Failed to bind task type to API {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3859 | Failed to unbind task type from API {id} because {reason}. | Failed to unbind the task type from API {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3860 | Failed to create the task type because {reason}. | Failed to create the task type. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3861 | Failed to update the task type because {reason}. | Failed to update the task. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3891 | Failed to operate the serverless cluster because {reason}. | Failed to operate the serverless cluster. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3893 | Failed to forward the CBC request to the cloud service. | Failed to forward the CBC request to the cloud service. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3921 | Failed to create the app-auth API because {reason}. | Failed to register the API that supports application authentication. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3924 | Failed to create the application code for application {id} because {reason}. | Failed to create the AppCode of the application {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3925 | Failed to delete app-auth api {id} because {reason}. | Failed to delete API {ID} that supports application authentication. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3926 | Failed to reset the secret of application {id} because {reason}. | Failed to reset the private key of the application {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3927 | Failed to reset the application code of application {id} because {reason}. | Failed to reset the AppCode of the application {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3928 | Failed to obtain the app-auth API information because {reason}. | Failed to obtain information about the API that supports application authentication. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3932 | Failed to obtain the application information because {reason}. | Failed to obtain the application information. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3933 | Failed to delete application {id} because {reason}. | Failed to delete the application {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3934 | Failed to delete the application code of application {id} because {reason}. | Failed to delete the AppCode of the application {ID}. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3937 | Failed to authorize the app-auth API to the application because {reason}. | Failed to authorize the API to the application. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.3938 | Failed to unbind the app-auth API from the application because {reason}. | Failed to cancel the authorization from the API to the application. Fault cause: {fault cause}. | Locate the fault based on the failure cause. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7001 | Unknown workspace system error. Try again later or submit a service ticket for professional technical support. | An internal workspace error occurred. | Contact service O&M personnel. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7002 | Not gray user, please contact the administrator | Workspace authentication error. | Contact the administrator to check whether the user has permissions on the workspace. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7003 | no permission to get iam user list, please check permission | IAM permissions are incorrect. | Add the IAM permissions based on the error message. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7004 | the status of workspace: {workspaceID} is abnormal, can not execute [action: {action}] | You are not allowed to create resources when a workspace is in the normal state, for example, a deleted or failed workspace. | Create resources in a normal workspace. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7005 | workspace:{workspace} not existed | The workspace does not exist. | Ensure that the transferred workspace ID exists. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 400 | ModelArts.7006 | workspace number over limit, limit: {limit} | The number of workspaces exceeds the upper limit. | Delete unnecessary workspaces. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7001 | Workspace internal error | An unknown error occurs in the workspace. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7008 | workspace in read-only status, please wait a few minutes | The workspace is abnormal. Only the read-only operation is supported. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7009 | call {apiType} api failed | The workspace is abnormal. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7100 | get enterprise project id failed | EPS request error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| 500 | ModelArts.7101 | Call pdp auth api failed. | PDP request error. | System error. Contact technical support. | -+-------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/api-ref/result/common_parameters/index.rst b/modelarts/api-ref/result/common_parameters/index.rst deleted file mode 100644 index 1a3bf481..00000000 --- a/modelarts/api-ref/result/common_parameters/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_03_0093: - -================= -Common Parameters -================= - -.. toctree:: - :maxdepth: 1 - - status_code - error_codes - obtaining_a_project_id_and_name - obtaining_an_account_name_and_id - obtaining_a_username_and_id diff --git a/modelarts/api-ref/result/common_parameters/obtaining_a_project_id_and_name.rst b/modelarts/api-ref/result/common_parameters/obtaining_a_project_id_and_name.rst deleted file mode 100644 index a126a117..00000000 --- a/modelarts/api-ref/result/common_parameters/obtaining_a_project_id_and_name.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _modelarts_03_0147: - -Obtaining a Project ID and Name -=============================== - -Scenarios ---------- - -A project ID or name is required for some requests when an API is called. Therefore, obtain the project ID and name before calling the API. Use either of the following methods: - -- :ref:`Obtaining a Project ID and Name from the Console ` -- :ref:`Obtaining a Project ID by Calling an API ` - -.. _modelarts_03_0147__en-us_topic_0171436477_section1747620762418: - -Obtaining a Project ID and Name from the Console ------------------------------------------------- - -To do so, perform the following operations: - -#. Log in to the console. -#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list. -#. On the **My Settings** page, go to the **Project List** tab page, which is displayed by default. View the project ID and name in the project list. - -.. _modelarts_03_0147__en-us_topic_0171436477_section3926171216207: - -Obtaining a Project ID by Calling an API ----------------------------------------- - -The API for obtaining a project ID is **GET https://**\ *{iam-endpoint}*\ **/v3/projects**. To obtain *{iam-endpoint}*, see :ref:`Request URI `\ :ref:`Endpoints `. - -The following is an example response. For example, if ModelArts is deployed in the **xxx** region, the value of **name** in the response body is **xxx**. The value of **id** in **projects** is the project ID. - -.. code-block:: - - { - "projects": [{ - "domain_id": "65382450e8f64ac0870cd180d14e684b", - "is_domain": false, - "parent_id": "65382450e8f64ac0870cd180d14e684b", - "name": "xxx", - "description": "", - "links": { - "next": null, - "previous": null, - "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" - }, - "id": "a4a5d4098fb4474fa22cd05f897d6b99", - "enabled": true - }], - "links": { - "next": null, - "previous": null, - "self": "https://www.example.com/v3/projects" - } - } diff --git a/modelarts/api-ref/result/common_parameters/obtaining_a_username_and_id.rst b/modelarts/api-ref/result/common_parameters/obtaining_a_username_and_id.rst deleted file mode 100644 index 7b70c290..00000000 --- a/modelarts/api-ref/result/common_parameters/obtaining_a_username_and_id.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_03_0006: - -Obtaining a Username and ID -=========================== - -When you call APIs, certain requests require the username and ID. To obtain a username and ID, do as follows: - -#. Log in to the management console after registration. - -#. In the upper right corner, click your account avatar icon and choose **My Settings** from the drop-down list. - - On the **My Settings** page, view the username and ID. - - .. _modelarts_03_0006__en-us_topic_0000001124853294_fig173616433916: - - .. figure:: /_static/images/en-us_image_0000001126895190.png - :alt: **Figure 1** Viewing the username and ID - - - **Figure 1** Viewing the username and ID diff --git a/modelarts/api-ref/result/common_parameters/obtaining_an_account_name_and_id.rst b/modelarts/api-ref/result/common_parameters/obtaining_an_account_name_and_id.rst deleted file mode 100644 index 988ccabd..00000000 --- a/modelarts/api-ref/result/common_parameters/obtaining_an_account_name_and_id.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_03_0148: - -Obtaining an Account Name and ID -================================ - -When you call APIs, certain requests require the account name and ID. To obtain an account name and ID, do as follows: - -#. Sign up and log in to the console. - -#. Hover the cursor on the username and choose **My Credentials** from the drop-down list. - - On the **API Credentials** page, view the account name and ID. - - .. _modelarts_03_0148__en-us_topic_0171436478_fig816634061619: - - .. figure:: /_static/images/en-us_image_0000001126894914.png - :alt: **Figure 1** Viewing the account name and ID - - - **Figure 1** Viewing the account name and ID diff --git a/modelarts/api-ref/result/common_parameters/status_code.rst b/modelarts/api-ref/result/common_parameters/status_code.rst deleted file mode 100644 index 86ccd3f1..00000000 --- a/modelarts/api-ref/result/common_parameters/status_code.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _modelarts_03_0094: - -Status Code -=========== - -:ref:`Table 1 ` describes the status codes. - -.. _modelarts_03_0094__en-us_topic_0132773864_table1450010510213: - -.. table:: **Table 1** Status codes - - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Status Code | Code | Status Code Description | - +=======================+=================================+===========================================================================================================================================================================================================================================================================================================================================================================================================+ - | 100 | Continue | The client continues sending the request. | - | | | | - | | | This provisional response informs the client that part of the request has been received and has not yet been rejected by the server. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 101 | Switching Protocols | Switching protocols. The target protocol must be more advanced than the source protocol. | - | | | | - | | | For example, the current HTTP protocol is switched to a later version of HTTP. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 200 | OK | The request has been fulfilled. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 201 | Created | The request for creating a resource has been fulfilled. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 202 | Accepted | The request has been accepted, but the processing has not been completed. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 203 | Non-Authoritative Information | Non-authoritative information. The request is successful. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 204 | NoContent | The request has been fulfilled, but the HTTP response does not contain a response body. | - | | | | - | | | The status code is returned in response to an HTTP OPTIONS request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 205 | Reset Content | The server has fulfilled the request, but the requester is required to reset the content. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 206 | Partial Content | The server has successfully processed a part of the GET request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 300 | Multiple Choices | There are multiple options for the location of the requested resource. The response contains a list of resource characteristics and addresses from which the user or user agent (such as a browser) can choose the most appropriate one. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 301 | Moved Permanently | The requested resource has been assigned a new permanent URI, and the new URI is contained in the response. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 302 | Found | The requested resource resides temporarily under a different URI. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 303 | See Other | The response to the request can be found under a different URI, | - | | | | - | | | and should be retrieved using a GET or POST method. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 304 | Not Modified | The requested resource has not been modified. When the server returns this status code, it does not return any resources. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 305 | Use Proxy | The requested resource must be accessed through a proxy. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 306 | Unused | The HTTP status code is no longer used. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 400 | BadRequest | The request is invalid. | - | | | | - | | | Do not retry the request before modification. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 401 | Unauthorized | The status code is returned after the client provides the authentication information, indicating that the authentication information is incorrect or invalid. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 402 | Payment Required | This status code is reserved for future use. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 403 | Forbidden | The request has been rejected. | - | | | | - | | | The server has received and understood the request; yet it refused to respond, because the request is set to deny access. Do not retry the request before modification. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 404 | NotFound | The requested resource cannot be found. | - | | | | - | | | Do not retry the request before modification. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 405 | MethodNotAllowed | The request contains one or more methods not supported for the resource. | - | | | | - | | | Do not retry the request before modification. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 406 | Not Acceptable | The server cannot fulfill the request according to the content characteristics of the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 407 | Proxy Authentication Required | This status code is similar to 401, but the client must first authenticate itself with the proxy. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 408 | Request Time-out | The request timed out. | - | | | | - | | | The client may repeat the request without modifications at any time later. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 409 | Conflict | The request could not be processed due to a conflict with the current state of the resource. | - | | | | - | | | This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 410 | Gone | The requested resource is no longer available. | - | | | | - | | | The status code indicates that the requested resource has been deleted permanently. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 411 | Length Required | The server refuses to process the request without a defined **Content-Length**. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 412 | Precondition Failed | The server does not meet one of the preconditions that the requester puts on the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 413 | Request Entity Too Large | The request is larger than that a server is able to process. The server may close the connection to prevent the client from continuing the request. If the server cannot process the request temporarily, the response will contain a **Retry-After** header field. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 414 | Request-URI Too Large | The URI provided was too long for the server to process. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 415 | Unsupported Media Type | The server is unable to process the media format in the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 416 | Requested range not satisfiable | The requested range is invalid. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 417 | Expectation Failed | The server fails to meet the requirements of the **Expect** request-header field. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 422 | UnprocessableEntity | The request is well-formed but is unable to be processed due to semantic errors. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 429 | TooManyRequests | The client has sent excessive number of requests to the server within a given time (exceeding the limit on the access frequency of the client), or the server has received an excessive number of requests within a given time (beyond its processing capability). In this case, the client should resend the request after the time specified in the **Retry-After** header of the response has elapsed. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 500 | InternalServerError | The server is able to receive but unable to understand the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 501 | Not Implemented | The server does not support the requested function. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 502 | Bad Gateway | The server acting as a gateway or proxy has received an invalid request from a remote server. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 503 | ServiceUnavailable | The requested service is invalid. | - | | | | - | | | Do not retry the request before modification. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 504 | ServerTimeout | The request cannot be fulfilled within a given time. This status code is returned to the client only when the **Timeout** parameter is specified in the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 505 | HTTP Version not supported | The server does not support the HTTP protocol version used in the request. | - +-----------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/api-ref/result/data_management/data_export_task/creating_a_dataset_export_task.rst b/modelarts/api-ref/result/data_management/data_export_task/creating_a_dataset_export_task.rst deleted file mode 100644 index bf8f5981..00000000 --- a/modelarts/api-ref/result/data_management/data_export_task/creating_a_dataset_export_task.rst +++ /dev/null @@ -1,643 +0,0 @@ -.. _ExportTask: - -Creating a Dataset Export Task -============================== - -Function --------- - -This API is used to create a dataset export task to export a dataset to OBS or new datasets. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/export-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+===============================================================+================================================================================================================================================================================================================================================================+ - | annotation_format | No | String | Labeling format. The options are as follows: | - | | | | | - | | | | - **VOC**: VOC | - | | | | | - | | | | - **COCO**: COCO | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | No | String | Dataset ID. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | No | Integer | Dataset type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_format | No | Integer | Format of the exported directory. The options are as follows: | - | | | | | - | | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | | - | | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_params | No | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_type | No | Integer | Export type. The options are as follows: | - | | | | | - | | | | - **0**: labeled | - | | | | | - | | | | - **1**: unlabeled | - | | | | | - | | | | - **2**: all | - | | | | | - | | | | - **3**: conditional search | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | path | No | String | Export output path. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type_header | No | String | Prefix of the OBS path in the exported labeling file. The default value is **obs://**. You can set it to **s3://**. The image path starting with **obs** cannot be parsed during training. Set the path prefix in the exported **manifest** file to **s3://**. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Task status. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | No | String | Task ID. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | No | String | Format of a dataset version. The options are as follows: | - | | | | | - | | | | - **Default**: default format | - | | | | | - | | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | | - | | | | - **CSV**: CSV | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Dataset version ID. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether to write the column name in the first line of the CSV file during export. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: Write the column name in the first line of the CSV file. (Default value) | - | | | | | - | | | | - **false**: Do not write the column name in the first line of the CSV file. | - +--------------------+-----------------+---------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__request_exportparams: - -.. table:: **Table 3** ExportParams - - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============================+=================+===============================================================================+============================================================================================================================================================================+ - | clear_hard_property | No | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | | - | | | | - **true**: Clear hard example attributes. (Default value) | - | | | | | - | | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | No | String | Format of the dataset version to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | No | String | Name of the dataset version to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | No | String | Export destination. The options are as follows: | - | | | | | - | | | | - **DIR**: Export data to OBS. (Default value) | - | | | | | - | | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | No | String | Name of the new dataset to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | No | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | No | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | | - | | | | - **true**: Allocate the training set and validation set. | - | | | | | - | | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | No | Array of strings | ID list of exported samples. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | No | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | No | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__request_searchcondition: - -.. table:: **Table 4** SearchCondition - - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+===============================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | No | String | Filter by coefficient of difficulty. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | No | Integer | A frame in the video. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | No | String | Whether a sample is a hard sample. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | No | String | Filter by data source. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | No | String | CT dosage, filtered by dosage. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | No | :ref:`SearchLabels ` object | Label search criteria. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | No | String | Labeler. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SearchProp ` object | Search by sample attribute. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | No | String | Parent sample ID. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | No | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | No | String | Search by sample name, including the file name extension. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | No | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | | - | | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | | - | | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | | - | | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | String | Search by confidence. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | No | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | No | String | DICOM scanning time. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | No | String | A time point in the video. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__request_searchlabels: - -.. table:: **Table 5** SearchLabels - - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================+==============================================================================================================================================================+ - | labels | No | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | No | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | | - | | | | - **OR**: OR operation | - | | | | | - | | | | - **AND**: AND operation | - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__request_searchlabel: - -.. table:: **Table 6** SearchLabel - - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | No | String | Label name. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | No | String | Operation type between multiple attributes. The options are as follows: | - | | | | | - | | | | - **OR**: OR operation | - | | | | | - | | | | - **AND**: AND operation | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__request_searchprop: - -.. table:: **Table 7** SearchProp - - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+=======================================================================+ - | op | No | String | Relationship between attribute values. The options are as follows: | - | | | | | - | | | | - **AND**: AND relationship | - | | | | | - | | | | - **OR**: OR relationship | - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - | props | No | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 8** Response body parameters - - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================+===================================================================+ - | create_time | Long | Time when a task is created. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | error_code | String | Error code. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | export_type | Integer | Export type. The options are as follows: | - | | | | - | | | - **0**: labeled | - | | | | - | | | - **1**: unlabeled | - | | | | - | | | - **2**: all | - | | | | - | | | - **3**: conditional search | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | finished_sample_count | Integer | Number of completed samples. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | path | String | Export output path. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | progress | Float | Percentage of current task progress. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | status | String | Task status. The options are as follows: | - | | | | - | | | - **INIT**: initialized | - | | | | - | | | - **RUNNING**: running | - | | | | - | | | - **FAILED**: failed | - | | | | - | | | - **SUCCESSED**: completed | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | task_id | String | Task ID. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | update_time | Long | Time when a task is updated. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +-----------------------+----------------------------------------------------------------+-------------------------------------------------------------------+ - -.. _exporttask__response_exportparams: - -.. table:: **Table 9** ExportParams - - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+================================================================================+============================================================================================================================================================================+ - | clear_hard_property | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | - | | | - **true**: Clear hard example attributes. (Default value) | - | | | | - | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | String | Format of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | String | Name of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | String | Export destination. The options are as follows: | - | | | | - | | | - **DIR**: Export data to OBS. (Default value) | - | | | | - | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | String | Name of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | - | | | - **true**: Allocate the training set and validation set. | - | | | | - | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of strings | ID list of exported samples. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__response_searchcondition: - -.. table:: **Table 10** SearchCondition - - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__response_searchlabels: - -.. table:: **Table 11** SearchLabels - - +-----------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__response_searchlabel: - -.. table:: **Table 12** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _exporttask__response_searchprop: - -.. table:: **Table 13** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -Example Requests ----------------- - -- Creating an Export Task (Exporting Data to OBS) - - .. code-block:: - - { - "path" : "/test-obs/daoChu/", - "export_type" : 3, - "export_params" : { - "sample_state" : "", - "export_dest" : "DIR" - } - } - -- Creating an Export Task (Exporting Data to a New Dataset) - - .. code-block:: - - { - "path" : "/test-obs/classify/input/", - "export_type" : 3, - "export_params" : { - "sample_state" : "", - "export_dest" : "NEW_DATASET", - "export_new_dataset_name" : "dataset-export-test", - "export_new_dataset_work_path" : "/test-obs/classify/output/" - } - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "rF9NNoB56k5rtYKg2Y7" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_export_task/index.rst b/modelarts/api-ref/result/data_management/data_export_task/index.rst deleted file mode 100644 index 99ae2986..00000000 --- a/modelarts/api-ref/result/data_management/data_export_task/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _data_export: - -================ -Data Export Task -================ - -.. toctree:: - :maxdepth: 1 - - querying_the_dataset_export_task_list - creating_a_dataset_export_task - querying_the_status_of_a_dataset_export_task diff --git a/modelarts/api-ref/result/data_management/data_export_task/querying_the_dataset_export_task_list.rst b/modelarts/api-ref/result/data_management/data_export_task/querying_the_dataset_export_task_list.rst deleted file mode 100644 index 7392e921..00000000 --- a/modelarts/api-ref/result/data_management/data_export_task/querying_the_dataset_export_task_list.rst +++ /dev/null @@ -1,440 +0,0 @@ -.. _GetExportTasksStatusOfDataset: - -Querying the Dataset Export Task List -===================================== - -Function --------- - -This API is used to query the dataset export task list by page. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/export-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================================+ - | export_type | No | Integer | Export type. If this parameter is not specified, all types of export tasks are queried by default. The options are as follows: | - | | | | | - | | | | - **0**: labeled | - | | | | | - | | | | - **1**: unlabeled | - | | | | | - | | | | - **2**: all | - | | | | | - | | | | - **3**: conditional search | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================================================+===================================================================+ - | create_time | Long | Time when a task is created. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_code | String | Error code. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_tasks | Array of :ref:`ExportTaskStatusResp ` objects | Export task list | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_type | Integer | Export type. The options are as follows: | - | | | | - | | | - **0**: labeled | - | | | | - | | | - **1**: unlabeled | - | | | | - | | | - **2**: all | - | | | | - | | | - **3**: conditional search | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | finished_sample_count | Integer | Number of completed samples. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | path | String | Export output path. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | progress | Float | Percentage of current task progress. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | status | String | Task status. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | task_id | String | Task ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | total_count | Integer | Total number of export tasks | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | update_time | Long | Time when a task is updated. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +-----------------------+-------------------------------------------------------------------------------------------------------------+-------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_exportparams: - -.. table:: **Table 4** ExportParams - - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+===================================================================================================+============================================================================================================================================================================+ - | clear_hard_property | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | - | | | - **true**: Clear hard example attributes. (Default value) | - | | | | - | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | String | Format of the dataset version to which data is exported. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | String | Name of the dataset version to which data is exported. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | String | Export destination. The options are as follows: | - | | | | - | | | - **DIR**: Export data to OBS. (Default value) | - | | | | - | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | String | Name of the new dataset to which data is exported. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | - | | | - **true**: Allocate the training set and validation set. | - | | | | - | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of strings | ID list of exported samples. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+---------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_exporttaskstatusresp: - -.. table:: **Table 5** ExportTaskStatusResp - - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================================+===================================================================+ - | create_time | Long | Time when a task is created. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_code | String | Error code. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_type | Integer | Export type. The options are as follows: | - | | | | - | | | - **0**: labeled | - | | | | - | | | - **1**: unlabeled | - | | | | - | | | - **2**: all | - | | | | - | | | - **3**: conditional search | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | finished_sample_count | Integer | Number of completed samples. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | path | String | Export output path. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | progress | Float | Percentage of current task progress. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | status | String | Task status. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | task_id | String | Task ID. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | update_time | Long | Time when a task is updated. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +-----------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_searchcondition: - -.. table:: **Table 6** SearchCondition - - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+-----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_searchlabels: - -.. table:: **Table 7** SearchLabels - - +-----------------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+-------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_searchlabel: - -.. table:: **Table 8** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttasksstatusofdataset__response_searchprop: - -.. table:: **Table 9** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Export Task List by Page - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_count" : 2, - "export_tasks" : [ { - "task_id" : "rF9NNoB56k5rtYKg2Y7", - "path" : "/test-obs/classify/input/", - "export_type" : 3, - "version_format" : "Default", - "export_format" : 2, - "export_params" : { - "sample_state" : "", - "export_dest" : "NEW_DATASET", - "export_new_dataset_name" : "dataset-export-test", - "export_new_dataset_work_path" : "/test-obs/classify/output/", - "clear_hard_property" : true, - "clear_difficult" : false, - "train_sample_ratio" : 1.0, - "ratio_sample_usage" : false - }, - "status" : "SUCCESSED", - "progress" : 100.0, - "total_sample_count" : 20, - "finished_sample_count" : 20, - "create_time" : 1606103820120, - "update_time" : 1606103824823 - }, { - "task_id" : "TZMuy7OKbClkGCAc3gb", - "path" : "/test-obs/daoChu/", - "export_type" : 3, - "version_format" : "Default", - "export_format" : 2, - "export_params" : { - "sample_state" : "", - "export_dest" : "DIR", - "clear_hard_property" : true, - "clear_difficult" : false, - "train_sample_ratio" : 1.0, - "ratio_sample_usage" : false - }, - "status" : "SUCCESSED", - "progress" : 100.0, - "total_sample_count" : 20, - "finished_sample_count" : 20, - "create_time" : 1606103424662, - "update_time" : 1606103497519 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_export_task/querying_the_status_of_a_dataset_export_task.rst b/modelarts/api-ref/result/data_management/data_export_task/querying_the_status_of_a_dataset_export_task.rst deleted file mode 100644 index ee9eea88..00000000 --- a/modelarts/api-ref/result/data_management/data_export_task/querying_the_status_of_a_dataset_export_task.rst +++ /dev/null @@ -1,335 +0,0 @@ -.. _GetExportTaskStatusOfDataset: - -Querying the Status of a Dataset Export Task -============================================ - -Function --------- - -This API is used to query the status of a dataset export task. - -URI ---- - -GET /v2/{project_id}/datasets/{resource_id}/export-tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | resource_id | Yes | String | Resource ID. Currently, the dataset ID can be specified. | - +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of an export task. | - +-------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================================+===================================================================+ - | create_time | Long | Time when a task is created. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_code | String | Error code. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | export_type | Integer | Export type. The options are as follows: | - | | | | - | | | - **0**: labeled | - | | | | - | | | - **1**: unlabeled | - | | | | - | | | - **2**: all | - | | | | - | | | - **3**: conditional search | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | finished_sample_count | Integer | Number of completed samples. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | path | String | Export output path. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | progress | Float | Percentage of current task progress. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | status | String | Task status. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | task_id | String | Task ID. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | update_time | Long | Time when a task is updated. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +-----------------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------+ - -.. _getexporttaskstatusofdataset__response_exportparams: - -.. table:: **Table 3** ExportParams - - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+==================================================================================================+============================================================================================================================================================================+ - | clear_hard_property | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | - | | | - **true**: Clear hard example attributes. (Default value) | - | | | | - | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | String | Format of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | String | Name of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | String | Export destination. The options are as follows: | - | | | | - | | | - **DIR**: Export data to OBS. (Default value) | - | | | | - | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | String | Name of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | - | | | - **true**: Allocate the training set and validation set. | - | | | | - | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of strings | ID list of exported samples. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+--------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttaskstatusofdataset__response_searchcondition: - -.. table:: **Table 4** SearchCondition - - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttaskstatusofdataset__response_searchlabels: - -.. table:: **Table 5** SearchLabels - - +-----------------------+------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttaskstatusofdataset__response_searchlabel: - -.. table:: **Table 6** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _getexporttaskstatusofdataset__response_searchprop: - -.. table:: **Table 7** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Status of an Export Task (Exporting Data to OBS) - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/export-tasks/{task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "TZMuy7OKbClkGCAc3gb", - "path" : "/test-obs/daoChu/", - "export_type" : 3, - "version_format" : "Default", - "export_format" : 2, - "export_params" : { - "sample_state" : "", - "export_dest" : "DIR", - "clear_hard_property" : true, - "clear_difficult" : false, - "train_sample_ratio" : 1.0, - "ratio_sample_usage" : false - }, - "status" : "RUNNING", - "progress" : 0.0, - "create_time" : 1606103424662, - "update_time" : 1606103494124 - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_import_task/creating_an_import_task.rst b/modelarts/api-ref/result/data_management/data_import_task/creating_an_import_task.rst deleted file mode 100644 index 0987c2fa..00000000 --- a/modelarts/api-ref/result/data_management/data_import_task/creating_an_import_task.rst +++ /dev/null @@ -1,381 +0,0 @@ -.. _ImportTask: - -Creating an Import Task -======================= - -Function --------- - -This API is used to create a dataset import task to import samples and labels from the storage system to the dataset. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/import-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=============================================================+=================================================================================================================================================================================================================================+ - | annotation_format | No | String | Format of the labeling information. Currently, only object detection is supported. The options are as follows: | - | | | | | - | | | | - **VOC**: VOC | - | | | | | - | | | | - **COCO**: COCO | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | No | :ref:`DataSource ` object | Data source. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | difficult_only | No | Boolean | Whether to import only hard examples. The options are as follows: | - | | | | | - | | | | - **true**: Only difficult samples are imported. | - | | | | | - | | | | - **false**: All samples are imported. (Default value) | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | excluded_labels | No | Array of :ref:`Label ` objects | Do not import samples containing the specified label. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | final_annotation | No | Boolean | Whether to import data to the final state. The options are as follows: | - | | | | | - | | | | - **true**: Import data to the final state. (Default value) | - | | | | | - | | | | - **false**: Do not import data to the final state. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_annotations | No | Boolean | Whether to import labels. The options are as follows: | - | | | | | - | | | | - **true**: Import labels. (Default value) | - | | | | | - | | | | - **false**: Do not import labels. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_folder | No | String | Name of the subdirectory in the dataset storage directory after import. You can specify the same subdirectory for multiple import tasks to avoid repeated import of the same samples. This field is invalid for table datasets. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | No | String | Data source. The options are as follows: | - | | | | | - | | | | - **obs**: OBS bucket (default value) | - | | | | | - | | | | - **dws**: GaussDB(DWS) | - | | | | | - | | | | - **dli**: DLI | - | | | | | - | | | | - **rds**: RDS | - | | | | | - | | | | - **mrs**: MRS | - | | | | | - | | | | - **inference**: Inference service | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_path | No | String | OBS path or **manifest** path to be imported. | - | | | | | - | | | | - When importing a manifest file, ensure that the path is accurate to the manifest file. | - | | | | | - | | | | - When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_samples | No | Boolean | Whether to import samples. The options are as follows: | - | | | | | - | | | | - **true**: Import samples. (Default value) | - | | | | | - | | | | - **false**: Do not import samples. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_type | No | String | Import mode. The options are as follows: | - | | | | | - | | | | - **0**: Import by directory. | - | | | | | - | | | | - **1**: Import by manifest file. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | included_labels | No | Array of :ref:`Label ` objects | Import samples containing the specified label. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_format | No | :ref:`LabelFormat ` object | Label format. This parameter is used only for text datasets. | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: The first row in the file is the column name. | - | | | | | - | | | | - **false**: The first row in the file is not the column name. (Default value) | - +--------------------+-----------------+-------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _importtask__request_datasource: - -.. table:: **Table 3** DataSource - - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+===================================================================+============================================================================================================================+ - | data_path | No | String | Data source path. | - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | No | Integer | Data type. The options are as follows: | - | | | | | - | | | | - **0**: OBS bucket (default value) | - | | | | | - | | | | - **1**: GaussDB(DWS) | - | | | | | - | | | | - **2**: DLI | - | | | | | - | | | | - **3**: RDS | - | | | | | - | | | | - **4**: MRS | - | | | | | - | | | | - **5**: AI Gallery | - | | | | | - | | | | - **6**: Inference service | - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | No | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | No | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: The first row in the file is the column name. | - | | | | | - | | | | - **false**: The first row in the file is not the column name. | - +--------------------+-----------------+-------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _importtask__request_schemamap: - -.. table:: **Table 4** SchemaMap - - ========= ========= ====== =============================== - Parameter Mandatory Type Description - ========= ========= ====== =============================== - dest_name No String Name of the destination column. - src_name No String Name of the source column. - ========= ========= ====== =============================== - -.. _importtask__request_sourceinfo: - -.. table:: **Table 5** SourceInfo - - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================+ - | cluster_id | No | String | ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_mode | No | String | Running mode of an MRS cluster. The options are as follows: | - | | | | | - | | | | - **0**: normal cluster | - | | | | | - | | | | - **1**: security cluster | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_name | No | String | Name of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | database_name | No | String | Name of the database to which the table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | input | No | String | HDFS path of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | ip | No | String | IP address of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | port | No | String | Port number of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | queue_name | No | String | DLI queue name of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | subnet_id | No | String | Subnet ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | table_name | No | String | Name of the table to which a table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_name | No | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_password | No | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | vpc_id | No | String | ID of the VPC where an MRS cluster resides. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - -.. _importtask__request_label: - -.. table:: **Table 6** Label - - +-----------------+-----------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=============================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _importtask__request_labelattribute: - -.. table:: **Table 7** LabelAttribute - - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _importtask__request_labelattributevalue: - -.. table:: **Table 8** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _importtask__request_labelproperty: - -.. table:: **Table 9** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _importtask__request_labelformat: - -.. table:: **Table 10** LabelFormat - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+=========================================================================================================================================================================================================================================================================+ - | label_type | No | String | Label type of text classification. The options are as follows: | - | | | | | - | | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. | - | | | | | - | | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_label_separator | No | String | Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 11** Response body parameters - - ========= ====== ===================== - Parameter Type Description - ========= ====== ===================== - task_id String ID of an import task. - ========= ====== ===================== - -Example Requests ----------------- - -- Creating an Import Task (Importing Data from OBS) - - .. code-block:: - - { - "import_type" : "dir", - "import_path" : "s3://test-obs/daoLu_images/cat-dog/", - "included_tags" : [ ], - "import_annotations" : false, - "difficult_only" : false - } - -- Creating an Import Task (Importing Data from Manifest) - - .. code-block:: - - { - "import_type" : "manifest", - "import_path" : "s3://test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/V002.manifest", - "included_tags" : [ "cat", "dog", "Cat", "Dog" ], - "import_annotations" : true, - "difficult_only" : false - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "gfghHSokody6AJigS5A_m1dYqOw8vWCAznw1V28" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_import_task/index.rst b/modelarts/api-ref/result/data_management/data_import_task/index.rst deleted file mode 100644 index 43d3b4b3..00000000 --- a/modelarts/api-ref/result/data_management/data_import_task/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _data_import: - -================ -Data Import Task -================ - -.. toctree:: - :maxdepth: 1 - - querying_the_dataset_import_task_list - creating_an_import_task - querying_details_about_a_dataset_import_task diff --git a/modelarts/api-ref/result/data_management/data_import_task/querying_details_about_a_dataset_import_task.rst b/modelarts/api-ref/result/data_management/data_import_task/querying_details_about_a_dataset_import_task.rst deleted file mode 100644 index df56602c..00000000 --- a/modelarts/api-ref/result/data_management/data_import_task/querying_details_about_a_dataset_import_task.rst +++ /dev/null @@ -1,266 +0,0 @@ -.. _DescImportTask: - -Querying Details About a Dataset Import Task -============================================ - -Function --------- - -This API is used to query details about a dataset import task. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | Task ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========================+============================================================================+====================================================================================================================================================================+ - | annotated_sample_count | Long | Number of labeled samples. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a task is created. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | :ref:`DataSource ` object | Data source. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | elapsed_time | Long | Task running time, in seconds. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | file_statistics | :ref:`FileCopyProgress ` object | Progress of file copy. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_file_count | Long | Number of files that have been transferred. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_file_size | Long | Size of the file that has been transferred, in bytes. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_path | String | OBS path or **manifest** path to be imported. | - | | | | - | | | - When importing a manifest file, ensure that the path is accurate to the manifest file. | - | | | | - | | | - When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_type | Integer | Import mode. The options are as follows: | - | | | | - | | | - **0**: Import by directory. | - | | | | - | | | - **1**: Import by manifest file. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | imported_sample_count | Long | Number of imported samples. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | imported_sub_sample_count | Long | Number of imported subsamples. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Status of an import task. The options are as follows: | - | | | | - | | | - **QUEUING**: queuing | - | | | | - | | | - **STARTING**: execution started | - | | | | - | | | - **RUNNING**: running | - | | | | - | | | - **COMPLETED**: completed | - | | | | - | | | - **FAILED**: failed | - | | | | - | | | - **NOT_EXIST**: not found | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | Task ID. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_file_count | Long | Total number of files. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_file_size | Long | Total file size, in bytes. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Long | Total number of samples. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Long | Total number of subsamples generated from the parent samples. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Long | Number of samples to be confirmed. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_ms | Long | Time when a task is updated. | - +---------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descimporttask__response_datasource: - -.. table:: **Table 3** DataSource - - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================+============================================================================================================================+ - | data_path | String | Data source path. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | Integer | Data type. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - | | | | - | | | - **1**: GaussDB(DWS) | - | | | | - | | | - **2**: DLI | - | | | | - | | | - **3**: RDS | - | | | | - | | | - **4**: MRS | - | | | | - | | | - **5**: AI Gallery | - | | | | - | | | - **6**: Inference service | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the file is the column name. | - | | | | - | | | - **false**: The first row in the file is not the column name. | - +-----------------------+------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _descimporttask__response_schemamap: - -.. table:: **Table 4** SchemaMap - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - dest_name String Name of the destination column. - src_name String Name of the source column. - ========= ====== =============================== - -.. _descimporttask__response_sourceinfo: - -.. table:: **Table 5** SourceInfo - - +-----------------------+-----------------------+--------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================+ - | cluster_id | String | ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_mode | String | Running mode of an MRS cluster. The options are as follows: | - | | | | - | | | - **0**: normal cluster | - | | | | - | | | - **1**: security cluster | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_name | String | Name of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | database_name | String | Name of the database to which the table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | input | String | HDFS path of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | ip | String | IP address of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | port | String | Port number of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | queue_name | String | DLI queue name of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | subnet_id | String | Subnet ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | table_name | String | Name of the table to which a table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_name | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_password | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | vpc_id | String | ID of the VPC where an MRS cluster resides. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - -.. _descimporttask__response_filecopyprogress: - -.. table:: **Table 6** FileCopyProgress - - +--------------------+------+-------------------------------------------------------+ - | Parameter | Type | Description | - +====================+======+=======================================================+ - | file_num_finished | Long | Number of files that have been transferred. | - +--------------------+------+-------------------------------------------------------+ - | file_num_total | Long | Total number of files. | - +--------------------+------+-------------------------------------------------------+ - | file_size_finished | Long | Size of the file that has been transferred, in bytes. | - +--------------------+------+-------------------------------------------------------+ - | file_size_total | Long | Total file size, in bytes. | - +--------------------+------+-------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About an Import Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks/{task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "status" : "COMPLETED", - "task_id" : "gfghHSokody6AJigS5A_RHJ1zOkIoI3Nzwxj8nh", - "dataset_id" : "gfghHSokody6AJigS5A", - "import_path" : "obs://test-obs/daoLu_images/cat-dog/", - "import_type" : 0, - "total_sample_count" : 20, - "imported_sample_count" : 20, - "annotated_sample_count" : 20, - "total_sub_sample_count" : 0, - "imported_sub_sample_count" : 0, - "total_file_size" : 0, - "finished_file_count" : 0, - "finished_file_size" : 0, - "total_file_count" : 0, - "update_ms" : 1606114833955, - "create_time" : 1606114833874, - "elapsed_time" : 2 - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_import_task/querying_the_dataset_import_task_list.rst b/modelarts/api-ref/result/data_management/data_import_task/querying_the_dataset_import_task_list.rst deleted file mode 100644 index 7820fc9b..00000000 --- a/modelarts/api-ref/result/data_management/data_import_task/querying_the_dataset_import_task_list.rst +++ /dev/null @@ -1,288 +0,0 @@ -.. _ListImportTasks: - -Querying the Dataset Import Task List -===================================== - -Function --------- - -This API is used to query the dataset import task list by page. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/import-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+===============================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+-----------------------------------------------------------------------------------------------+-------------------------+ - | Parameter | Type | Description | - +==============+===============================================================================================+=========================+ - | import_tasks | Array of :ref:`ImportTaskStatusResp ` objects | List of import tasks. | - +--------------+-----------------------------------------------------------------------------------------------+-------------------------+ - | total_count | Integer | Number of import tasks. | - +--------------+-----------------------------------------------------------------------------------------------+-------------------------+ - -.. _listimporttasks__response_importtaskstatusresp: - -.. table:: **Table 4** ImportTaskStatusResp - - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========================+=============================================================================+====================================================================================================================================================================+ - | annotated_sample_count | Long | Number of labeled samples. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a task is created. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | :ref:`DataSource ` object | Data source. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | elapsed_time | Long | Task running time, in seconds. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | file_statistics | :ref:`FileCopyProgress ` object | Progress of file copy. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_file_count | Long | Number of files that have been transferred. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_file_size | Long | Size of the file that has been transferred, in bytes. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_path | String | OBS path or **manifest** path to be imported. | - | | | | - | | | - When importing a manifest file, ensure that the path is accurate to the manifest file. | - | | | | - | | | - When a path is imported as a directory, the dataset type can only support image classification, object detection, text classification, or sound classification. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_type | Integer | Import mode. The options are as follows: | - | | | | - | | | - **0**: Import by directory. | - | | | | - | | | - **1**: Import by manifest file. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | imported_sample_count | Long | Number of imported samples. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | imported_sub_sample_count | Long | Number of imported subsamples. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Status of an import task. The options are as follows: | - | | | | - | | | - **QUEUING**: queuing | - | | | | - | | | - **STARTING**: execution started | - | | | | - | | | - **RUNNING**: running | - | | | | - | | | - **COMPLETED**: completed | - | | | | - | | | - **FAILED**: failed | - | | | | - | | | - **NOT_EXIST**: not found | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | Task ID. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_file_count | Long | Total number of files. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_file_size | Long | Total file size, in bytes. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Long | Total number of samples. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Long | Total number of subsamples generated from the parent samples. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Long | Number of samples to be confirmed. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_ms | Long | Time when a task is updated. | - +---------------------------+-----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listimporttasks__response_datasource: - -.. table:: **Table 5** DataSource - - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================+============================================================================================================================+ - | data_path | String | Data source path. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | Integer | Data type. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - | | | | - | | | - **1**: GaussDB(DWS) | - | | | | - | | | - **2**: DLI | - | | | | - | | | - **3**: RDS | - | | | | - | | | - **4**: MRS | - | | | | - | | | - **5**: AI Gallery | - | | | | - | | | - **6**: Inference service | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the file is the column name. | - | | | | - | | | - **false**: The first row in the file is not the column name. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _listimporttasks__response_schemamap: - -.. table:: **Table 6** SchemaMap - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - dest_name String Name of the destination column. - src_name String Name of the source column. - ========= ====== =============================== - -.. _listimporttasks__response_sourceinfo: - -.. table:: **Table 7** SourceInfo - - +-----------------------+-----------------------+--------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================+ - | cluster_id | String | ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_mode | String | Running mode of an MRS cluster. The options are as follows: | - | | | | - | | | - **0**: normal cluster | - | | | | - | | | - **1**: security cluster | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_name | String | Name of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | database_name | String | Name of the database to which the table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | input | String | HDFS path of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | ip | String | IP address of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | port | String | Port number of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | queue_name | String | DLI queue name of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | subnet_id | String | Subnet ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | table_name | String | Name of the table to which a table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_name | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_password | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | vpc_id | String | ID of the VPC where an MRS cluster resides. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - -.. _listimporttasks__response_filecopyprogress: - -.. table:: **Table 8** FileCopyProgress - - +--------------------+------+-------------------------------------------------------+ - | Parameter | Type | Description | - +====================+======+=======================================================+ - | file_num_finished | Long | Number of files that have been transferred. | - +--------------------+------+-------------------------------------------------------+ - | file_num_total | Long | Total number of files. | - +--------------------+------+-------------------------------------------------------+ - | file_size_finished | Long | Size of the file that has been transferred, in bytes. | - +--------------------+------+-------------------------------------------------------+ - | file_size_total | Long | Total file size, in bytes. | - +--------------------+------+-------------------------------------------------------+ - -Example Requests ----------------- - -Obtaining the Dataset Import Task List - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/import-tasks - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_count" : 1, - "import_tasks" : [ { - "status" : "COMPLETED", - "task_id" : "gfghHSokody6AJigS5A_RHJ1zOkIoI3Nzwxj8nh", - "dataset_id" : "gfghHSokody6AJigS5A", - "import_path" : "obs://test-obs/daoLu_images/cat-dog/", - "import_type" : 0, - "total_sample_count" : 20, - "imported_sample_count" : 20, - "annotated_sample_count" : 20, - "total_sub_sample_count" : 0, - "imported_sub_sample_count" : 0, - "total_file_size" : 0, - "finished_file_count" : 0, - "finished_file_size" : 0, - "total_file_count" : 0, - "create_time" : 1606114833874, - "elapsed_time" : 2 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_management_apis.rst b/modelarts/api-ref/result/data_management/data_management_apis.rst deleted file mode 100644 index 05812d30..00000000 --- a/modelarts/api-ref/result/data_management/data_management_apis.rst +++ /dev/null @@ -1,174 +0,0 @@ -.. _modelarts_03_0299: - -Data Management APIs -==================== - -.. table:: **Table 1** Data management APIs - - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | API | Description | - +===========================+=================================================================================================================+============================================================================================================================================================================================================================+ - | Dataset Management | :ref:`Querying the Dataset List ` | Query created datasets by page based on specified conditions. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Dataset ` | Create a new dataset and determine whether to enable team labeling as needed. | - | | | | - | | | - Enable team labeling. The subsequent operations vary depending on the specified role. | - | | | | - | | | If a team is specified to assign labeling tasks, the team labeling task is started after the dataset is created. | - | | | | - | | | If a task manager is specified to assign labeling tasks, the manager calls the API in :ref:`Starting a Team Labeling Task ` to assign and start the team labeling tasks. | - | | | | - | | | - Disable team labeling. To enable team labeling later, call the API in :ref:`Creating a Team Labeling Task ` to create team labeling tasks for the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Dataset ` | Query details about a dataset, including the dataset name, type, and version name based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Modifying a Dataset ` | Modify basic information about a dataset, such as the dataset name, description, version, or labels. | - | | | | - | | | The modification takes effect in the entire dataset, including the samples in the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Dataset ` | Delete a dataset based on the dataset ID to release resources. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Dataset Statistics ` | Query dataset statistics, such as sample statistics, label statistics, or hard examples based on specified conditions. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Monitoring Data of a Dataset ` | Query the monitoring data of a dataset within a specified period, such as the number of labeled samples, number of unlabeled samples, and total number of samples at each time point within the period. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data Synchronization | :ref:`Synchronizing a Dataset ` | Synchronize data and labels from the dataset input path to the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Status of a Dataset Synchronization Task ` | Query the status of a data source synchronization task based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Labeling Data | :ref:`Updating Sample Labels in Batches ` | Label multiple samples in a dataset in batches. | - | | | | - | | | - Label unlabeled samples. You can use an existing label or create a new label. | - | | | - Add, modify, or delete labels for labeled samples. You can use an existing label or newly added label to modify an original label. Additionally, you can add an existing label or a new label to a sample. | - | | | | - | | | This API uses a new label list to overwrite the original one to update the sample label. For example, if an empty label list is used to overwrite the original one, all sample labels will be deleted. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Sample List ` | Query dataset samples by page based on specified conditions. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Adding Samples in Batches ` | Add samples to a dataset in batches for data labeling. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting Samples in Batches ` | Delete unused samples from a dataset in batches. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Sample ` | Query a single sample based on the sample ID, including the sample status and labels. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Sample Search Criteria ` | Obtain sample search criteria, such as the label list and attribute key-value pairs of the dataset based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Management | :ref:`Querying the Dataset Label List ` | Query the labels in a specified dataset version. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Dataset Label ` | During dataset labeling, new labels can be created. This function is available only in datasets of the text classification and named entity types. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Modifying Labels in Batches ` | Modify dataset labels in batches. The modification takes effect in the entire dataset, including the samples in the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting Labels in Batches ` | Delete dataset labels in batches and ask you to determine whether to delete the samples with the labels. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating a Label by Label Name ` | Modify a label in a dataset based on the label name. The modification takes effect in the entire dataset, including the samples in the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Label and the Files with This Label Only ` | Delete a label in a dataset based on the label name and ask you to determine whether to delete the samples with the label. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Importing Data | :ref:`Querying the Dataset Import Task List ` | Query historical tasks imported to a dataset by page based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Dataset Import Task ` | Create a dataset import task to import labels and data (such as Manifest files and OBS data) from a storage system to the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Dataset Import Task ` | Query details about a dataset import task based on the dataset ID and task ID to learn about the data source, import mode, and task status. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Exporting Data | :ref:`Querying the Dataset Export Task List ` | Query historical tasks exported from a dataset by page based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Dataset Export Task ` | Export certain data as a new dataset or to OBS. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Status of a Dataset Export Task ` | Query details about a dataset export task based on the dataset ID and task ID to learn about the export type, task status, and number of samples. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Publishing a Dataset | :ref:`Creating a Dataset Labeling Version ` | Publish the labeled dataset as a new version for model building. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Managing Dataset Versions | :ref:`Querying the Dataset Version List ` | Query the versions of a dataset based on the dataset ID to learn about the dataset version evolution. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Dataset Labeling Version ` | Publish a modified dataset as a new version. The modification includes labeling samples, adding samples, and deleting samples in the dataset. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Dataset Labeling Version ` | Query details about a specified dataset labeling version, including the name, description, number of files, and storage path based on the dataset ID and version ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Dataset Labeling Version ` | Delete a dataset version based on the dataset ID and version ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Auto Labeling | :ref:`Querying the Auto Labeling Sample List ` | Query the to-be-confirmed auto labeling samples in a dataset by page based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About an Auto Labeling Sample ` | Query information of a single auto labeling sample based on the dataset ID and sample ID, such as the sample labels, hard example details, and sample type. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Auto Labeling Tasks by Page ` | Query all auto labeling tasks by page based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Starting an Auto Labeling Task ` | Start an auto labeling task for unlabeled data to quickly label the data. After the auto labeling task is complete, call the API in :ref:`Updating Sample Labels in Batches ` to check the labeling result. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About an Auto Labeling Task ` | Query details about an auto labeling task based on the dataset ID and task ID to learn about the task configuration, name, and status. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Stopping an Auto Labeling Task ` | Stop an ongoing auto labeling task based on the dataset ID and task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Auto Grouping | :ref:`Querying Auto Grouping Tasks by Page ` | Query all auto grouping tasks by page based on the dataset ID. | - | | | | - | | | In auto grouping, unlabeled images are clustered using a clustering algorithm and then processed based on the clustering result. Images can be labeled by group or cleaned. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Starting an Auto Grouping Task ` | Execute an auto grouping task based on selected data samples to improve data labeling efficiency. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About an Auto Grouping Task ` | Query details about an auto grouping task based on the dataset ID and task ID to learn about the task configuration, name, and status. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Stopping an Auto Grouping Task ` | Stop an ongoing auto grouping task based on the dataset ID and task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Team Labeling | :ref:`Querying Statistics for a Team Labeling Task ` | Query statistics for a team labeling task on the data labeling platform, such as the sample statistics, label statistics, and hard example set based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Statistics for the Member Labeling Progresses in a Team Labeling Task ` | Query statistics for the member labeling progresses in a team labeling task based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Team Labeling Task List of a Dataset ` | Query the team labeling tasks of a dataset based on the dataset ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Team Labeling Task ` | Create a team labeling task based on an existing dataset so that multiple members can concurrently label the dataset. | - | | | | - | | | - If a team is specified to assign labeling tasks, the team labeling task is started after the task is created. | - | | | - If a task manager is specified to assign labeling tasks, the manager calls the API in :ref:`Starting a Team Labeling Task ` to assign and start the team labeling tasks. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Team Labeling Task ` | Query details about a team labeling task based on the dataset ID and team labeling task ID, including the task name, data, and team information. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Starting a Team Labeling Task ` | The team labeling task manager assigns and starts a team labeling task on the data labeling platform based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating a Team Labeling Task ` | Update the description, name, and team information of a team labeling task based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Team Labeling Task ` | Delete a team labeling task based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Team Labeling Acceptance Task ` | Initiate an acceptance task for a team labeling task based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Acceptance Report of a Team Labeling Task ` | Query the acceptance report and statistics for a team labeling task based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating the Status of a Team Labeling Acceptance Task ` | Determine the acceptance scope for a team labeling task, including all labeled data, and update the sample data accordingly. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying the Sample List of a Team Labeling Task by Page ` | Query the samples of a team labeling task on the data labeling platform by page based on the dataset ID and team labeling task ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Team Labeling Sample ` | Query details about a sample in a team labeling task on the data labeling platform based on the dataset ID, team labeling task ID, and sample ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Team Labeling Tasks by Team Member ` | Members in a team labeling task query all team labeling tasks on the data labeling platform by page. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Submitting Sample Review Comments for Acceptance ` | During the acceptance of a team labeling task, provide review comments on samples, including the review result and score. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Reviewing Team Labeling Results ` | The manager of a team labeling task reviews the team labeling task on the data labeling platform based on the dataset ID and team labeling task ID, determines the review result, and provides review comments. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating Labels of Team Labeling Samples in Batches ` | Update sample labels on the data labeling platform in batches, including adding, modifying, and deleting the sample labels. Ensure that only the labels in the dataset can be added or modified. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Labeling Team | :ref:`Querying the Labeling Team List ` | Query all labeling teams by page. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Labeling Team ` | Add a labeling team. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Labeling Team ` | Query details about a labeling team, including the team name, description, and total number of members based on the team ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating a Labeling Team ` | Update the name and description of a labeling team based on the team ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Labeling Team ` | Delete a labeling team based on the team ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Sending an Email to Labeling Team Members ` | Enable automatic email sending to members in a labeling team to notify them of starting the team labeling task after the task is created. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying All Labeling Team Members ` | Query all labeling team members by page based on specified conditions. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Members in a Labeling Team ` | Query members in a labeling team by page based on the team ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Creating a Labeling Team Member ` | Add new members to a labeling team. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting Labeling Team Members in Batches ` | Delete multiple members from a labeling team in batches. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Querying Details About a Labeling Team Member ` | Query details about a member in a labeling team, including the member description, email address, and role based on the team ID and member ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Updating Labeling Team Members ` | Update the description and role of a member in a labeling team based on the team ID and member ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | :ref:`Deleting a Labeling Team Member ` | Delete a member from a labeling team based on the team ID and member ID. | - +---------------------------+-----------------------------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/api-ref/result/data_management/data_synchronization_task/index.rst b/modelarts/api-ref/result/data_management/data_synchronization_task/index.rst deleted file mode 100644 index b59c15ef..00000000 --- a/modelarts/api-ref/result/data_management/data_synchronization_task/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _data_sync: - -========================= -Data Synchronization Task -========================= - -.. toctree:: - :maxdepth: 1 - - synchronizing_a_dataset - querying_the_status_of_a_dataset_synchronization_task diff --git a/modelarts/api-ref/result/data_management/data_synchronization_task/querying_the_status_of_a_dataset_synchronization_task.rst b/modelarts/api-ref/result/data_management/data_synchronization_task/querying_the_status_of_a_dataset_synchronization_task.rst deleted file mode 100644 index 88e38c53..00000000 --- a/modelarts/api-ref/result/data_management/data_synchronization_task/querying_the_status_of_a_dataset_synchronization_task.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. _SyncDataSourceState: - -Querying the Status of a Dataset Synchronization Task -===================================================== - -Function --------- - -This API is used to query the status of a dataset synchronization task. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/sync-data/status - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+-----------------------+-----------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================+ - | add_sample_count | Long | Number of added samples. | - +-----------------------+-----------------------+-----------------------------------------------+ - | create_time | Long | Task creation time. | - +-----------------------+-----------------------+-----------------------------------------------+ - | dataset_id | String | Dataset ID. | - +-----------------------+-----------------------+-----------------------------------------------+ - | deleted_sample_count | Long | Number of deleted samples. | - +-----------------------+-----------------------+-----------------------------------------------+ - | duration_time | Long | Task running time. | - +-----------------------+-----------------------+-----------------------------------------------+ - | error_code | String | Error code. | - +-----------------------+-----------------------+-----------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+-----------------------------------------------+ - | status | String | Status of a task. The options are as follows: | - | | | | - | | | - **QUEUING**: queuing | - | | | | - | | | - **STARTING**: execution started | - | | | | - | | | - **RUNNING**: running | - | | | | - | | | - **COMPLETED**: completed | - | | | | - | | | - **FAILED**: failed | - | | | | - | | | - **NOT_EXIST**: not found | - +-----------------------+-----------------------+-----------------------------------------------+ - | task_id | String | Synchronization task ID. | - +-----------------------+-----------------------+-----------------------------------------------+ - | total_sample_count | Long | Total number of samples. | - +-----------------------+-----------------------+-----------------------------------------------+ - -Example Requests ----------------- - -Obtaining the Status of a Dataset Synchronization - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data/status - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "status" : "COMPLETED", - "dataset_id" : "gfghHSokody6AJigS5A" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/data_synchronization_task/synchronizing_a_dataset.rst b/modelarts/api-ref/result/data_management/data_synchronization_task/synchronizing_a_dataset.rst deleted file mode 100644 index e33d0b98..00000000 --- a/modelarts/api-ref/result/data_management/data_synchronization_task/synchronizing_a_dataset.rst +++ /dev/null @@ -1,65 +0,0 @@ -.. _SyncDataSource: - -Synchronizing a Dataset -======================= - -Function --------- - -This API is used to synchronize samples and labeling information from the input dataset path to the dataset. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/sync-data - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Synchronizing a Dataset - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/sync-data - -Example Responses ------------------ - -None - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/creating_a_dataset.rst b/modelarts/api-ref/result/data_management/dataset_management/creating_a_dataset.rst deleted file mode 100644 index 7e0f4e31..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/creating_a_dataset.rst +++ /dev/null @@ -1,581 +0,0 @@ -.. _CreateDataset: - -Creating a Dataset -================== - -Function --------- - -This API is used to create a dataset. - -URI ---- - -POST /v2/{project_id}/datasets - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+==================================================================================+===============================================================================================================================================================================================================================================================================================================================+ - | data_format | No | String | Data format. The options are as follows: | - | | | | | - | | | | - **Default**: default format | - | | | | | - | | | | - **CarbonData**: CarbonData (supported only by table datasets) | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_sources | No | Array of :ref:`DataSource ` objects | Input dataset path, which is used to synchronize source data (such as images, text files, and audio files) in the directory and its subdirectories to the dataset. For a table dataset, this parameter indicates the import directory. The work directory of a table dataset cannot be an OBS path in a KMS-encrypted bucket. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | Yes | String | Dataset name. The value contains 1 to 100 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed, for example, dataset-9f3b. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | No | Integer | Dataset type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Dataset description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_annotations | No | Boolean | Whether to automatically import the labeling information in the input directory, supporting detection, image classification, and text classification. The options are as follows: | - | | | | | - | | | | - **true**: Import labeling information in the input directory. (Default value) | - | | | | | - | | | | - **false**: Do not import labeling information in the input directory. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_data | No | Boolean | Whether to import data. This parameter is used only for table datasets. The options are as follows: | - | | | | | - | | | | - **true**: Import data when creating a database. | - | | | | | - | | | | - **false**: Do not import data when creating a database. (Default value) | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_format | No | :ref:`LabelFormat ` object | Label format information. This parameter is used only for text datasets. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labels | No | Array of :ref:`Label ` objects | Dataset label list. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | managed | No | Boolean | Whether to host a dataset. The options are as follows: | - | | | | | - | | | | - **true**: Host a dataset. | - | | | | | - | | | | - **false**: Do not host a dataset. (Default value) | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schema | No | Array of :ref:`Field ` objects | Schema list. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | Yes | String | Output dataset path, which is used to store output files such as label files. | - | | | | | - | | | | - The format is /*Bucket name*/*File path*, for example, /**obs-bucket**/**flower**/**rose**/. (The directory is used as the path.) | - | | | | | - | | | | - A bucket cannot be directly used as a path. | - | | | | | - | | | | - The output dataset path is different from the input dataset path or its subdirectory. | - | | | | | - | | | | - The value contains 3 to 700 characters. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path_type | Yes | Integer | Type of the dataset output path. The options are as follows: | - | | | | | - | | | | - **0**: OBS bucket (default value) | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_information | No | :ref:`WorkforceInformation ` object | Team labeling information. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------------+-----------------+----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_datasource: - -.. table:: **Table 3** DataSource - - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+======================================================================+============================================================================================================================+ - | data_path | No | String | Data source path. | - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | No | Integer | Data type. The options are as follows: | - | | | | | - | | | | - **0**: OBS bucket (default value) | - | | | | | - | | | | - **1**: GaussDB(DWS) | - | | | | | - | | | | - **2**: DLI | - | | | | | - | | | | - **3**: RDS | - | | | | | - | | | | - **4**: MRS | - | | | | | - | | | | - **5**: AI Gallery | - | | | | | - | | | | - **6**: Inference service | - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | No | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | No | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: The first row in the file is the column name. | - | | | | | - | | | | - **false**: The first row in the file is not the column name. | - +--------------------+-----------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_schemamap: - -.. table:: **Table 4** SchemaMap - - ========= ========= ====== =============================== - Parameter Mandatory Type Description - ========= ========= ====== =============================== - dest_name No String Name of the destination column. - src_name No String Name of the source column. - ========= ========= ====== =============================== - -.. _createdataset__request_sourceinfo: - -.. table:: **Table 5** SourceInfo - - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================+ - | cluster_id | No | String | ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_mode | No | String | Running mode of an MRS cluster. The options are as follows: | - | | | | | - | | | | - **0**: normal cluster | - | | | | | - | | | | - **1**: security cluster | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_name | No | String | Name of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | database_name | No | String | Name of the database to which the table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | input | No | String | HDFS path of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | ip | No | String | IP address of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | port | No | String | Port number of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | queue_name | No | String | DLI queue name of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | subnet_id | No | String | Subnet ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | table_name | No | String | Name of the table to which a table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_name | No | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_password | No | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | vpc_id | No | String | ID of the VPC where an MRS cluster resides. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - -.. _createdataset__request_labelformat: - -.. table:: **Table 6** LabelFormat - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+=========================================================================================================================================================================================================================================================================+ - | label_type | No | String | Label type of text classification. The options are as follows: | - | | | | | - | | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. | - | | | | | - | | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_label_separator | No | String | Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_label: - -.. table:: **Table 7** Label - - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+================================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_labelattribute: - -.. table:: **Table 8** LabelAttribute - - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==========================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _createdataset__request_labelattributevalue: - -.. table:: **Table 9** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _createdataset__request_labelproperty: - -.. table:: **Table 10** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_field: - -.. table:: **Table 11** Field - - =========== ========= ======= =================== - Parameter Mandatory Type Description - =========== ========= ======= =================== - description No String Schema description. - name No String Schema name. - schema_id No Integer Schema ID. - type No String Schema value type. - =========== ========= ======= =================== - -.. _createdataset__request_workforceinformation: - -.. table:: **Table 12** WorkforceInformation - - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================================+=================+==========================================================================+===============================================================================================================================================================================+ - | data_sync_type | No | Integer | Synchronization type. The options are as follows: | - | | | | | - | | | | - **0**: not to be synchronized | - | | | | | - | | | | - **1**: data to be synchronized | - | | | | | - | | | | - **2**: label to be synchronized | - | | | | | - | | | | - **3**: data and label to be synchronized | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repetition | No | Integer | Number of persons who label each sample. The minimum value is **1**. | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_auto_labeling_data | No | Boolean | Whether to synchronously update auto labeling data. The options are as follows: | - | | | | | - | | | | - **true**: Update auto labeling data synchronously. | - | | | | | - | | | | - **false**: Do not update auto labeling data synchronously. | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_data | No | Boolean | Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: | - | | | | | - | | | | - **true**: Synchronize updated data to team members. | - | | | | | - | | | | - **false**: Do not synchronize updated data to team members. | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | No | String | ID of a team labeling task. | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | Yes | String | Name of a team labeling task. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforces_config | No | :ref:`WorkforcesConfig ` object | Manpower assignment of a team labeling task. You can delegate the administrator to assign the manpower or do it by yourself. | - +--------------------------------+-----------------+--------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_workforcesconfig: - -.. table:: **Table 13** WorkforcesConfig - - +------------+-----------+----------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+==================================================================================+============================================+ - | agency | No | String | Administrator. | - +------------+-----------+----------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | No | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+-----------+----------------------------------------------------------------------------------+--------------------------------------------+ - -.. _createdataset__request_workforceconfig: - -.. table:: **Table 14** WorkforceConfig - - +----------------+-----------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+================================================================+=================================================================================================================================+ - | workers | No | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+-----------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +----------------+-----------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | No | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+-----------+----------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _createdataset__request_worker: - -.. table:: **Table 15** Worker - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | create_time | No | Long | Creation time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | No | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - | | | | | - | | | | - **3**: dataset owner | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | | - | | | | - **0**: The invitation email has not been sent. | - | | | | | - | | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | | - | | | | - **2**: The user has logged in. | - | | | | | - | | | | - **3**: The labeling team member has been deleted. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | No | Long | Update time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 201** - -.. table:: **Table 16** Response body parameters - - ============== ====== ===================== - Parameter Type Description - ============== ====== ===================== - dataset_id String Dataset ID. - error_code String Error code. - error_msg String Error message. - import_task_id String ID of an import task. - ============== ====== ===================== - -Example Requests ----------------- - -- Creating an Image Classification Dataset - - .. code-block:: - - { - "workspace_id" : "0", - "dataset_name" : "dataset-457f", - "dataset_type" : 0, - "data_sources" : [ { - "data_type" : 0, - "data_path" : "/test-obs/classify/input/cat-dog/" - } ], - "description" : "", - "work_path" : "/test-obs/classify/output/", - "work_path_type" : 0, - "labels" : [ { - "name" : "Cat", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ] - } - -- Creating an Object Detection Dataset - - .. code-block:: - - { - "workspace_id" : "0", - "dataset_name" : "dataset-95a6", - "dataset_type" : 1, - "data_sources" : [ { - "data_type" : 0, - "data_path" : "/test-obs/detect/input/cat-dog/" - } ], - "description" : "", - "work_path" : "/test-obs/detect/output/", - "work_path_type" : 0, - "labels" : [ { - "name" : "Cat", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ] - } - -- Creating a Table Dataset - - .. code-block:: - - { - "workspace_id" : "0", - "dataset_name" : "dataset-de83", - "dataset_type" : 400, - "data_sources" : [ { - "data_type" : 0, - "data_path" : "/test-obs/table/input/", - "with_column_header" : true - } ], - "description" : "", - "work_path" : "/test-obs/table/output/", - "work_path_type" : 0, - "schema" : [ { - "schema_id" : 1, - "name" : "150", - "type" : "STRING" - }, { - "schema_id" : 2, - "name" : "4", - "type" : "STRING" - }, { - "schema_id" : 3, - "name" : "setosa", - "type" : "STRING" - }, { - "schema_id" : 4, - "name" : "versicolor", - "type" : "STRING" - }, { - "schema_id" : 5, - "name" : "virginica", - "type" : "STRING" - } ], - "import_data" : true - } - -Example Responses ------------------ - -**Status code: 201** - -Created - -.. code-block:: - - { - "dataset_id" : "WxCREuCkBSAlQr9xrde" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -201 Created -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/deleting_a_dataset.rst b/modelarts/api-ref/result/data_management/dataset_management/deleting_a_dataset.rst deleted file mode 100644 index 07b5a7a0..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/deleting_a_dataset.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. _DeleteDataset: - -Deleting a Dataset -================== - -Function --------- - -This API is used to delete a dataset without deleting the source data of the dataset. - -URI ---- - -DELETE /v2/{project_id}/datasets/{dataset_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Dataset - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/index.rst b/modelarts/api-ref/result/data_management/dataset_management/index.rst deleted file mode 100644 index 5e1fec05..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _dataset_management: - -================== -Dataset Management -================== - -.. toctree:: - :maxdepth: 1 - - response_body_for_querying_the_dataset_list. - creating_a_dataset - querying_details_about_a_dataset - modifying_a_dataset - deleting_a_dataset - querying_dataset_statistics - querying_the_monitoring_data_of_a_dataset - querying_details_about_team_labeling_task_statistics - querying_details_about_the_progress_of_a_team_labeling_task_member diff --git a/modelarts/api-ref/result/data_management/dataset_management/modifying_a_dataset.rst b/modelarts/api-ref/result/data_management/dataset_management/modifying_a_dataset.rst deleted file mode 100644 index f6164c40..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/modifying_a_dataset.rst +++ /dev/null @@ -1,210 +0,0 @@ -.. _UpdateDataset: - -Modifying a Dataset -=================== - -Function --------- - -This API is used to modify basic information about a dataset, such as the dataset name, description, current version, and labels. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+===========+==============================================================+=============================================================================================================================+ - | add_labels | No | Array of :ref:`Label ` objects | List of added labels. | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | current_version_id | No | String | ID of current dataset version. | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | No | String | Dataset name. | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | delete_labels | No | Array of :ref:`Label ` objects | List of deleted labels. | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Dataset description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | update_labels | No | Array of :ref:`Label ` objects | List of updated labels. | - +--------------------+-----------+--------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. _updatedataset__request_label: - -.. table:: **Table 3** Label - - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+================================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _updatedataset__request_labelattribute: - -.. table:: **Table 4** LabelAttribute - - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==========================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _updatedataset__request_labelattributevalue: - -.. table:: **Table 5** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _updatedataset__request_labelproperty: - -.. table:: **Table 6** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - dataset_id String Dataset ID. - ========== ====== =========== - -Example Requests ----------------- - -Modifying a Dataset - -.. code-block:: - - { - "dataset_id" : "gfghHSokody6AJigS5A", - "description" : "just a test", - "add_tags" : [ { - "name" : "Pig", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "dataset_id" : "gfghHSokody6AJigS5A" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/querying_dataset_statistics.rst b/modelarts/api-ref/result/data_management/dataset_management/querying_dataset_statistics.rst deleted file mode 100644 index f7621af1..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/querying_dataset_statistics.rst +++ /dev/null @@ -1,296 +0,0 @@ -.. _ListStats: - -Querying Dataset Statistics -=========================== - -Function --------- - -This API is used to query dataset statistics. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/stats - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================+ - | email | No | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **zh-cn**: Chinese | - | | | | | - | | | | - **en-us**: English (default value) | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - | sample_state | No | String | Query statistics on samples in a specified state. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=====================================================================+==================================================================================================================================================================================================================================================================================================================+ - | data_path | String | Path for storing data of a dataset. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_spliting_enable | Boolean | Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows: | - | | | | - | | | - **true**: The dataset can be split into training set and validation set. | - | | | | - | | | - **false**: The dataset cannot be split into training set and validation set. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grouped_label_stats | Map> | Label statistics grouped by labeling type. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard_detail_stats | Map | Statistics on hard example reasons. The type is **Map>**. The **key** of Map indicates the ID of the hard example reason, the **key** of Pair indicates the number of times that the hard example reason occurs, and the **value** of Pair indicates the hard example reason. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_sample_stats | Map | Statistics on hard examples. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | List of label statistics. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata_stats | Map | Statistics on sample metadata, in JSON format. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_stats | Map | Statistics on sample status. | - +-----------------------+---------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _liststats__response_labelstats: - -.. table:: **Table 4** LabelStats - - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _liststats__response_labelproperty: - -.. table:: **Table 5** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** PairOfintAndHardDetail - - +-----------+-----------------------------------------------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +===========+===========================================================+====================================================+ - | key | Integer | Number of times that a hard example reason occurs. | - +-----------+-----------------------------------------------------------+----------------------------------------------------+ - | value | :ref:`HardDetail ` object | Reason for a hard example. | - +-----------+-----------------------------------------------------------+----------------------------------------------------+ - -.. _liststats__response_harddetail: - -.. table:: **Table 7** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _liststats__response_labelattribute: - -.. table:: **Table 8** LabelAttribute - - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+---------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _liststats__response_labelattributevalue: - -.. table:: **Table 9** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -Example Requests ----------------- - -Querying Dataset Statistics - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/stats - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "label_stats" : [ { - "name" : "Dog", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - }, - "count" : 8, - "sample_count" : 5 - } ], - "sample_stats" : { - "un_annotation" : 309, - "all" : 317, - "total" : 317, - "deleted" : 0, - "manual_annotation" : 8, - "auto_annotation" : 0, - "lefted" : 317 - }, - "key_sample_stats" : { - "total" : 317, - "non_key_sample" : 315, - "key_sample" : 2 - }, - "deletion_stats" : { }, - "metadata_stats" : { }, - "data_spliting_enable" : false - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_a_dataset.rst b/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_a_dataset.rst deleted file mode 100644 index 7841ad45..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_a_dataset.rst +++ /dev/null @@ -1,838 +0,0 @@ -.. _DescDataset: - -Querying Details About a Dataset -================================ - -Function --------- - -This API is used to query details about a dataset. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+=====================================================================================================================+ - | check_running_task | No | Boolean | Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows: | - | | | | | - | | | | - **true**: Detect tasks (including initialization tasks) that are running in the dataset. | - | | | | | - | | | | - **false**: Do not detect tasks that are running in the dataset. (Default value) | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------+ - | running_task_type | No | Integer | Type of the running tasks (including initialization tasks) to be detected. The options are as follows: | - | | | | | - | | | | - **0**: auto labeling | - | | | | | - | | | | - **1**: pre-labeling | - | | | | | - | | | | - **2**: export | - | | | | | - | | | | - **3**: version switch | - | | | | | - | | | | - **4**: manifest file export | - | | | | | - | | | | - **5**: manifest file import | - | | | | | - | | | | - **6**: version publishing | - | | | | | - | | | | - **7**: auto grouping | - | | | | | - | | | | - **10**: one-click model deployment (default value) | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+===============================================================================+==================================================================================================================================================================================+ - | annotated_sample_count | Integer | Number of labeled samples in a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | content_labeling | Boolean | Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a dataset is created. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_version_id | String | Current version ID of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_version_name | String | Current version name of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_format | String | Data format. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_sources | Array of :ref:`DataSource ` objects | Data source list. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_update_time | Long | Time when a sample and a label are updated. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_format | Integer | Dataset format. The options are as follows: | - | | | | - | | | - **0**: file | - | | | | - | | | - **1**: table | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset name. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_tags | Array of strings | Key identifier list of a dataset, for example, ["Image","Object detection"]. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | Integer | Dataset type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet | - | | | | - | | | - **200**: sound classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **400**: table dataset | - | | | | - | | | - **600**: video labeling | - | | | | - | | | - **900**: custom format | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_count | Integer | Number of dataset versions. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Dataset description. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | exist_running_task | Boolean | Whether the dataset contains running (including initialization) tasks. The options are as follows: | - | | | | - | | | - **true**: The dataset contains running tasks. | - | | | | - | | | - **false**: The dataset does not contain running tasks. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | exist_workforce_task | Boolean | Whether the dataset contains team labeling tasks. The options are as follows: | - | | | | - | | | - **true**: The dataset contains team labeling tasks. | - | | | | - | | | - **false**: The dataset does not contain team labeling tasks. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | feature_supports | Array of strings | List of features supported by the dataset. Currently, only the value **0** is supported, indicating that the OBS file size is limited. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_data | Boolean | Whether to import data. The options are as follows: | - | | | | - | | | - **true**: Import data. | - | | | | - | | | - **false**: Do not import data. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_task_id | String | ID of an import task. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_annotation_path | String | Path for storing the labeling result of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_data_path | String | Path for storing the internal data of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_log_path | String | Path for storing internal logs of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_task_path | String | Path for internal task of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_temp_path | String | Path for storing internal temporary files of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_work_path | String | Output directory of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_task_count | Integer | Number of labeling tasks. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`Label ` objects | Dataset label list. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | loading_sample_count | Integer | Number of loading samples. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | managed | Boolean | Whether a dataset is hosted. The options are as follows: | - | | | | - | | | - **true**: The dataset is hosted. | - | | | | - | | | - **false**: The dataset is not hosted. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_version_num | Integer | Number of next versions of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | running_tasks_id | Array of strings | ID list of running (including initialization) tasks. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schema | Array of :ref:`Field ` objects | Schema list. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Dataset status. The options are as follows: | - | | | | - | | | - **0**: creating dataset | - | | | | - | | | - **1**: normal dataset | - | | | | - | | | - **2**: deleting dataset | - | | | | - | | | - **3**: deleted dataset | - | | | | - | | | - **4**: abnormal dataset | - | | | | - | | | - **5**: synchronizing dataset | - | | | | - | | | - **6**: releasing dataset | - | | | | - | | | - **7**: dataset in version switching | - | | | | - | | | - **8**: importing dataset | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | third_path | String | Third-party path. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of dataset samples. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Integer | Number of auto labeling samples to be confirmed. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a dataset is updated. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | versions | Array of :ref:`DatasetVersion ` objects | Dataset version information. Currently, only the current version information of a dataset is recorded. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | String | Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /*Bucket name*/*File path*. For example: /**obs-bucket**. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path_type | Integer | Type of the dataset output path. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_descriptor | :ref:`WorkforceDescriptor ` object | Team labeling information. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_task_count | Integer | Number of team labeling tasks of a dataset. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +----------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_datasource: - -.. table:: **Table 4** DataSource - - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=====================================================================+============================================================================================================================+ - | data_path | String | Data source path. | - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | Integer | Data type. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - | | | | - | | | - **1**: GaussDB(DWS) | - | | | | - | | | - **2**: DLI | - | | | | - | | | - **3**: RDS | - | | | | - | | | - **4**: MRS | - | | | | - | | | - **5**: AI Gallery | - | | | | - | | | - **6**: Inference service | - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the file is the column name. | - | | | | - | | | - **false**: The first row in the file is not the column name. | - +-----------------------+---------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_schemamap: - -.. table:: **Table 5** SchemaMap - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - dest_name String Name of the destination column. - src_name String Name of the source column. - ========= ====== =============================== - -.. _descdataset__response_sourceinfo: - -.. table:: **Table 6** SourceInfo - - +-----------------------+-----------------------+--------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================+ - | cluster_id | String | ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_mode | String | Running mode of an MRS cluster. The options are as follows: | - | | | | - | | | - **0**: normal cluster | - | | | | - | | | - **1**: security cluster | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_name | String | Name of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | database_name | String | Name of the database to which the table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | input | String | HDFS path of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | ip | String | IP address of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | port | String | Port number of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | queue_name | String | DLI queue name of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | subnet_id | String | Subnet ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | table_name | String | Name of the table to which a table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_name | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_password | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | vpc_id | String | ID of the VPC where an MRS cluster resides. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - -.. _descdataset__response_label: - -.. table:: **Table 7** Label - - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_labelproperty: - -.. table:: **Table 8** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_field: - -.. table:: **Table 9** Field - - =========== ======= =================== - Parameter Type Description - =========== ======= =================== - description String Schema description. - name String Schema name. - schema_id Integer Schema ID. - type String Schema value type. - =========== ======= =================== - -.. _descdataset__response_datasetversion: - -.. table:: **Table 10** DatasetVersion - - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================================+=======================================================================+==========================================================================================================================================================================+ - | add_sample_count | Integer | Number of added samples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sample_count | Integer | Number of samples with labeled versions. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | clear_hard_property | Boolean | Whether to clear hard example properties during release. The options are as follows: | - | | | | - | | | - **true**: Clear hard example properties. (Default value) | - | | | | - | | | - **false**: Do not clear hard example properties. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Status code of a preprocessing task such as rotation and cropping. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a version is created. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop | Boolean | Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: | - | | | | - | | | - **true**: Crop the image. | - | | | | - | | | - **false**: Do not crop the image. (Default value) | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_path | String | Path for storing cropped files. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_rotate_cache_path | String | Temporary directory for executing the rotation and cropping task. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_path | String | Path for storing data. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata in JSON format. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_validate | Boolean | Whether data is validated by the validation algorithm before release. The options are as follows: | - | | | | - | | | - **true**: The data has been validated. | - | | | | - | | | - **false**: The data has not been validated. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a version. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_images | Boolean | Whether to export images to the version output directory during release. The options are as follows: | - | | | | - | | | - **true**: Export images to the version output directory. | - | | | | - | | | - **false**: Do not export images to the version output directory. (Default value) | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extract_serial_number | Boolean | Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: | - | | | | - | | | - **true**: Parse the subsample number. | - | | | | - | | | - **false**: Do not parse the subsample number. (Default value) | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | include_dataset_data | Boolean | Whether to include the source data of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: The source data of a dataset is included. | - | | | | - | | | - **false**: The source data of a dataset is not included. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current dataset version is used. The options are as follows: | - | | | | - | | | - **true**: The current dataset version is used. | - | | | | - | | | - **false**: The current dataset version is not used. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics list of a released version. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | String | Label type of a released version. The options are as follows: | - | | | | - | | | - **multi**: Multi-label samples are included. | - | | | | - | | | - **single**: All samples are single-labeled. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_cache_input_path | String | Input path for the **manifest** file cache during version release. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** file with the released version. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Task information recorded during release (for example, error information). | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified samples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_annotated_sample_count | Integer | Number of labeled samples of parent versions. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_total_sample_count | Integer | Total samples of parent versions. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_version_id | String | Parent version ID | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task such as rotation and cropping. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task such as rotation and cropping. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - | | | | - | | | - **5**: timeout | - | | | | - | | | - **6**: deletion failed | - | | | | - | | | - **7**: stop failed | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remove_sample_usage | Boolean | Whether to clear the existing usage information of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: Clear the existing usage information of a dataset. (Default value) | - | | | | - | | | - **false**: Do not clear the existing usage information of a dataset. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate | Boolean | Whether to rotate the image. The options are as follows: | - | | | | - | | | - **true**: Rotate the image. | - | | | | - | | | - **false**: Do not rotate the image. (Default value) | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate_path | String | Path for storing the rotated file. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a dataset version. The options are as follows: | - | | | | - | | | - **0**: creating | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: deleting | - | | | | - | | | - **3**: deleted | - | | | | - | | | - **4**: error | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"]. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_type | Integer | Labeling task type of the released version, which is the same as the dataset type. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of version samples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_sample_ratio | String | Split training and verification ratio during version release. The default value is **1.00**, indicating that all labeled samples are split into the training set. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a version is updated. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the released CSV file is a column name. | - | | | | - | | | - **false**: The first row in the released CSV file is not a column name. | - +---------------------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_labelstats: - -.. table:: **Table 11** LabelStats - - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_labelattribute: - -.. table:: **Table 12** LabelAttribute - - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _descdataset__response_labelattributevalue: - -.. table:: **Table 13** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _descdataset__response_workforcedescriptor: - -.. table:: **Table 14** WorkforceDescriptor - - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================================+===============================================================+===============================================================================================================================================================================+ - | current_task_id | String | ID of a team labeling task. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_task_name | String | Name of a team labeling task. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reject_num | Integer | Number of rejected samples. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repetition | Integer | Number of persons who label each sample. The minimum value is **1**. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_synchronize_auto_labeling_data | Boolean | Whether to synchronously update auto labeling data. The options are as follows: | - | | | | - | | | - **true**: Update auto labeling data synchronously. | - | | | | - | | | - **false**: Do not update auto labeling data synchronously. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_synchronize_data | Boolean | Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: | - | | | | - | | | - **true**: Synchronize updated data to team members. | - | | | | - | | | - **false**: Do not synchronize updated data to team members. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workers | Array of :ref:`Worker ` objects | List of labeling team members. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. | - +-----------------------------------+---------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descdataset__response_worker: - -.. table:: **Table 15** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Dataset - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "dataset_id" : "gfghHSokody6AJigS5A", - "dataset_name" : "dataset-f9e8", - "dataset_type" : 0, - "data_format" : "Default", - "next_version_num" : 4, - "status" : 1, - "data_sources" : [ { - "data_type" : 0, - "data_path" : "/test-obs/classify/input/catDog4/" - } ], - "create_time" : 1605690595404, - "update_time" : 1605690595404, - "description" : "", - "current_version_id" : "54IXbeJhfttGpL46lbv", - "current_version_name" : "V003", - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "unconfirmed_sample_count" : 0, - "work_path" : "/test-obs/classify/output/", - "inner_work_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/", - "inner_annotation_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/", - "inner_data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/data/", - "inner_log_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/logs/", - "inner_temp_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/temp/", - "inner_task_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/task/", - "work_path_type" : 0, - "workspace_id" : "0", - "enterprise_project_id" : "0", - "workforce_task_count" : 0, - "feature_supports" : [ "0" ], - "managed" : false, - "import_data" : false, - "ai_project" : "default-ai-project", - "label_task_count" : 1, - "dataset_format" : 0, - "dataset_version_count" : 3, - "dataset_version" : "v1", - "content_labeling" : true, - "labels" : [ { - "name" : "Cat", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_team_labeling_task_statistics.rst b/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_team_labeling_task_statistics.rst deleted file mode 100644 index a0e741df..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_team_labeling_task_statistics.rst +++ /dev/null @@ -1,298 +0,0 @@ -.. _ListWorkforceTaskStats: - -Querying Details About Team Labeling Task Statistics -==================================================== - -Function --------- - -This API is used to query details about team labeling task statistics. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/stats - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================================================+ - | sample_state | No | String | Statistics on the specified sample state. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================================+==================================================================================================================================================================================================================================================================================================================+ - | data_path | String | Path for storing data of a dataset. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_spliting_enable | Boolean | Whether the dataset can be split into training set and validation set based on the sample labeling statistics. The options are as follows: | - | | | | - | | | - **true**: The dataset can be split into training set and validation set. | - | | | | - | | | - **false**: The dataset cannot be split into training set and validation set. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grouped_label_stats | Map> | Label statistics grouped by labeling type. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard_detail_stats | Map | Statistics on hard example reasons. The type is **Map>**. The **key** of Map indicates the ID of the hard example reason, the **key** of Pair indicates the number of times that the hard example reason occurs, and the **value** of Pair indicates the hard example reason. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_sample_stats | Map | Statistics on hard examples. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | List of label statistics. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata_stats | Map | Statistics on sample metadata, in JSON format. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_stats | Map | Statistics on sample status. | - +-----------------------+----------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetaskstats__response_labelstats: - -.. table:: **Table 4** LabelStats - - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetaskstats__response_labelproperty: - -.. table:: **Table 5** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** PairOfintAndHardDetail - - +-----------+------------------------------------------------------------------------+----------------------------------------------------+ - | Parameter | Type | Description | - +===========+========================================================================+====================================================+ - | key | Integer | Number of times that a hard example reason occurs. | - +-----------+------------------------------------------------------------------------+----------------------------------------------------+ - | value | :ref:`HardDetail ` object | Reason for a hard example. | - +-----------+------------------------------------------------------------------------+----------------------------------------------------+ - -.. _listworkforcetaskstats__response_harddetail: - -.. table:: **Table 7** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _listworkforcetaskstats__response_labelattribute: - -.. table:: **Table 8** LabelAttribute - - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listworkforcetaskstats__response_labelattributevalue: - -.. table:: **Table 9** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -Example Requests ----------------- - -Querying Statistics on Unapproved Samples of a Team Labeling Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/workforce-tasks/tY330MHxV9dqIPVaTRM/data-annotations/stats?sample_state=__unreviewed__ - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "label_stats" : [ { - "name" : "Cat", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - }, - "count" : 0, - "sample_count" : 0 - }, { - "name" : "Dog", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - }, - "count" : 1, - "sample_count" : 1 - } ], - "sample_stats" : { - "un_annotation" : 308, - "total" : 309, - "rejected" : 0, - "unreviewed" : 1, - "accepted" : 0, - "auto_annotation" : 0, - "uncheck" : 0 - }, - "key_sample_stats" : { - "total" : 309, - "non_key_sample" : 309, - "key_sample" : 0 - }, - "deletion_stats" : { }, - "metadata_stats" : { }, - "data_spliting_enable" : false - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_the_progress_of_a_team_labeling_task_member.rst b/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_the_progress_of_a_team_labeling_task_member.rst deleted file mode 100644 index b803bafa..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/querying_details_about_the_progress_of_a_team_labeling_task_member.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _GetWorkforceTaskMetrics: - -Querying Details About the Progress of a Team Labeling Task Member -================================================================== - -Function --------- - -This API is used to query details about the progress of a team labeling task member. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +--------------+---------------------------------+-------------------------------------------+ - | Parameter | Type | Description | - +==============+=================================+===========================================+ - | sample_stats | Map> | Statistics on team labeling task members. | - +--------------+---------------------------------+-------------------------------------------+ - -Example Requests ----------------- - -Querying Details About the Progress of a Team Labeling Task Member - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/metrics - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_stats" : { - "xxx@xxx.com" : { - "un_annotation" : 51, - "rejected" : 0, - "unreviewed" : 0, - "accepted" : 0, - "auto_annotation" : 0, - "uncheck" : 0 - } - } - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/querying_the_monitoring_data_of_a_dataset.rst b/modelarts/api-ref/result/data_management/dataset_management/querying_the_monitoring_data_of_a_dataset.rst deleted file mode 100644 index a3e06e92..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/querying_the_monitoring_data_of_a_dataset.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. _GetDatasetMetrics: - -Querying the Monitoring Data of a Dataset -========================================= - -Function --------- - -This API is used to query the monitoring data of a dataset within a specified time range. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/metrics - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------+--------+-------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+===========================================+ - | end_time | Yes | Long | End time of the monitoring information. | - +-------------------+-----------+--------+-------------------------------------------+ - | start_time | Yes | Long | Start time of the monitoring information. | - +-------------------+-----------+--------+-------------------------------------------+ - | workforce_task_id | No | String | ID of a team labeling task. | - +-------------------+-----------+--------+-------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------+---------------------------------+---------------------------------+ - | Parameter | Type | Description | - +===========+=================================+=================================+ - | metrics | Map> | Dataset monitoring information. | - +-----------+---------------------------------+---------------------------------+ - -Example Requests ----------------- - -Querying the Monitoring Data of a Dataset - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/metrics - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "metrics" : { - "un_annotation" : { - "1606233612612" : 16, - "1606320012681" : 16 - }, - "failed_user" : { }, - "total" : { - "1606233612612" : 16, - "1606320012681" : 16 - }, - "queuing" : { }, - "success" : { }, - "unfinished" : { }, - "manual_annotation" : { - "1606233612612" : 0, - "1606320012681" : 0 - }, - "failed" : { }, - "failed_system" : { } - } - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst b/modelarts/api-ref/result/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst deleted file mode 100644 index c88059d1..00000000 --- a/modelarts/api-ref/result/data_management/dataset_management/response_body_for_querying_the_dataset_list..rst +++ /dev/null @@ -1,965 +0,0 @@ -.. _ListDatasets: - -Response body for querying the dataset list. -============================================ - -Function --------- - -This API is used to query the created datasets that meet the search criteria by page. - -URI ---- - -GET /v2/{project_id}/datasets - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +======================+=================+=================+==============================================================================================================================================================================================================================================================================================================================================================================+ - | check_running_task | No | Boolean | Whether to detect tasks (including initialization tasks) that are running in a dataset. The options are as follows: | - | | | | | - | | | | - **true**: Detect tasks (including initialization tasks) that are running in the dataset. | - | | | | | - | | | | - **false**: Do not detect tasks (including initialization tasks) that are running in the dataset. (Default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | contain_versions | No | Boolean | Whether the dataset contains a version. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | No | Integer | Dataset type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | file_preview | No | Boolean | Whether a dataset supports preview when it is queried. The options are as follows: | - | | | | | - | | | | - **true**: Preview is supported and the list of four dataset files is returned. | - | | | | | - | | | | - **false**: Preview is not supported. (Default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | running_task_type | No | Integer | Type of the running tasks (including initialization tasks) to be detected. The options are as follows: | - | | | | | - | | | | - **0**: auto labeling | - | | | | | - | | | | - **1**: pre-labeling | - | | | | | - | | | | - **2**: export | - | | | | | - | | | | - **3**: version switch | - | | | | | - | | | | - **4**: manifest file export | - | | | | | - | | | | - **5**: manifest file import | - | | | | | - | | | | - **6**: version publishing | - | | | | | - | | | | - **7**: auto grouping | - | | | | | - | | | | - **10**: one-click model deployment (default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Fuzzy search keyword. By default, this parameter is left blank. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **dataset_name**: Sort by dataset name. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | support_export | No | Boolean | Whether to filter datasets that can be exported only (including datasets of image classification, object detection, and custom format). If this parameter is left blank or the value is set to **false**, no filtering is performed. The options are as follows: | - | | | | | - | | | | - **true**: Filter datasets that can be exported only. | - | | | | | - | | | | - **false**: Do not filter datasets that can be exported only. (Default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_ratio | No | String | Version split ratio for dataset filtering. The numbers before and after the comma indicate the minimum and maximum split ratios, and the versions whose split ratios are within the range are filtered out, for example, **0.0,1.0**. Note: If this parameter is left blank or unavailable, the system does not filter datasets based on the version split ratio by default. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | No | Integer | Dataset version format for dataset filtering. This parameter is used to filter datasets that meet the filter criteria. The options are as follows: | - | | | | | - | | | | - **0**: default format | - | | | | | - | | | | - **1**: CarbonData (supported only by table datasets) | - | | | | | - | | | | - **2**: CSV | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_labels | No | Boolean | Whether to return dataset labels. The options are as follows: | - | | | | | - | | | | - **true**: Return label information. | - | | | | | - | | | | - **false**: Do not return label information. (Default value) | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+==============================================================================================+=================================================================================================================================+ - | datasets | Array of :ref:`DatasetAndFilePreview ` objects | Dataset list queried by page. | - +--------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | total_number | Integer | Total number of datasets. | - +--------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workspaceId | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +--------------+----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_datasetandfilepreview: - -.. table:: **Table 4** DatasetAndFilePreview - - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============================+================================================================================+==================================================================================================================================================================================+ - | annotated_sample_count | Integer | Number of labeled samples in a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | content_labeling | Boolean | Whether to enable content labeling for the speech paragraph labeling dataset. This function is enabled by default. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a dataset is created. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_version_id | String | Current version ID of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_version_name | String | Current version name of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_format | String | Data format. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_sources | Array of :ref:`DataSource ` objects | Data source list. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata in JSON format. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_update_time | Long | Time when a sample and a label are updated. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | String | Data path for training. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_format | Integer | Dataset format. The options are as follows: | - | | | | - | | | - **0**: file | - | | | | - | | | - **1**: table | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset name. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_tags | Array of strings | Key identifier list of a dataset, for example, ["Image","Object detection"]. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | Integer | Dataset type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet | - | | | | - | | | - **200**: sound classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **400**: table dataset | - | | | | - | | | - **600**: video labeling | - | | | | - | | | - **900**: custom format | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_count | Integer | Version number of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Dataset description. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | exist_running_task | Boolean | Whether the dataset contains running (including initialization) tasks. The options are as follows: | - | | | | - | | | - **true**: The dataset contains running tasks. | - | | | | - | | | - **false**: The dataset does not contain running tasks. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | exist_workforce_task | Boolean | Whether the dataset contains team labeling tasks. The options are as follows: | - | | | | - | | | - **true**: The dataset contains team labeling tasks. | - | | | | - | | | - **false**: The dataset does not contain team labeling tasks. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | feature_supports | Array of strings | List of features supported by the dataset. Currently, only the value **0** is supported, indicating that the OBS file size is limited. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_data | Boolean | Whether to import data. The options are as follows: | - | | | | - | | | - **true**: Import data. | - | | | | - | | | - **false**: Do not import data. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_task_id | String | ID of an import task. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_annotation_path | String | Path for storing the labeling result of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_data_path | String | Path for storing the internal data of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_log_path | String | Path for storing internal logs of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_task_path | String | Path for internal task of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_temp_path | String | Path for storing internal temporary files of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inner_work_path | String | Output directory of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_task_count | Integer | Number of labeling tasks. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`Label ` objects | Dataset label list. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | loading_sample_count | Integer | Number of loading samples. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | managed | Boolean | Whether a dataset is hosted. The options are as follows: | - | | | | - | | | - **true**: The dataset is hosted. | - | | | | - | | | - **false**: The dataset is not hosted. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | next_version_num | Integer | Number of next versions of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | running_tasks_id | Array of strings | ID list of running (including initialization) tasks. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of :ref:`AnnotationFile ` objects | Sample list. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schema | Array of :ref:`Field ` objects | Schema list. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Dataset status. The options are as follows: | - | | | | - | | | - **0**: creating dataset | - | | | | - | | | - **1**: normal dataset | - | | | | - | | | - **2**: deleting dataset | - | | | | - | | | - **3**: deleted dataset | - | | | | - | | | - **4**: abnormal dataset | - | | | | - | | | - **5**: synchronizing dataset | - | | | | - | | | - **6**: releasing dataset | - | | | | - | | | - **7**: dataset in version switching | - | | | | - | | | - **8**: importing dataset | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | third_path | String | Third-party path. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of dataset samples. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. For example, the total number of key frame images extracted from the video labeling dataset is that of subsamples. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Integer | Number of auto labeling samples to be confirmed. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a dataset is updated. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | versions | Array of :ref:`DatasetVersion ` objects | Dataset version information. Currently, only the current version information of a dataset is recorded. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | String | Output dataset path, which is used to store output files such as label files. The path is an OBS path in the format of /*Bucket name*/*File path*. For example: /**obs-bucket**. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path_type | Integer | Type of the dataset output path. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_descriptor | :ref:`WorkforceDescriptor ` object | Team labeling information. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_task_count | Integer | Number of team labeling tasks of a dataset. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +----------------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_datasource: - -.. table:: **Table 5** DataSource - - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+======================================================================+============================================================================================================================+ - | data_path | String | Data source path. | - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | Integer | Data type. The options are as follows: | - | | | | - | | | - **0**: OBS bucket (default value) | - | | | | - | | | - **1**: GaussDB(DWS) | - | | | | - | | | - **2**: DLI | - | | | | - | | | - **3**: RDS | - | | | | - | | | - **4**: MRS | - | | | | - | | | - **5**: AI Gallery | - | | | | - | | | - **6**: Inference service | - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the file is the column name. | - | | | | - | | | - **false**: The first row in the file is not the column name. | - +-----------------------+----------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_schemamap: - -.. table:: **Table 6** SchemaMap - - ========= ====== =============================== - Parameter Type Description - ========= ====== =============================== - dest_name String Name of the destination column. - src_name String Name of the source column. - ========= ====== =============================== - -.. _listdatasets__response_sourceinfo: - -.. table:: **Table 7** SourceInfo - - +-----------------------+-----------------------+--------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================+ - | cluster_id | String | ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_mode | String | Running mode of an MRS cluster. The options are as follows: | - | | | | - | | | - **0**: normal cluster | - | | | | - | | | - **1**: security cluster | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | cluster_name | String | Name of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | database_name | String | Name of the database to which the table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | input | String | HDFS path of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | ip | String | IP address of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | port | String | Port number of your GaussDB(DWS) cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | queue_name | String | DLI queue name of a table dataset. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | subnet_id | String | Subnet ID of an MRS cluster. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | table_name | String | Name of the table to which a table dataset is imported. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_name | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | user_password | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - | vpc_id | String | ID of the VPC where an MRS cluster resides. | - +-----------------------+-----------------------+--------------------------------------------------------------+ - -.. _listdatasets__response_label: - -.. table:: **Table 8** Label - - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_labelproperty: - -.. table:: **Table 9** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_annotationfile: - -.. table:: **Table 10** AnnotationFile - - =========== ================== ================================== - Parameter Type Description - =========== ================== ================================== - create_time Long Time when a sample is created. - dataset_id String Dataset ID. - depth Integer Number of image sample channels. - file_Name String Sample name. - file_id String Sample ID. - file_type String File type. - height Integer Image sample height. - size Long Image sample size. - tags Map Label information of a sample. - url String OBS address of the preview sample. - width Integer Image sample width. - =========== ================== ================================== - -.. _listdatasets__response_field: - -.. table:: **Table 11** Field - - =========== ======= =================== - Parameter Type Description - =========== ======= =================== - description String Schema description. - name String Schema name. - schema_id Integer Schema ID. - type String Schema value type. - =========== ======= =================== - -.. _listdatasets__response_datasetversion: - -.. table:: **Table 12** DatasetVersion - - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================================+========================================================================+==========================================================================================================================================================================+ - | add_sample_count | Integer | Number of added samples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sample_count | Integer | Number of samples with labeled versions. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | clear_hard_property | Boolean | Whether to clear hard example properties during release. The options are as follows: | - | | | | - | | | - **true**: Clear hard example properties. (Default value) | - | | | | - | | | - **false**: Do not clear hard example properties. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Status code of a preprocessing task such as rotation and cropping. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a version is created. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop | Boolean | Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: | - | | | | - | | | - **true**: Crop the image. | - | | | | - | | | - **false**: Do not crop the image. (Default value) | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_path | String | Path for storing cropped files. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_rotate_cache_path | String | Temporary directory for executing the rotation and cropping task. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_path | String | Path for storing data. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata in JSON format. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_validate | Boolean | Whether data is validated by the validation algorithm before release. The options are as follows: | - | | | | - | | | - **true**: The data has been validated. | - | | | | - | | | - **false**: The data has not been validated. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a version. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_images | Boolean | Whether to export images to the version output directory during release. The options are as follows: | - | | | | - | | | - **true**: Export images to the version output directory. | - | | | | - | | | - **false**: Do not export images to the version output directory. (Default value) | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extract_serial_number | Boolean | Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: | - | | | | - | | | - **true**: Parse the subsample number. | - | | | | - | | | - **false**: Do not parse the subsample number. (Default value) | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | include_dataset_data | Boolean | Whether to include the source data of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: The source data of a dataset is included. | - | | | | - | | | - **false**: The source data of a dataset is not included. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current dataset version is used. The options are as follows: | - | | | | - | | | - **true**: The current dataset version is used. | - | | | | - | | | - **false**: The current dataset version is not used. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics list of a released version. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | String | Label type of a released version. The options are as follows: | - | | | | - | | | - **multi**: Multi-label samples are included. | - | | | | - | | | - **single**: All samples are single-labeled. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_cache_input_path | String | Input path for the **manifest** file cache during version release. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** file with the released version. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Task information recorded during release (for example, error information). | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified samples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_annotated_sample_count | Integer | Number of labeled samples of parent versions. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_total_sample_count | Integer | Total samples of parent versions. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_version_id | String | Parent version ID | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task such as rotation and cropping. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task such as rotation and cropping. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - | | | | - | | | - **5**: timeout | - | | | | - | | | - **6**: deletion failed | - | | | | - | | | - **7**: stop failed | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remove_sample_usage | Boolean | Whether to clear the existing usage information of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: Clear the existing usage information of a dataset. (Default value) | - | | | | - | | | - **false**: Do not clear the existing usage information of a dataset. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate | Boolean | Whether to rotate the image. The options are as follows: | - | | | | - | | | - **true**: Rotate the image. | - | | | | - | | | - **false**: Do not rotate the image. (Default value) | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate_path | String | Path for storing the rotated file. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a dataset version. The options are as follows: | - | | | | - | | | - **0**: creating | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: deleting | - | | | | - | | | - **3**: deleted | - | | | | - | | | - **4**: error | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"]. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_type | Integer | Labeling task type of the released version, which is the same as the dataset type. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of version samples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_sample_ratio | String | Split training and verification ratio during version release. The default value is **1.00**, indicating that all labeled samples are split into the training set. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a version is updated. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the released CSV file is a column name. | - | | | | - | | | - **false**: The first row in the released CSV file is not a column name. | - +---------------------------------+------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_labelstats: - -.. table:: **Table 13** LabelStats - - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_labelattribute: - -.. table:: **Table 14** LabelAttribute - - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listdatasets__response_labelattributevalue: - -.. table:: **Table 15** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _listdatasets__response_workforcedescriptor: - -.. table:: **Table 16** WorkforceDescriptor - - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===================================+================================================================+===============================================================================================================================================================================+ - | current_task_id | String | ID of a team labeling task. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | current_task_name | String | Name of a team labeling task. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reject_num | Integer | Number of rejected samples. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repetition | Integer | Number of persons who label each sample. The minimum value is **1**. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_synchronize_auto_labeling_data | Boolean | Whether to synchronously update auto labeling data. The options are as follows: | - | | | | - | | | - **true**: Update auto labeling data synchronously. | - | | | | - | | | - **false**: Do not update auto labeling data synchronously. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_synchronize_data | Boolean | Whether to synchronize updated data, such as uploading files, synchronizing data sources, and assigning imported unlabeled files to team members. The options are as follows: | - | | | | - | | | - **true**: Synchronize updated data to team members. | - | | | | - | | | - **false**: Do not synchronize updated data to team members. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workers | Array of :ref:`Worker ` objects | List of labeling team members. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. | - +-----------------------------------+----------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasets__response_worker: - -.. table:: **Table 17** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Dataset List - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets?offset=0&limit=10&sort_by=create_time&order=desc&dataset_type=0&file_preview=true - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_number" : 1, - "datasets" : [ { - "dataset_id" : "gfghHSokody6AJigS5A", - "dataset_name" : "dataset-f9e8", - "dataset_type" : 0, - "data_format" : "Default", - "next_version_num" : 4, - "status" : 1, - "data_sources" : [ { - "data_type" : 0, - "data_path" : "/test-obs/classify/input/catDog4/" - } ], - "create_time" : 1605690595404, - "update_time" : 1605690595404, - "description" : "", - "current_version_id" : "54IXbeJhfttGpL46lbv", - "current_version_name" : "V003", - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "work_path" : "/test-obs/classify/output/", - "inner_work_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/", - "inner_annotation_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/", - "inner_data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/data/", - "inner_log_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/logs/", - "inner_temp_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/temp/", - "inner_task_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/task/", - "work_path_type" : 0, - "workspace_id" : "0", - "enterprise_project_id" : "0", - "exist_running_task" : false, - "exist_workforce_task" : false, - "running_tasks_id" : [ ], - "workforce_task_count" : 0, - "feature_supports" : [ "0" ], - "managed" : false, - "import_data" : false, - "ai_project" : "default-ai-project", - "label_task_count" : 1, - "dataset_format" : 0, - "dataset_version" : "v1", - "content_labeling" : true, - "samples" : [ { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/15.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tuUo9jl6lqoMKAwNBz5g8dxO%2FdE%3D", - "create_time" : 1605690596035 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/8.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=NITOdBnkUXtdnKuEgDzZpkQzNfM%3D", - "create_time" : 1605690596046 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/9.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=%2BwUo1BL38%2F2d7p7anPi4fNzm1VU%3D", - "create_time" : 1605690596050 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/7.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tOrHfcWo%2FEJ0wRzfi1M5Wk2MrXg%3D", - "create_time" : 1605690596043 - } ], - "files" : [ { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/15.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tuUo9jl6lqoMKAwNBz5g8dxO%2FdE%3D", - "create_time" : 1605690596035 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/8.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=NITOdBnkUXtdnKuEgDzZpkQzNfM%3D", - "create_time" : 1605690596046 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/9.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=%2BwUo1BL38%2F2d7p7anPi4fNzm1VU%3D", - "create_time" : 1605690596050 - }, { - "url" : "https://test-obs.obs.xxx.com:443/classify/input/catDog4/7.jpg?AccessKeyId=vprCCTY1NmHudlvC0bXr&Expires=1606100112&Signature=tOrHfcWo%2FEJ0wRzfi1M5Wk2MrXg%3D", - "create_time" : 1605690596043 - } ] - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_version_management/creating_a_dataset_labeling_version.rst b/modelarts/api-ref/result/data_management/dataset_version_management/creating_a_dataset_labeling_version.rst deleted file mode 100644 index f72798a7..00000000 --- a/modelarts/api-ref/result/data_management/dataset_version_management/creating_a_dataset_labeling_version.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. _CreateDatasetVersion: - -Creating a Dataset Labeling Version -=================================== - -Function --------- - -This API is used to create a dataset labeling version. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/versions - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+===================================================================================================================================================================+ - | clear_hard_property | No | Boolean | Whether to clear hard example properties. The options are as follows: | - | | | | | - | | | | - **true**: Clear hard example properties. (Default value) | - | | | | | - | | | | - **false**: Do not clear hard example properties. | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Version description. The value is empty by default. The description contains 0 to 256 characters and does not support the following special characters: !<>=&"' | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_images | No | Boolean | Whether to export images to the version output directory during release. The options are as follows: | - | | | | | - | | | | - **true**: Export images to the version output directory. | - | | | | | - | | | | - **false**: Do not export images to the version output directory. (Default value) | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remove_sample_usage | No | Boolean | Whether to clear the existing usage information of a dataset during release. The options are as follows: | - | | | | | - | | | | - **true**: Clear the existing usage information of a dataset. (Default value) | - | | | | | - | | | | - **false**: Do not clear the existing usage information of a dataset. | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_sample_ratio | No | String | Split training and verification ratio during version release. The default value is **1.00**, indicating that all labeled samples are split into the training set. | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | No | String | Format of a dataset version. The options are as follows: | - | | | | | - | | | | - **Default**: default format | - | | | | | - | | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | | - | | | | - **CSV**: CSV | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | Version name. The value contains 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether to write the column name in the first line of the CSV file during release. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: Write the column name in the first line of the CSV file. (Default value) | - | | | | | - | | | | - **false**: Do not write the column name in the first line of the CSV file. | - +-----------------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 201** - -.. table:: **Table 3** Response body parameters - - ========== ====== =================== - Parameter Type Description - ========== ====== =================== - version_id String Dataset version ID. - ========== ====== =================== - -Example Requests ----------------- - -Creating a Dataset Labeling Version - -.. code-block:: - - { - "version_name" : "V004", - "version_format" : "Default", - "description" : "", - "clear_hard_property" : true - } - -Example Responses ------------------ - -**Status code: 201** - -Created - -.. code-block:: - - { - "version_id" : "sntOdOuB0D9C6fC4TXs" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -201 Created -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_version_management/deleting_a_dataset_labeling_version.rst b/modelarts/api-ref/result/data_management/dataset_version_management/deleting_a_dataset_labeling_version.rst deleted file mode 100644 index e345a8c8..00000000 --- a/modelarts/api-ref/result/data_management/dataset_version_management/deleting_a_dataset_labeling_version.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _DeleteDatasetVersion: - -Deleting a Dataset Labeling Version -=================================== - -Function --------- - -This API is used to delete a dataset labeling version. - -URI ---- - -DELETE /v2/{project_id}/datasets/{dataset_id}/versions/{version_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Dataset version ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Dataset Labeling Version - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_version_management/index.rst b/modelarts/api-ref/result/data_management/dataset_version_management/index.rst deleted file mode 100644 index 08e1e809..00000000 --- a/modelarts/api-ref/result/data_management/dataset_version_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _dataset_version_management: - -========================== -Dataset Version Management -========================== - -.. toctree:: - :maxdepth: 1 - - querying_the_dataset_version_list - creating_a_dataset_labeling_version - querying_details_about_a_dataset_version - deleting_a_dataset_labeling_version diff --git a/modelarts/api-ref/result/data_management/dataset_version_management/querying_details_about_a_dataset_version.rst b/modelarts/api-ref/result/data_management/dataset_version_management/querying_details_about_a_dataset_version.rst deleted file mode 100644 index 864bb69e..00000000 --- a/modelarts/api-ref/result/data_management/dataset_version_management/querying_details_about_a_dataset_version.rst +++ /dev/null @@ -1,416 +0,0 @@ -.. _DescribeDatasetVersion: - -Querying Details About a Dataset Version -======================================== - -Function --------- - -This API is used to query the details about a dataset version. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/versions/{version_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Dataset version ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================================+==================================================================================+==========================================================================================================================================================================+ - | add_sample_count | Integer | Number of added samples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sample_count | Integer | Number of samples with labeled versions. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | clear_hard_property | Boolean | Whether to clear hard example properties during release. The options are as follows: | - | | | | - | | | - **true**: Clear hard example properties. (Default value) | - | | | | - | | | - **false**: Do not clear hard example properties. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Status code of a preprocessing task such as rotation and cropping. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a version is created. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop | Boolean | Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: | - | | | | - | | | - **true**: Crop the image. | - | | | | - | | | - **false**: Do not crop the image. (Default value) | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_path | String | Path for storing cropped files. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_rotate_cache_path | String | Temporary directory for executing the rotation and cropping task. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_path | String | Path for storing data. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata in JSON format. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_validate | Boolean | Whether data is validated by the validation algorithm before release. The options are as follows: | - | | | | - | | | - **true**: The data has been validated. | - | | | | - | | | - **false**: The data has not been validated. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a version. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_images | Boolean | Whether to export images to the version output directory during release. The options are as follows: | - | | | | - | | | - **true**: Export images to the version output directory. | - | | | | - | | | - **false**: Do not export images to the version output directory. (Default value) | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extract_serial_number | Boolean | Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: | - | | | | - | | | - **true**: Parse the subsample number. | - | | | | - | | | - **false**: Do not parse the subsample number. (Default value) | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | include_dataset_data | Boolean | Whether to include the source data of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: The source data of a dataset is included. | - | | | | - | | | - **false**: The source data of a dataset is not included. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current dataset version is used. The options are as follows: | - | | | | - | | | - **true**: The current dataset version is used. | - | | | | - | | | - **false**: The current dataset version is not used. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics list of a released version. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | String | Label type of a released version. The options are as follows: | - | | | | - | | | - **multi**: Multi-label samples are included. | - | | | | - | | | - **single**: All samples are single-labeled. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_cache_input_path | String | Input path for the **manifest** file cache during version release. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** file with the released version. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Task information recorded during release (for example, error information). | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified samples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_annotated_sample_count | Integer | Number of labeled samples of parent versions. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_total_sample_count | Integer | Total samples of parent versions. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_version_id | String | Parent version ID | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task such as rotation and cropping. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task such as rotation and cropping. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - | | | | - | | | - **5**: timeout | - | | | | - | | | - **6**: deletion failed | - | | | | - | | | - **7**: stop failed | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remove_sample_usage | Boolean | Whether to clear the existing usage information of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: Clear the existing usage information of a dataset. (Default value) | - | | | | - | | | - **false**: Do not clear the existing usage information of a dataset. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate | Boolean | Whether to rotate the image. The options are as follows: | - | | | | - | | | - **true**: Rotate the image. | - | | | | - | | | - **false**: Do not rotate the image. (Default value) | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate_path | String | Path for storing the rotated file. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a dataset version. The options are as follows: | - | | | | - | | | - **0**: creating | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: deleting | - | | | | - | | | - **3**: deleted | - | | | | - | | | - **4**: error | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"]. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_type | Integer | Labeling task type of the released version, which is the same as the dataset type. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of version samples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_sample_ratio | String | Split training and verification ratio during version release. The default value is **1.00**, indicating that all labeled samples are split into the training set. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a version is updated. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the released CSV file is a column name. | - | | | | - | | | - **false**: The first row in the released CSV file is not a column name. | - +---------------------------------+----------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describedatasetversion__response_labelstats: - -.. table:: **Table 3** LabelStats - - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _describedatasetversion__response_labelattribute: - -.. table:: **Table 4** LabelAttribute - - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+----------------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _describedatasetversion__response_labelattributevalue: - -.. table:: **Table 5** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _describedatasetversion__response_labelproperty: - -.. table:: **Table 6** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Dataset Version - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions/{version_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "version_id" : "eSOKEQaXhKzxN00WKoV", - "version_name" : "V002", - "version_format" : "Default", - "previous_version_id" : "vlGvUqOcxxGPIB0ugeE", - "status" : 1, - "create_time" : 1605691027084, - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "total_sub_sample_count" : 0, - "annotated_sub_sample_count" : 0, - "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/V002.manifest", - "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/data/", - "is_current" : true, - "train_evaluate_sample_ratio" : "0.9999", - "remove_sample_usage" : false, - "export_images" : false, - "description" : "", - "label_stats" : [ { - "name" : "Cat", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - }, - "count" : 5, - "sample_count" : 5 - }, { - "name" : "Dog", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - }, - "count" : 5, - "sample_count" : 5 - } ], - "label_type" : "single", - "task_type" : 0, - "extract_serial_number" : false - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/dataset_version_management/querying_the_dataset_version_list.rst b/modelarts/api-ref/result/data_management/dataset_version_management/querying_the_dataset_version_list.rst deleted file mode 100644 index 4381a708..00000000 --- a/modelarts/api-ref/result/data_management/dataset_version_management/querying_the_dataset_version_list.rst +++ /dev/null @@ -1,478 +0,0 @@ -.. _ListDatasetVersions: - -Querying the Dataset Version List -================================= - -Function --------- - -This API is used to query the version list of a specific dataset. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/versions - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +======================+=================+=================+==============================================================================================================================================================================================================================================================================================================================================================================+ - | status | No | Integer | Status of a dataset version. The options are as follows: | - | | | | | - | | | | - **0**: creating | - | | | | | - | | | | - **1**: running | - | | | | | - | | | | - **2**: deleting | - | | | | | - | | | | - **3**: deleted | - | | | | | - | | | | - **4**: error | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_ratio | No | String | Version split ratio for version filtering. The numbers before and after the comma indicate the minimum and maximum split ratios, and the versions whose split ratios are within the range are filtered out, for example, **0.0,1.0**. Note: If this parameter is left blank or unavailable, the system does not filter datasets based on the version split ratio by default. | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | No | Integer | Format of a dataset version. The options are as follows: | - | | | | | - | | | | - **0**: default format | - | | | | | - | | | | - **1**: CarbonData (supported only by table datasets) | - | | | | | - | | | | - **2**: CSV | - +----------------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+---------------------------------------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +==============+=======================================================================================+===================================+ - | total_number | Integer | Total number of dataset versions. | - +--------------+---------------------------------------------------------------------------------------+-----------------------------------+ - | versions | Array of :ref:`DatasetVersion ` objects | Dataset version list. | - +--------------+---------------------------------------------------------------------------------------+-----------------------------------+ - -.. _listdatasetversions__response_datasetversion: - -.. table:: **Table 4** DatasetVersion - - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================================+===============================================================================+==========================================================================================================================================================================+ - | add_sample_count | Integer | Number of added samples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sample_count | Integer | Number of samples with labeled versions. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated_sub_sample_count | Integer | Number of labeled subsamples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | clear_hard_property | Boolean | Whether to clear hard example properties during release. The options are as follows: | - | | | | - | | | - **true**: Clear hard example properties. (Default value) | - | | | | - | | | - **false**: Do not clear hard example properties. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | code | String | Status code of a preprocessing task such as rotation and cropping. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a version is created. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop | Boolean | Whether to crop the image. This field is valid only for the object detection dataset whose labeling box is in the rectangle shape. The options are as follows: | - | | | | - | | | - **true**: Crop the image. | - | | | | - | | | - **false**: Do not crop the image. (Default value) | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_path | String | Path for storing cropped files. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | crop_rotate_cache_path | String | Temporary directory for executing the rotation and cropping task. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_path | String | Path for storing data. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_statistics | Map | Sample statistics on a dataset, including the statistics on sample metadata in JSON format. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_validate | Boolean | Whether data is validated by the validation algorithm before release. The options are as follows: | - | | | | - | | | - **true**: The data has been validated. | - | | | | - | | | - **false**: The data has not been validated. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_stats | Map | Deletion reason statistics. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a version. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_images | Boolean | Whether to export images to the version output directory during release. The options are as follows: | - | | | | - | | | - **true**: Export images to the version output directory. | - | | | | - | | | - **false**: Do not export images to the version output directory. (Default value) | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extract_serial_number | Boolean | Whether to parse the subsample number during release. The field is valid for the healthcare dataset. The options are as follows: | - | | | | - | | | - **true**: Parse the subsample number. | - | | | | - | | | - **false**: Do not parse the subsample number. (Default value) | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | include_dataset_data | Boolean | Whether to include the source data of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: The source data of a dataset is included. | - | | | | - | | | - **false**: The source data of a dataset is not included. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current dataset version is used. The options are as follows: | - | | | | - | | | - **true**: The current dataset version is used. | - | | | | - | | | - **false**: The current dataset version is not used. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics list of a released version. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | String | Label type of a released version. The options are as follows: | - | | | | - | | | - **multi**: Multi-label samples are included. | - | | | | - | | | - **single**: All samples are single-labeled. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_cache_input_path | String | Input path for the **manifest** file cache during version release. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** file with the released version. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | message | String | Task information recorded during release (for example, error information). | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified samples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_annotated_sample_count | Integer | Number of labeled samples of parent versions. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_total_sample_count | Integer | Total samples of parent versions. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | previous_version_id | String | Parent version ID | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_id | String | ID of a preprocessing task such as rotation and cropping. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | processor_task_status | Integer | Status of a preprocessing task such as rotation and cropping. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - | | | | - | | | - **5**: timeout | - | | | | - | | | - **6**: deletion failed | - | | | | - | | | - **7**: stop failed | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remove_sample_usage | Boolean | Whether to clear the existing usage information of a dataset during release. The options are as follows: | - | | | | - | | | - **true**: Clear the existing usage information of a dataset. (Default value) | - | | | | - | | | - **false**: Do not clear the existing usage information of a dataset. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate | Boolean | Whether to rotate the image. The options are as follows: | - | | | | - | | | - **true**: Rotate the image. | - | | | | - | | | - **false**: Do not rotate the image. (Default value) | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rotate_path | String | Path for storing the rotated file. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a dataset version. The options are as follows: | - | | | | - | | | - **0**: creating | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: deleting | - | | | | - | | | - **3**: deleted | - | | | | - | | | - **4**: error | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tags | Array of strings | Key identifier list of the dataset. The labeling type is used as the default label when the labeling task releases a version. For example, ["Image","Object detection"]. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_type | Integer | Labeling task type of the released version, which is the same as the dataset type. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of version samples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_sub_sample_count | Integer | Total number of subsamples generated from the parent samples. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_evaluate_sample_ratio | String | Split training and verification ratio during version release. The default value is **1.00**, indicating that all labeled samples are split into the training set. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a version is updated. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | Boolean | Whether the first row in the released CSV file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | - | | | - **true**: The first row in the released CSV file is a column name. | - | | | | - | | | - **false**: The first row in the released CSV file is not a column name. | - +---------------------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasetversions__response_labelstats: - -.. table:: **Table 5** LabelStats - - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listdatasetversions__response_labelattribute: - -.. table:: **Table 6** LabelAttribute - - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=================================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listdatasetversions__response_labelattributevalue: - -.. table:: **Table 7** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _listdatasetversions__response_labelproperty: - -.. table:: **Table 8** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Version List of a Specific Dataset - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/versions - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_number" : 3, - "versions" : [ { - "version_id" : "54IXbeJhfttGpL46lbv", - "version_name" : "V003", - "version_format" : "Default", - "previous_version_id" : "eSOKEQaXhKzxN00WKoV", - "status" : 1, - "create_time" : 1605930512183, - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "total_sub_sample_count" : 0, - "annotated_sub_sample_count" : 0, - "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/V003.manifest", - "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V003/data/", - "is_current" : true, - "train_evaluate_sample_ratio" : "0.8", - "remove_sample_usage" : false, - "export_images" : false, - "description" : "", - "task_type" : 0, - "extract_serial_number" : false - }, { - "version_id" : "eSOKEQaXhKzxN00WKoV", - "version_name" : "V002", - "version_format" : "Default", - "previous_version_id" : "vlGvUqOcxxGPIB0ugeE", - "status" : 1, - "create_time" : 1605691027084, - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "total_sub_sample_count" : 0, - "annotated_sub_sample_count" : 0, - "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/V002.manifest", - "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V002/data/", - "is_current" : false, - "train_evaluate_sample_ratio" : "0.9999", - "remove_sample_usage" : false, - "export_images" : false, - "description" : "", - "task_type" : 0, - "extract_serial_number" : false - }, { - "version_id" : "vlGvUqOcxxGPIB0ugeE", - "version_name" : "V001", - "version_format" : "Default", - "status" : 1, - "create_time" : 1605690687346, - "total_sample_count" : 10, - "annotated_sample_count" : 10, - "total_sub_sample_count" : 0, - "annotated_sub_sample_count" : 0, - "manifest_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/V001.manifest", - "data_path" : "/test-obs/classify/output/dataset-f9e8-gfghHSokody6AJigS5A/annotation/V001/data/", - "is_current" : false, - "train_evaluate_sample_ratio" : "0.99", - "remove_sample_usage" : false, - "export_images" : false, - "description" : "", - "task_type" : 0, - "extract_serial_number" : false - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/index.rst b/modelarts/api-ref/result/data_management/index.rst deleted file mode 100644 index aaa04bfe..00000000 --- a/modelarts/api-ref/result/data_management/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_03_0202: - -=============== -Data Management -=============== - -.. toctree:: - :maxdepth: 1 - - data_management_apis - dataset_management/index - dataset_version_management/index - sample_management/index - label_management/index - manual_labeling/index - labeling_task_management/index - team_labeling_process_management/index - labeling_team_management/index - labeling_team_member_management/index - data_import_task/index - data_export_task/index - data_synchronization_task/index - intelligent_task/index - processing_task/index diff --git a/modelarts/api-ref/result/data_management/intelligent_task/index.rst b/modelarts/api-ref/result/data_management/intelligent_task/index.rst deleted file mode 100644 index 8ef0bd5b..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _auto_task: - -================ -Intelligent Task -================ - -.. toctree:: - :maxdepth: 1 - - querying_auto_labeling_sample_list - querying_details_about_an_auto_labeling_sample - querying_the_intelligent_task_list_by_page - starting_intelligent_tasks - obtaining_information_about_intelligent_tasks - stopping_an_intelligent_task diff --git a/modelarts/api-ref/result/data_management/intelligent_task/obtaining_information_about_intelligent_tasks.rst b/modelarts/api-ref/result/data_management/intelligent_task/obtaining_information_about_intelligent_tasks.rst deleted file mode 100644 index 2e04e28f..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/obtaining_information_about_intelligent_tasks.rst +++ /dev/null @@ -1,918 +0,0 @@ -.. _AutoAnnotationProgress: - -Obtaining Information About Intelligent Tasks -============================================= - -Function --------- - -This API is used to obtain information about intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the **task_id** parameter to query the details about a specific task. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | Task ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================================+===========================+ - | code | String | Task running status code. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | config | :ref:`SmartTaskConfig ` object | Task configuration. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | create_time | String | Task creation time. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | elapsed_time | Long | Execution time. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | error_code | String | Error code. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | error_detail | String | Error details. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | error_msg | String | Error message. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | message | String | Task running information. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | progress | Float | Task progress percentage. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | resource_id | String | Resource ID. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | result | :ref:`Result ` object | Task result. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | status | Integer | Task status. Options: | - | | | | - | | | - **-1**: queuing | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: failed | - | | | | - | | | - **3**: succeeded | - | | | | - | | | - **4**: stopping | - | | | | - | | | - **5**: stopped | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | task_id | String | Task ID. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - | task_name | String | Task name. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------+ - -.. _autoannotationprogress__response_smarttaskconfig: - -.. table:: **Table 3** SmartTaskConfig - - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+================================================================================================+=======================================================================================================================================================================================================================================================================================================================================================+ - | algorithm_type | String | Algorithm type for auto labeling. Options: | - | | | | - | | | - **fast**: Only labeled samples are used for training. This type of algorithm achieves faster labeling. | - | | | | - | | | - **accurate**: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ambiguity | Boolean | Whether to perform clustering based on the image blurring degree. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotation_output | String | Output path of the active learning labeling result. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_rule | String | Sample collection rule. The default value is **all**, indicating full collection. Currently, only value **all** is available. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_sample | Boolean | Whether to enable sample collection. The options are as follows: | - | | | | - | | | - **true**: Enable sample collection. (Default value) | - | | | | - | | | - **false**: Do not enable sample collection. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | confidence_scope | String | Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Task description. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Engine name. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`Flavor ` object | Training resource flavor. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_brightness | Boolean | Whether to perform clustering based on the image brightness. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_colorfulness | Boolean | Whether to perform clustering based on the image color. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_cluster_id | String | ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the **vpc_id** parameter does not take effect. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_config_list | Array of :ref:`InfConfig ` objects | Configuration list required for running an inference task, which is optional and left blank by default. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_output | String | Output path of inference in active learning. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_result_output_dir | String | OBS directory for storing sample prediction results. This parameter is optional. The {*service_id*}\ **-infer-result** subdirectory in the **output_dir** directory is used by default. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_sample_output | String | Output path of hard examples in active learning. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | String | OBS URL of the logs of a training job. By default, this parameter is left blank. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path of the **manifest** file, which is used as the input for training and inference. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_parameter | String | Model parameter. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | n_clusters | Integer | Number of clusters. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Task name. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_dir | String | Sample output path. The format is as follows: *Dataset output path*/*Dataset name*-*Dataset ID*/annotation/auto-deploy/. Example: **/test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/**. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameters | Array of :ref:`TrainingParameter ` objects | Running parameters of a training job. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of a resource pool. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | String | Attribute name. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | req_uri | String | Inference path of a batch job. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result_type | Integer | Processing mode of auto grouping results. The options are as follows: | - | | | | - | | | - **0**: Save to OBS. | - | | | | - | | | - **1**: Save to samples. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of :ref:`SampleLabels ` objects | List of labeling information for samples to be auto labeled. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stop_time | Integer | Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time | String | Timestamp in active learning. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_data_path | String | Path for storing existing training datasets. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | String | URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Integer | Number of workers in a training job. | - +-------------------------+------------------------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_exportparams: - -.. table:: **Table 4** ExportParams - - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+============================================================================================+============================================================================================================================================================================+ - | clear_hard_property | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | - | | | - **true**: Clear hard example attributes. (Default value) | - | | | | - | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | String | Format of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | String | Name of the dataset version to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | String | Export destination. The options are as follows: | - | | | | - | | | - **DIR**: Export data to OBS. (Default value) | - | | | | - | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | String | Name of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | - | | | - **true**: Allocate the training set and validation set. | - | | | | - | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of strings | ID list of exported samples. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+--------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_searchcondition: - -.. table:: **Table 5** SearchCondition - - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_searchlabels: - -.. table:: **Table 6** SearchLabels - - +-----------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_searchlabel: - -.. table:: **Table 7** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_searchprop: - -.. table:: **Table 8** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -.. _autoannotationprogress__response_flavor: - -.. table:: **Table 9** Flavor - - +-----------+--------+------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==============================================================================+ - | code | String | Attribute code of a resource specification, which is used for task creating. | - +-----------+--------+------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_infconfig: - -.. table:: **Table 10** InfConfig - - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+====================+============================================================================================================================================================================================================================================+ - | envs | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Integer | Instance number of model deployment, that is, the number of compute nodes. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | String | Resource specifications of real-time services. For details, see :ref:`Deploying Services `. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | Integer | Traffic weight allocated to a model. This parameter is mandatory only when **infer_type** is set to **real-time**. The sum of the weights must be **100**. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_trainingparameter: - -.. table:: **Table 11** TrainingParameter - - ========= ====== ================ - Parameter Type Description - ========= ====== ================ - label String Parameter name. - value String Parameter value. - ========= ====== ================ - -.. _autoannotationprogress__response_result: - -.. table:: **Table 12** Result - - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+==========================================================================================+=================================================================================================================================+ - | annotated_sample_count | Integer | Number of labeled samples. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | confidence_scope | String | Confidence range. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset name. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | String | Dataset type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet | - | | | | - | | | - **200**: sound classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **400**: table dataset | - | | | | - | | | - **600**: video labeling | - | | | | - | | | - **900**: custom format | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_model_job_name | String | Name of a DLF model inference job. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_service_job_name | String | Name of a DLF real-time service job. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_train_job_name | String | Name of a DLF training job. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | events | Array of :ref:`Event ` objects | Event. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | hard_example_path | String | Path for storing hard examples. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | hard_select_tasks | Array of :ref:`HardSelectTask ` objects | Selected task list of hard examples. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** files. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of :ref:`SampleLabels ` objects | Inference result of the real-time video service. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_id | String | ID of a real-time service. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_name | String | Name of a real-time service. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_resource | String | ID of the real-time service bound to a user. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_data_path | String | Path for storing training data. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_job_id | String | ID of a training job. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_job_name | String | Name of a training job. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Integer | Number of samples to be confirmed. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +--------------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_event: - -.. table:: **Table 13** Event - - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================+=====================================+ - | create_time | Long | Time when an event is created. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | description | String | Description. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | elapsed_time | Long | Time when an event is executed. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | error_code | String | Error code. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | error_message | String | Error message. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | events | Array of :ref:`Event ` objects | Subevent list. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | level | Integer | Event severity. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | name | String | Event name. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | ordinal | Integer | Sequence number. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | parent_name | String | Parent event name. | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - | status | String | Status. The options are as follows: | - | | | | - | | | - **waiting**: waiting | - | | | | - | | | - **running**: running | - | | | | - | | | - **failed**: failed | - | | | | - | | | - **success**: successful | - +-----------------------+------------------------------------------------------------------------+-------------------------------------+ - -.. _autoannotationprogress__response_hardselecttask: - -.. table:: **Table 14** HardSelectTask - - =================== ====== ==================================== - Parameter Type Description - =================== ====== ==================================== - create_at Long Creation time. - dataset_id String Dataset ID. - dataset_name String Dataset name. - hard_select_task_id String ID of a hard example filtering task. - task_status String Task status. - time Long Execution time. - update_at Long Update time. - =================== ====== ==================================== - -.. _autoannotationprogress__response_samplelabels: - -.. table:: **Table 15** SampleLabels - - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+====================================================================================+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. If this parameter is left blank, all sample labels are deleted. | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_usage | String | Sample usage. The options are as follows: | - | | | | - | | | - **TRAIN**: training | - | | | | - | | | - **EVAL**: evaluation | - | | | | - | | | - **TEST**: test | - | | | | - | | | - **INFERENCE**: inference | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_samplelabel: - -.. table:: **Table 16** SampleLabel - - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_samplelabelproperty: - -.. table:: **Table 17** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _autoannotationprogress__response_samplemetadata: - -.. table:: **Table 18** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Obtaining Information About an Auto Labeling (Active Learning) Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "resource_id" : "XGrRZuCV1qmMxnsmD5u", - "create_time" : "2020-11-23 11:08:20", - "progress" : 10.0, - "status" : 1, - "message" : "Start to export annotations. Export task id is jMZGm2SBp4Ymr2wrhAK", - "code" : "ModelArts.4902", - "elapsed_time" : 0, - "result" : { - "total_sample_count" : 49, - "annotated_sample_count" : 30, - "continuity" : false - }, - "export_type" : 0, - "config" : { - "ambiguity" : false, - "worker_server_num" : 0, - "collect_sample" : false, - "algorithm_type" : "fast", - "image_brightness" : false, - "image_colorfulness" : false - } - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/intelligent_task/querying_auto_labeling_sample_list.rst b/modelarts/api-ref/result/data_management/intelligent_task/querying_auto_labeling_sample_list.rst deleted file mode 100644 index 941ddbc9..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/querying_auto_labeling_sample_list.rst +++ /dev/null @@ -1,565 +0,0 @@ -.. _ListAutoAnnotationSamples: - -Querying Auto Labeling Sample List -================================== - -Function --------- - -This API is used to query auto labeling samples in a dataset. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=====================================================================================================================================================================================================================================+ - | high_score | No | String | Upper confidence limit. The default value is **1**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_name | No | String | Label name. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | No | Integer | Labeling type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | low_score | No | String | Lower confidence limit. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | process_parameter | No | String | Image resizing setting, which is the same as the OBS resizing setting. For details, see . For example, **image/resize,m_lfit,h_200** indicates that the target image is resized proportionally and the height is set to 200 pixels. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | No | String | Multi-dimensional search condition after URL encoding. The relationship between multiple search conditions is AND. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+-----------------------------------------------------------------------------------------------------+--------------------+ - | Parameter | Type | Description | - +==============+=====================================================================================================+====================+ - | sample_count | Integer | Number of samples. | - +--------------+-----------------------------------------------------------------------------------------------------+--------------------+ - | samples | Array of :ref:`DescribeSampleResp ` objects | Sample list. | - +--------------+-----------------------------------------------------------------------------------------------------+--------------------+ - -.. _listautoannotationsamples__response_describesampleresp: - -.. table:: **Table 4** DescribeSampleResp - - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+---------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 5** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _listautoannotationsamples__response_worker: - -.. table:: **Table 6** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listautoannotationsamples__response_samplelabel: - -.. table:: **Table 7** SampleLabel - - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listautoannotationsamples__response_samplelabelproperty: - -.. table:: **Table 8** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listautoannotationsamples__response_samplemetadata: - -.. table:: **Table 9** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Auto Labeling Sample List - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_count" : 1, - "samples" : [ { - "sample_id" : "10de574cbf0f09d4798b87ba0eb34e37", - "sample_type" : 0, - "labels" : [ { - "name" : "sunflowers", - "type" : 0, - "id" : "1", - "property" : { - "@modelarts:hard_coefficient" : "0.0", - "@modelarts:hard" : "false" - }, - "score" : 1.0 - } ], - "source" : "https://test-obs.obs.xxx.com:443/dogcat/8_1597649054631.jpeg?AccessKeyId=alRn0xskf5luJaG2jBJe&Expires=1606299230&x-image-process=image%2Fresize%2Cm_lfit%2Ch_200&Signature=MNAAjXz%2Fmwn%2BSabSK9wkaG6b6bU%3D", - "metadata" : { - "@modelarts:hard_coefficient" : 1.0, - "@modelarts:hard" : true, - "@modelarts:import_origin" : 0, - "@modelarts:hard_reasons" : [ 8, 6, 5, 3 ] - }, - "sample_time" : 1601432758000, - "sample_status" : "UN_ANNOTATION" - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/intelligent_task/querying_details_about_an_auto_labeling_sample.rst b/modelarts/api-ref/result/data_management/intelligent_task/querying_details_about_an_auto_labeling_sample.rst deleted file mode 100644 index 050ca40c..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/querying_details_about_an_auto_labeling_sample.rst +++ /dev/null @@ -1,504 +0,0 @@ -.. _DescribeAutoAnnotationSample: - -Querying Details About an Auto Labeling Sample -============================================== - -Function --------- - -This API is used to query details about an auto labeling sample. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | sample_id | Yes | String | Sample ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+------------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _describeautoannotationsample__response_worker: - -.. table:: **Table 4** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeautoannotationsample__response_samplelabel: - -.. table:: **Table 5** SampleLabel - - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeautoannotationsample__response_samplelabelproperty: - -.. table:: **Table 6** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeautoannotationsample__response_samplemetadata: - -.. table:: **Table 7** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About an Auto Labeling Sample - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/auto-annotations/samples/{sample_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_id" : "0059c1b9458a2da9443af684b5099b4e", - "sample_type" : 0, - "labels" : [ { - "name" : "Dog", - "type" : 0, - "id" : "1", - "property" : { - "@modelarts:hard_coefficient" : "0.0", - "@modelarts:hard" : "false" - }, - "score" : 0.66 - } ], - "source" : "https://test-obs.obs.xxx.com:443/data/3_1597649054631.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606299474&Signature=anOLGOHPSrj3WXUHVc70tAxWlf4%3D", - "metadata" : { - "test" : "1", - "@modelarts:hard_coefficient" : 0.0, - "@modelarts:hard" : false, - "@modelarts:import_origin" : 0, - "@modelarts:hard_reasons" : [ ] - }, - "sample_time" : 1600490651933, - "sample_status" : "UN_ANNOTATION", - "annotated_by" : "" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/intelligent_task/querying_the_intelligent_task_list_by_page.rst b/modelarts/api-ref/result/data_management/intelligent_task/querying_the_intelligent_task_list_by_page.rst deleted file mode 100644 index f96180d4..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/querying_the_intelligent_task_list_by_page.rst +++ /dev/null @@ -1,1021 +0,0 @@ -.. _ListTasks: - -Querying the Intelligent Task List by Page -========================================== - -Function --------- - -This API is used to query the intelligent task list by page, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the **type** parameter to query the list of a specific type of tasks. - -- Auto labeling: Learning and training are performed based on the selected labels and images and an existing model is selected to quickly label the remaining images. Auto labeling includes active learning and pre-labeling. - -- Active learning: The system uses semi-supervised learning and hard example filtering to perform auto labeling, reducing manual labeling workload and helping you find hard examples. - -- Pre-labeling: You select a model on the Model Management page for auto labeling. - -- One-click model deployment: You can use the one-click model deployment function to create training jobs for the labeled dataset, import a model, and deploy the model as a real-time service all in one step. - -- Auto grouping: Unlabeled images are clustered using the clustering algorithm and then processed based on the clustering result. Images can be labeled by group or cleaned. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | No | String | Task name filtering. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Task type. If this parameter is not delivered, the auto labeling (active learning or pre-labeling) task list is returned by default. The options are as follows: | - | | | | | - | | | | - **auto-label**: active learning | - | | | | | - | | | | - **pre-label**: pre-labeling | - | | | | | - | | | | - **auto-grouping**: auto grouping | - | | | | | - | | | | - **auto-deploy**: one-click model deployment | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-------------+-----------------------------------------------------------------------+------------------------+ - | Parameter | Type | Description | - +=============+=======================================================================+========================+ - | tasks | Array of :ref:`RunningTask ` objects | Task list. | - +-------------+-----------------------------------------------------------------------+------------------------+ - | total_count | Integer | Total number of tasks. | - +-------------+-----------------------------------------------------------------------+------------------------+ - -.. _listtasks__response_runningtask: - -.. table:: **Table 4** RunningTask - - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | Parameter | Type | Description | - +==========================+=====================================================================+====================================+ - | annotated_sample_count | Integer | Number of labeled samples. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | code | String | Error code. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | config | :ref:`SmartTaskConfig ` object | Task configuration. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | create_time | String | Task creation time. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | dataset_id | String | Dataset ID. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | elapsed_time | Long | Execution time. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | error_code | String | Error code. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | error_detail | String | Error details. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | error_msg | String | Error message. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | message | String | Error message. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | model_id | String | Model ID. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | model_name | String | Model name. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | model_version | String | Model version. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | progress | Float | Task progress percentage. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | result | :ref:`Result ` object | Task result. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | status | Integer | Task status. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | task_id | String | Task ID. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | task_name | String | Task name. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | type | Integer | Task type. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - | unconfirmed_sample_count | Integer | Number of samples to be confirmed. | - +--------------------------+---------------------------------------------------------------------+------------------------------------+ - -.. _listtasks__response_smarttaskconfig: - -.. table:: **Table 5** SmartTaskConfig - - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+===================================================================================+=======================================================================================================================================================================================================================================================================================================================================================+ - | algorithm_type | String | Algorithm type for auto labeling. Options: | - | | | | - | | | - **fast**: Only labeled samples are used for training. This type of algorithm achieves faster labeling. | - | | | | - | | | - **accurate**: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ambiguity | Boolean | Whether to perform clustering based on the image blurring degree. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotation_output | String | Output path of the active learning labeling result. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_rule | String | Sample collection rule. The default value is **all**, indicating full collection. Currently, only value **all** is available. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_sample | Boolean | Whether to enable sample collection. The options are as follows: | - | | | | - | | | - **true**: Enable sample collection. (Default value) | - | | | | - | | | - **false**: Do not enable sample collection. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | confidence_scope | String | Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Task description. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Engine name. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_format | Integer | Format of the exported directory. The options are as follows: | - | | | | - | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | - | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_params | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | :ref:`Flavor ` object | Training resource flavor. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_brightness | Boolean | Whether to perform clustering based on the image brightness. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_colorfulness | Boolean | Whether to perform clustering based on the image color. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_cluster_id | String | ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the **vpc_id** parameter does not take effect. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_config_list | Array of :ref:`InfConfig ` objects | Configuration list required for running an inference task, which is optional and left blank by default. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_output | String | Output path of inference in active learning. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_result_output_dir | String | OBS directory for storing sample prediction results. This parameter is optional. The {*service_id*}\ **-infer-result** subdirectory in the **output_dir** directory is used by default. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_sample_output | String | Output path of hard examples in active learning. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | String | OBS URL of the logs of a training job. By default, this parameter is left blank. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path of the **manifest** file, which is used as the input for training and inference. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_parameter | String | Model parameter. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | n_clusters | Integer | Number of clusters. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Task name. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_dir | String | Sample output path. The format is as follows: *Dataset output path*/*Dataset name*-*Dataset ID*/annotation/auto-deploy/. Example: **/test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/**. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameters | Array of :ref:`TrainingParameter ` objects | Running parameters of a training job. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of a resource pool. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | String | Attribute name. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | req_uri | String | Inference path of a batch job. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result_type | Integer | Processing mode of auto grouping results. The options are as follows: | - | | | | - | | | - **0**: Save to OBS. | - | | | | - | | | - **1**: Save to samples. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of :ref:`SampleLabels ` objects | List of labeling information for samples to be auto labeled. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stop_time | Integer | Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time | String | Timestamp in active learning. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_data_path | String | Path for storing existing training datasets. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | String | URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | String | Format of a dataset version. The options are as follows: | - | | | | - | | | - **Default**: default format | - | | | | - | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | - | | | - **CSV**: CSV | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Integer | Number of workers in a training job. | - +-------------------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_exportparams: - -.. table:: **Table 6** ExportParams - - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============================+===============================================================================+============================================================================================================================================================================+ - | clear_hard_property | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | - | | | - **true**: Clear hard example attributes. (Default value) | - | | | | - | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | String | Format of the dataset version to which data is exported. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | String | Name of the dataset version to which data is exported. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | String | Export destination. The options are as follows: | - | | | | - | | | - **DIR**: Export data to OBS. (Default value) | - | | | | - | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | String | Name of the new dataset to which data is exported. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | - | | | - **true**: Allocate the training set and validation set. | - | | | | - | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of strings | ID list of exported samples. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_searchcondition: - -.. table:: **Table 7** SearchCondition - - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_searchlabels: - -.. table:: **Table 8** SearchLabels - - +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_searchlabel: - -.. table:: **Table 9** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_searchprop: - -.. table:: **Table 10** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -.. _listtasks__response_flavor: - -.. table:: **Table 11** Flavor - - +-----------+--------+------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+==============================================================================+ - | code | String | Attribute code of a resource specification, which is used for task creating. | - +-----------+--------+------------------------------------------------------------------------------+ - -.. _listtasks__response_infconfig: - -.. table:: **Table 12** InfConfig - - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+====================+============================================================================================================================================================================================================================================+ - | envs | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Integer | Instance number of model deployment, that is, the number of compute nodes. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | String | Resource specifications of real-time services. For details, see :ref:`Deploying Services `. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | Integer | Traffic weight allocated to a model. This parameter is mandatory only when **infer_type** is set to **real-time**. The sum of the weights must be **100**. | - +----------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_trainingparameter: - -.. table:: **Table 13** TrainingParameter - - ========= ====== ================ - Parameter Type Description - ========= ====== ================ - label String Parameter name. - value String Parameter value. - ========= ====== ================ - -.. _listtasks__response_result: - -.. table:: **Table 14** Result - - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=============================================================================+=================================================================================================================================+ - | annotated_sample_count | Integer | Number of labeled samples. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | confidence_scope | String | Confidence range. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset name. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dataset_type | String | Dataset type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet | - | | | | - | | | - **200**: sound classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **400**: table dataset | - | | | | - | | | - **600**: video labeling | - | | | | - | | | - **900**: custom format | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_model_job_name | String | Name of a DLF model inference job. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_service_job_name | String | Name of a DLF real-time service job. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | dlf_train_job_name | String | Name of a DLF training job. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | events | Array of :ref:`Event ` objects | Event. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | hard_example_path | String | Path for storing hard examples. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | hard_select_tasks | Array of :ref:`HardSelectTask ` objects | Selected task list of hard examples. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | String | Path for storing the **manifest** files. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_id | String | Model ID. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | samples | Array of :ref:`SampleLabels ` objects | Inference result of the real-time video service. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_id | String | ID of a real-time service. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_name | String | Name of a real-time service. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | service_resource | String | ID of the real-time service bound to a user. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_data_path | String | Path for storing training data. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_job_id | String | ID of a training job. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | train_job_name | String | Name of a training job. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | unconfirmed_sample_count | Integer | Number of samples to be confirmed. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +--------------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_event: - -.. table:: **Table 15** Event - - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================================================+=====================================+ - | create_time | Long | Time when an event is created. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | description | String | Description. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | elapsed_time | Long | Time when an event is executed. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | error_code | String | Error code. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | error_message | String | Error message. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | events | Array of :ref:`Event ` objects | Subevent list. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | level | Integer | Event severity. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | name | String | Event name. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | ordinal | Integer | Sequence number. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | parent_name | String | Parent event name. | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - | status | String | Status. The options are as follows: | - | | | | - | | | - **waiting**: waiting | - | | | | - | | | - **running**: running | - | | | | - | | | - **failed**: failed | - | | | | - | | | - **success**: successful | - +-----------------------+-----------------------------------------------------------+-------------------------------------+ - -.. _listtasks__response_hardselecttask: - -.. table:: **Table 16** HardSelectTask - - =================== ====== ==================================== - Parameter Type Description - =================== ====== ==================================== - create_at Long Creation time. - dataset_id String Dataset ID. - dataset_name String Dataset name. - hard_select_task_id String ID of a hard example filtering task. - task_status String Task status. - time Long Execution time. - update_at Long Update time. - =================== ====== ==================================== - -.. _listtasks__response_samplelabels: - -.. table:: **Table 17** SampleLabels - - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================+====================================================================================+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. If this parameter is left blank, all sample labels are deleted. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_usage | String | Sample usage. The options are as follows: | - | | | | - | | | - **TRAIN**: training | - | | | | - | | | - **EVAL**: evaluation | - | | | | - | | | - **TEST**: test | - | | | | - | | | - **INFERENCE**: inference | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - -.. _listtasks__response_samplelabel: - -.. table:: **Table 18** SampleLabel - - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=============================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_samplelabelproperty: - -.. table:: **Table 19** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listtasks__response_samplemetadata: - -.. table:: **Table 20** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the List of Auto Labeling, One-Click Model Deployment, or Auto Grouping Tasks by Page - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks?offset=0&limit=10 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "tasks" : [ { - "dataset_id" : "OBegCXHxTJ2JHRAZWr0", - "task_id" : "14cyxyu6UXaNT3lrPFl", - "type" : 1, - "create_time" : "2020-11-03 15:22:39", - "status" : 3, - "code" : "ModelArts.4996", - "message" : "prelabel task execute successfully.", - "elapsed_time" : 531, - "result" : { - "service_id" : "ee2ade80-0967-4ef3-b6da-e8c873017b9a", - "service_name" : "prelabel_infer_1604388201993_xubo_cls_d910_2_993", - "hard_select_tasks" : [ { - "id" : "887c4ac6-26c8-4ca3-b07a-cd75e16fdc2d", - "hard_select_task_id" : "86711ab3-8ceb-4b0e-bd52-8545b184a2a7", - "dataset_id" : "OBegCXHxTJ2JHRAZWr0", - "dataset_name" : "xubo_cls_d910_2", - "task_status" : "import_dataset_completed", - "time" : 262, - "create_at" : 0, - "update_at" : 0 - } ], - "continuity" : false - }, - "export_type" : 0, - "progress" : 100.0, - "total_sample_count" : 246, - "annotated_sample_count" : 38, - "unconfirmed_sample_count" : 208, - "model_id" : "c717a39f-c64f-45df-a9d3-be9ed79cdcb4", - "model_name" : "auto-deploy-50041602581620628", - "model_version" : "0.0.1", - "config" : { - "ambiguity" : false, - "name" : "5fXxR01TyUoiobqNEd9", - "worker_server_num" : 0, - "inf_config_list" : [ { - "model_id" : null, - "specification" : "modelarts.vm.cpu.2u", - "weight" : 0, - "instance_count" : 1, - "envs" : null - } ], - "collect_sample" : false, - "confidence_scope" : "0.0-0.5", - "algorithm_type" : "supervisory", - "image_brightness" : false, - "image_colorfulness" : false - } - }, { - "dataset_id" : "OBegCXHxTJ2JHRAZWr0", - "task_id" : "5QPy73VwnwHi5NqvbcP", - "type" : 0, - "create_time" : "2020-10-31 16:11:37", - "status" : 3, - "code" : "ModelArts.4996", - "message" : "task executed successfully.", - "elapsed_time" : 397, - "result" : { - "train_job_name" : "BNFURaEyftGNMITaBiv", - "train_job_id" : "74679", - "version_id" : "89745", - "continuity" : false - }, - "export_type" : 0, - "progress" : 100.0, - "total_sample_count" : 246, - "annotated_sample_count" : 38, - "unconfirmed_sample_count" : 198, - "model_name" : "Supervisory", - "model_version" : "0.0.1", - "config" : { - "ambiguity" : false, - "worker_server_num" : 0, - "collect_sample" : false, - "algorithm_type" : "fast", - "image_brightness" : false, - "image_colorfulness" : false - } - } ], - "total_count" : 2, - "exist_running_deploy_task" : false - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/intelligent_task/starting_intelligent_tasks.rst b/modelarts/api-ref/result/data_management/intelligent_task/starting_intelligent_tasks.rst deleted file mode 100644 index 787a15a0..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/starting_intelligent_tasks.rst +++ /dev/null @@ -1,784 +0,0 @@ -.. _CreateTask: - -Starting Intelligent Tasks -========================== - -Function --------- - -**This API is used to start an intelligent task, which can be an auto labeling task or an auto grouping task. You can specify task_type in the request body to start a type of tasks. The datasets whose data path or work path is an OBS path in a KMS-encrypted bucket support pre-labeling but do not support active learning and auto grouping.** - -**Auto labeling**: Learning and training are performed based on selected labels and images and an existing model is selected to quickly label the remaining images. Auto labeling includes active learning and pre-labeling. **Active learning**: The system uses semi-supervised learning and hard example filtering to perform auto labeling, reducing manual labeling workload and helping you find hard examples. **Pre-labeling**: Select a model displayed on the **Model Management** page for auto labeling. - -- **Auto grouping**: Unlabeled images are clustered using a clustering algorithm and then processed based on the clustering result. Images can be labeled or cleaned by group. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------+-----------------+---------------------------------------------------------------------+-------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=====================================================================+=============================================================+ - | collect_key_sample | No | Boolean | Whether to collect key samples. The options are as follows: | - | | | | | - | | | | - **true**: Collect key samples. | - | | | | | - | | | | - **false**: Do not collect key samples. (Default value) | - +--------------------+-----------------+---------------------------------------------------------------------+-------------------------------------------------------------+ - | config | No | :ref:`SmartTaskConfig ` object | Task configuration. | - +--------------------+-----------------+---------------------------------------------------------------------+-------------------------------------------------------------+ - | model_id | No | String | Model ID. | - +--------------------+-----------------+---------------------------------------------------------------------+-------------------------------------------------------------+ - | task_type | No | String | Task type. The options are as follows: | - | | | | | - | | | | - **auto-label**: active learning | - | | | | | - | | | | - **pre-label**: pre-labeling | - | | | | | - | | | | - **auto-grouping**: auto grouping | - | | | | | - | | | | - **auto-deploy**: one-click model deployment | - +--------------------+-----------------+---------------------------------------------------------------------+-------------------------------------------------------------+ - -.. _createtask__request_smarttaskconfig: - -.. table:: **Table 3** SmartTaskConfig - - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=========================+=================+===================================================================================+=======================================================================================================================================================================================================================================================================================================================================================+ - | algorithm_type | No | String | Algorithm type for auto labeling. Options: | - | | | | | - | | | | - **fast**: Only labeled samples are used for training. This type of algorithm achieves faster labeling. | - | | | | | - | | | | - **accurate**: In addition to labeled samples, unlabeled samples are used for semi-supervised training. This type of algorithm achieves more accurate labeling. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ambiguity | No | Boolean | Whether to perform clustering based on the image blurring degree. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotation_output | No | String | Output path of the active learning labeling result. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_rule | No | String | Sample collection rule. The default value is **all**, indicating full collection. Currently, only value **all** is available. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | collect_sample | No | Boolean | Whether to enable sample collection. The options are as follows: | - | | | | | - | | | | - **true**: Enable sample collection. (Default value) | - | | | | | - | | | | - **false**: Do not enable sample collection. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | confidence_scope | No | String | Confidence range of key samples. The minimum and maximum values are separated by hyphens (-). Example: 0.10-0.90. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Task description. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | No | String | Engine name. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_format | No | Integer | Format of the exported directory. The options are as follows: | - | | | | | - | | | | - **1**: tree structure. For example: cat/1.jpg,dog/2.jpg. | - | | | | | - | | | | - **2**: tile structure. For example: 1.jpg, 1.txt; 2.jpg,2.txt. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_params | No | :ref:`ExportParams ` object | Parameters of a dataset export task. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | No | :ref:`Flavor ` object | Training resource flavor. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_brightness | No | Boolean | Whether to perform clustering based on the image brightness. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_colorfulness | No | Boolean | Whether to perform clustering based on the image color. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_cluster_id | No | String | ID of a dedicated cluster. This parameter is left blank by default, indicating that a dedicated cluster is not used. When using the dedicated cluster to deploy services, ensure that the cluster status is normal. After this parameter is set, the network configuration of the cluster is used, and the **vpc_id** parameter does not take effect. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_config_list | No | Array of :ref:`InfConfig ` objects | Configuration list required for running an inference task, which is optional and left blank by default. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inf_output | No | String | Output path of inference in active learning. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_result_output_dir | No | String | OBS directory for storing sample prediction results. This parameter is optional. The {*service_id*}\ **-infer-result** subdirectory in the **output_dir** directory is used by default. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | key_sample_output | No | String | Output path of hard examples in active learning. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | No | String | OBS URL of the logs of a training job. By default, this parameter is left blank. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | manifest_path | No | String | Path of the **manifest** file, which is used as the input for training and inference. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | No | String | Model ID. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | No | String | Model name. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_parameter | No | String | Model parameter. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | No | String | Model version. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | n_clusters | No | Integer | Number of clusters. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Task name. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_dir | No | String | Sample output path. The format is as follows: *Dataset output path*/*Dataset name*-*Dataset ID*/annotation/auto-deploy/. Example: **/test/work_1608083108676/dataset123-g6IO9qSu6hoxwCAirfm/annotation/auto-deploy/**. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameters | No | Array of :ref:`TrainingParameter ` objects | Running parameters of a training job. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | No | String | ID of a resource pool. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | String | Attribute name. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | req_uri | No | String | Inference path of a batch job. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result_type | No | Integer | Processing mode of auto grouping results. The options are as follows: | - | | | | | - | | | | - **0**: Save to OBS. | - | | | | | - | | | | - **1**: Save to samples. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | No | Array of :ref:`SampleLabels ` objects | List of labeling information for samples to be auto labeled. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | stop_time | No | Integer | Timeout interval, in minutes. The default value is 15 minutes. This parameter is used only in the scenario of auto labeling for videos. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time | No | String | Timestamp in active learning. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_data_path | No | String | Path for storing existing training datasets. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | No | String | URL of the OBS path where the file of a training job is outputted. By default, this parameter is left blank. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_format | No | String | Format of a dataset version. The options are as follows: | - | | | | | - | | | | - **Default**: default format | - | | | | | - | | | | - **CarbonData**: CarbonData (supported only by table datasets) | - | | | | | - | | | | - **CSV**: CSV | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | No | Integer | Number of workers in a training job. | - +-------------------------+-----------------+-----------------------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_exportparams: - -.. table:: **Table 4** ExportParams - - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============================+=================+===============================================================================+============================================================================================================================================================================+ - | clear_hard_property | No | Boolean | Whether to clear hard example attributes. The options are as follows: | - | | | | | - | | | | - **true**: Clear hard example attributes. (Default value) | - | | | | | - | | | | - **false**: Do not clear hard example attributes. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_format | No | String | Format of the dataset version to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dataset_version_name | No | String | Name of the dataset version to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_dest | No | String | Export destination. The options are as follows: | - | | | | | - | | | | - **DIR**: Export data to OBS. (Default value) | - | | | | | - | | | | - **NEW_DATASET**: Export data to a new dataset. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_name | No | String | Name of the new dataset to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | export_new_dataset_work_path | No | String | Working directory of the new dataset to which data is exported. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ratio_sample_usage | No | Boolean | Whether to randomly allocate the training set and validation set based on the specified ratio. The options are as follows: | - | | | | | - | | | | - **true**: Allocate the training set and validation set. | - | | | | | - | | | | - **false**: Do not allocate the training set and validation set. (Default value) | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | No | Array of strings | ID list of exported samples. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | No | Array of :ref:`SearchCondition ` objects | Exported search conditions. The relationship between multiple search conditions is OR. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_sample_ratio | No | String | Split ratio of training set and verification set during specified version release. The default value is **1.00**, indicating that all released versions are training sets. | - +-------------------------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_searchcondition: - -.. table:: **Table 5** SearchCondition - - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+===============================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | No | String | Filter by coefficient of difficulty. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | No | Integer | A frame in the video. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | No | String | Whether a sample is a hard sample. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | No | String | Filter by data source. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | No | String | CT dosage, filtered by dosage. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | No | :ref:`SearchLabels ` object | Label search criteria. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | No | String | Labeler. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SearchProp ` object | Search by sample attribute. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | No | String | Parent sample ID. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | No | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | No | String | Search by sample name, including the file name extension. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | No | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | | - | | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | | - | | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | | - | | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | String | Search by confidence. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | No | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | No | String | DICOM scanning time. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | No | String | A time point in the video. | - +------------------+-----------------+---------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_searchlabels: - -.. table:: **Table 6** SearchLabels - - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================+==============================================================================================================================================================+ - | labels | No | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | No | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | | - | | | | - **OR**: OR operation | - | | | | | - | | | | - **AND**: AND operation | - +-----------------+-----------------+-----------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_searchlabel: - -.. table:: **Table 7** SearchLabel - - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | No | String | Label name. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | No | String | Operation type between multiple attributes. The options are as follows: | - | | | | | - | | | | - **OR**: OR operation | - | | | | | - | | | | - **AND**: AND operation | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_searchprop: - -.. table:: **Table 8** SearchProp - - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+=======================================================================+ - | op | No | String | Relationship between attribute values. The options are as follows: | - | | | | | - | | | | - **AND**: AND relationship | - | | | | | - | | | | - **OR**: OR relationship | - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - | props | No | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------+-----------------+---------------------------+-----------------------------------------------------------------------+ - -.. _createtask__request_flavor: - -.. table:: **Table 9** Flavor - - +-----------+-----------+--------+------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==============================================================================+ - | code | No | String | Attribute code of a resource specification, which is used for task creating. | - +-----------+-----------+--------+------------------------------------------------------------------------------+ - -.. _createtask__request_infconfig: - -.. table:: **Table 10** InfConfig - - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+====================+============================================================================================================================================================================================================================================+ - | envs | No | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | No | Integer | Instance number of model deployment, that is, the number of compute nodes. | - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | No | String | Model ID. | - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | No | String | Resource specifications of real-time services. For details, see :ref:`Deploying Services `. | - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | No | Integer | Traffic weight allocated to a model. This parameter is mandatory only when **infer_type** is set to **real-time**. The sum of the weights must be **100**. | - +----------------+-----------+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_trainingparameter: - -.. table:: **Table 11** TrainingParameter - - ========= ========= ====== ================ - Parameter Mandatory Type Description - ========= ========= ====== ================ - label No String Parameter name. - value No String Parameter value. - ========= ========= ====== ================ - -.. _createtask__request_samplelabels: - -.. table:: **Table 12** SampleLabels - - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================+====================================================================================+ - | labels | No | Array of :ref:`SampleLabel ` objects | Sample label list. If this parameter is left blank, all sample labels are deleted. | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_id | No | String | Sample ID. | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_type | No | Integer | Sample type. The options are as follows: | - | | | | | - | | | | - **0**: image | - | | | | | - | | | | - **1**: text | - | | | | | - | | | | - **2**: speech | - | | | | | - | | | | - **4**: table | - | | | | | - | | | | - **6**: video | - | | | | | - | | | | - **9**: custom format | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_usage | No | String | Sample usage. The options are as follows: | - | | | | | - | | | | - **TRAIN**: training | - | | | | | - | | | | - **EVAL**: evaluation | - | | | | | - | | | | - **TEST**: test | - | | | | | - | | | | - **INFERENCE**: inference | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | source | No | String | Source address of sample data. | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------+ - -.. _createtask__request_samplelabel: - -.. table:: **Table 13** SampleLabel - - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=============================================================================+=======================================================================================================================================+ - | annotated_by | No | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | | - | | | | - **human**: manual labeling | - | | | | | - | | | | - **auto**: automatic labeling | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Label ID. | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | Float | Confidence. | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-----------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_samplelabelproperty: - -.. table:: **Table 14** SampleLabelProperty - - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | No | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | No | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | | - | | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | | - | | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | No | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | No | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | | - | | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | | - | | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | | - | | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | | - | | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | | - | | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | No | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | No | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | | - | | | | - **0/false**: not a hard example | - | | | | | - | | | | - **1/true**: hard example | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | No | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | No | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | No | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | No | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | No | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createtask__request_samplemetadata: - -.. table:: **Table 15** SampleMetadata - - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+===================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | No | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | No | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 16** Response body parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - task_id String Task ID. - ========= ====== =========== - -Example Requests ----------------- - -- Starting an Auto Labeling (Active Learning) Task - - .. code-block:: - - { - "task_type" : "auto-label", - "collect_key_sample" : true, - "config" : { - "algorithm_type" : "fast" - } - } - -- Starting an Auto Labeling (Pre-labeling) Task - - .. code-block:: - - { - "task_type" : "pre-label", - "model_id" : "c4989033-7584-44ee-a180-1c476b810e46", - "collect_key_sample" : true, - "config" : { - "inf_config_list" : [ { - "specification" : "modelarts.vm.cpu.2u", - "instance_count" : 1 - } ] - } - } - -- Starting an Auto Grouping Task - - .. code-block:: - - { - "type" : 2, - "export_type" : 1, - "config" : { - "n_clusters" : "2", - "ambiguity" : false, - "image_brightness" : false, - "image_colorfulness" : false, - "property" : "size" - } - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "r0jT2zwxBDKf8KEnSuZ" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/intelligent_task/stopping_an_intelligent_task.rst b/modelarts/api-ref/result/data_management/intelligent_task/stopping_an_intelligent_task.rst deleted file mode 100644 index afc4e6f6..00000000 --- a/modelarts/api-ref/result/data_management/intelligent_task/stopping_an_intelligent_task.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _StopAutoAnnotation: - -Stopping an Intelligent Task -============================ - -Function --------- - -This API is used to stop intelligent tasks, including auto labeling, one-click model deployment, and auto grouping tasks. You can specify the **task_id** parameter to stop a specific task. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}/stop - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | Task ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Stopping Auto Labeling, One-Click Model Deployment, or Auto Grouping Tasks - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/tasks/{task_id}/stop - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/creating_a_dataset_label.rst b/modelarts/api-ref/result/data_management/label_management/creating_a_dataset_label.rst deleted file mode 100644 index 6128d020..00000000 --- a/modelarts/api-ref/result/data_management/label_management/creating_a_dataset_label.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _CreateLabels: - -Creating a Dataset Label -======================== - -Function --------- - -This API is used to create a dataset label. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=============================================================+===============================+ - | labels | No | Array of :ref:`Label ` objects | List of labels to be created. | - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - -.. _createlabels__request_label: - -.. table:: **Table 3** Label - - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===============================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _createlabels__request_labelattribute: - -.. table:: **Table 4** LabelAttribute - - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=========================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _createlabels__request_labelattributevalue: - -.. table:: **Table 5** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _createlabels__request_labelproperty: - -.. table:: **Table 6** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response body for creating a label. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _createlabels__response_batchresponse: - -.. table:: **Table 8** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Creating a Dataset Label - -.. code-block:: - - { - "labels" : [ { - "name" : "Cat", - "property" : { - "@modelarts:color" : "#3399ff", - "@modelarts:default_shape" : "bndbox" - } - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/deleting_a_label_and_the_files_that_only_contain_the_label.rst b/modelarts/api-ref/result/data_management/label_management/deleting_a_label_and_the_files_that_only_contain_the_label.rst deleted file mode 100644 index 6a00bb36..00000000 --- a/modelarts/api-ref/result/data_management/label_management/deleting_a_label_and_the_files_that_only_contain_the_label.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. _DeleteLabelAndSamples: - -Deleting a Label and the Files that Only Contain the Label -========================================================== - -Function --------- - -This API is used to delete a label and the files that only contain this label. - -URI ---- - -DELETE /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | label_name | Yes | String | Label name. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================+ - | delete_source | No | Boolean | Whether to delete the sample source files. The options are as follows: | - | | | | | - | | | | - **true**: Delete the sample source files. | - | | | | | - | | | | - **false**: Do not delete the sample source files. (Default value) | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ - | label_type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 204** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting a Label and the Files that Only Contain the Label - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels/%E8%8D%89%E8%8E%93 - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/deleting_labels_in_batches.rst b/modelarts/api-ref/result/data_management/label_management/deleting_labels_in_batches.rst deleted file mode 100644 index 555ab514..00000000 --- a/modelarts/api-ref/result/data_management/label_management/deleting_labels_in_batches.rst +++ /dev/null @@ -1,236 +0,0 @@ -.. _DeleteLabels: - -Deleting Labels in Batches -========================== - -Function --------- - -This API is used to delete labels in batches. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/delete - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================+ - | delete_policy | No | Integer | Whether to delete a label and samples containing the label. The options are as follows: | - | | | | | - | | | | - **0**: Delete the label. | - | | | | | - | | | | - **1**: Delete the label and the samples that only contain this label, but do not delete source files. | - | | | | | - | | | | - **2**: Delete the label and the samples that only contain this label and also delete source files. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request body parameters - - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=============================================================+===============================+ - | labels | No | Array of :ref:`Label ` objects | List of labels to be deleted. | - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - -.. _deletelabels__request_label: - -.. table:: **Table 4** Label - - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===============================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _deletelabels__request_labelattribute: - -.. table:: **Table 5** LabelAttribute - - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=========================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _deletelabels__request_labelattributevalue: - -.. table:: **Table 6** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _deletelabels__request_labelproperty: - -.. table:: **Table 7** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 8** Response body parameters - - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response body for deleting a label. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _deletelabels__response_batchresponse: - -.. table:: **Table 9** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting Labels in Batches - -.. code-block:: - - { - "labels" : [ { - "name" : "strawberry" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/index.rst b/modelarts/api-ref/result/data_management/label_management/index.rst deleted file mode 100644 index a52fa7b2..00000000 --- a/modelarts/api-ref/result/data_management/label_management/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _label_management: - -================ -Label Management -================ - -.. toctree:: - :maxdepth: 1 - - querying_the_dataset_label_list - creating_a_dataset_label - modifying_labels_in_batches - deleting_labels_in_batches - updating_a_label_by_label_names - deleting_a_label_and_the_files_that_only_contain_the_label diff --git a/modelarts/api-ref/result/data_management/label_management/modifying_labels_in_batches.rst b/modelarts/api-ref/result/data_management/label_management/modifying_labels_in_batches.rst deleted file mode 100644 index 739af008..00000000 --- a/modelarts/api-ref/result/data_management/label_management/modifying_labels_in_batches.rst +++ /dev/null @@ -1,226 +0,0 @@ -.. _UpdateLabels: - -Modifying Labels in Batches -=========================== - -Function --------- - -This API is used to modify labels in batches. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=============================================================+===============================+ - | labels | No | Array of :ref:`Label ` objects | List of labels to be updated. | - +-----------+-----------+-------------------------------------------------------------+-------------------------------+ - -.. _updatelabels__request_label: - -.. table:: **Table 3** Label - - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===============================================================================+==================================================================================================================================+ - | attributes | No | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _updatelabels__request_labelattribute: - -.. table:: **Table 4** LabelAttribute - - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=========================================================================================+===================================================+ - | default_value | No | String | Default value of a label attribute. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | No | String | Label attribute ID. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | No | String | Label attribute name. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | No | String | Label attribute type. The options are as follows: | - | | | | | - | | | | - **text**: text | - | | | | | - | | | | - **select**: single-choice drop-down list | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | No | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------+-----------------+-----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _updatelabels__request_labelattributevalue: - -.. table:: **Table 5** LabelAttributeValue - - ========= ========= ====== ========================= - Parameter Mandatory Type Description - ========= ========= ====== ========================= - id No String Label attribute value ID. - value No String Label attribute value. - ========= ========= ====== ========================= - -.. _updatelabels__request_labelproperty: - -.. table:: **Table 6** LabelProperty - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response body for updating labels. | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+------------------------------------------------------------------------------+------------------------------------------------------------------+ - -.. _updatelabels__response_batchresponse: - -.. table:: **Table 8** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Modifying Labels in Batches - -.. code-block:: - - { - "labels" : [ { - "name" : "Cat", - "property" : { - "@modelarts:color" : "#8a1524", - "@modelarts:rename_to" : "pussycat" - } - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/querying_the_dataset_label_list.rst b/modelarts/api-ref/result/data_management/label_management/querying_the_dataset_label_list.rst deleted file mode 100644 index 41eb0b2a..00000000 --- a/modelarts/api-ref/result/data_management/label_management/querying_the_dataset_label_list.rst +++ /dev/null @@ -1,204 +0,0 @@ -.. _ListLabels: - -Querying the Dataset Label List -=============================== - -Function --------- - -This API is used to query all labels of a dataset. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - ========== ========= ====== =================== - Parameter Mandatory Type Description - ========== ========= ====== =================== - version_id No String Dataset version ID. - ========== ========= ====== =================== - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------+------------------------------------------------------------+-------------+ - | Parameter | Type | Description | - +===========+============================================================+=============+ - | labels | Array of :ref:`Label ` objects | Label list. | - +-----------+------------------------------------------------------------+-------------+ - -.. _listlabels__response_label: - -.. table:: **Table 4** Label - - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listlabels__response_labelattribute: - -.. table:: **Table 5** LabelAttribute - - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listlabels__response_labelattributevalue: - -.. table:: **Table 6** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _listlabels__response_labelproperty: - -.. table:: **Table 7** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying All Labels of a Dataset - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/WxCREuCkBSAlQr9xrde/data-annotations/labels - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "labels" : [ { - "name" : "Cat", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 1, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/label_management/updating_a_label_by_label_names.rst b/modelarts/api-ref/result/data_management/label_management/updating_a_label_by_label_names.rst deleted file mode 100644 index e0d65360..00000000 --- a/modelarts/api-ref/result/data_management/label_management/updating_a_label_by_label_names.rst +++ /dev/null @@ -1,149 +0,0 @@ -.. _UpdateLabel: - -Updating a Label by Label Names -=============================== - -Function --------- - -This API is used to update a label by label names. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/labels/{label_name} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | label_name | Yes | String | Label name. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-----------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=========================================+ - | label_type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+-----------------+-----------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request body parameters - - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==========================+=================+=================+================================================================================================================================================================================================================+ - | @modelarts:color | No | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | No | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | No | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | No | String | Default attribute: The new name of the label. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | No | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | No | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 204** - -.. table:: **Table 4** Response body parameters - - +-----------------------+-----------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+-----------------------+------------------------------------------------------------------+ - -Example Requests ----------------- - -Updating a Label by Label Names - -.. code-block:: - - { - "@modelarts:color" : "#93c47d" - } - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_acceptance_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_acceptance_task.rst deleted file mode 100644 index 5c729a92..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_acceptance_task.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. _StartWorkforceSamplingTask: - -Creating a Team Labeling Acceptance Task -======================================== - -Function --------- - -This API is used to create a team labeling acceptance task. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+=========+===============================================================================================================================+ - | sampling_num | No | Integer | Number of samples for the acceptance task. Either this parameter or the sampling ratio is delivered. | - +---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+ - | sampling_rate | No | Double | Sampling ratio of the acceptance task. The value range is (0,1]. Either this parameter or the number of samples is delivered. | - +---------------+-----------+---------+-------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - ========= ====== ====================================== - Parameter Type Description - ========= ====== ====================================== - task_id String ID of an asynchronous acceptance task. - ========= ====== ====================================== - -Example Requests ----------------- - -Creating a Team Labeling Acceptance Task and Setting the Sampling Percentage to 20% - -.. code-block:: - - { - "sampling_rate" : 0.2 - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "nv6BbozxCJmZcHAE9hV" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_task.rst deleted file mode 100644 index c75d8c7b..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/creating_a_team_labeling_task.rst +++ /dev/null @@ -1,213 +0,0 @@ -.. _CreateWorkforceTask: - -Creating a Team Labeling Task -============================= - -Function --------- - -This API is used to create a team labeling task. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================================+=================+================================================================================+=====================================================================================================================+ - | auto_sync_dataset | No | Boolean | Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: | - | | | | | - | | | | - **true**: Automatically synchronize the result of a team labeling task to the dataset. (Default value) | - | | | | | - | | | | - **false**: Do not automatically synchronize the result of a team labeling task to the dataset. | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | data_sync_type | No | Integer | Synchronization type. The options are as follows: | - | | | | | - | | | | - **0**: not to be synchronized | - | | | | | - | | | | - **1**: data to be synchronized | - | | | | | - | | | | - **2**: label to be synchronized | - | | | | | - | | | | - **3**: data and label to be synchronized | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | repetition | No | Integer | Number of persons who label each sample in a team labeling task. The minimum value is **1**. | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | sample_conditions | No | String | Search conditions of dataset samples. Samples that meet the conditions are filtered for team labeling. | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | synchronize_auto_labeling_data | No | Boolean | Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: | - | | | | | - | | | | - **true**: Synchronize the results to be confirmed to team members after auto labeling is complete. | - | | | | | - | | | | - **false**: Do not synchronize the auto labeling results. (Default value) | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - | workforces_config | No | :ref:`WorkforcesConfig ` object | Team labeling task information: Tasks can be assigned by the team administrator or a specified team. | - +--------------------------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------+ - -.. _createworkforcetask__request_workforcesconfig: - -.. table:: **Table 3** WorkforcesConfig - - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========================================================================================+============================================+ - | agency | No | String | Administrator. | - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | No | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _createworkforcetask__request_workforceconfig: - -.. table:: **Table 4** WorkforceConfig - - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+======================================================================+=================================================================================================================================+ - | workers | No | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | No | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _createworkforcetask__request_worker: - -.. table:: **Table 5** Worker - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | create_time | No | Long | Creation time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | No | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - | | | | | - | | | | - **3**: dataset owner | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | | - | | | | - **0**: The invitation email has not been sent. | - | | | | | - | | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | | - | | | | - **2**: The user has logged in. | - | | | | | - | | | | - **3**: The labeling team member has been deleted. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | No | Long | Update time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 6** Response body parameters - - ========= ====== =========================== - Parameter Type Description - ========= ====== =========================== - task_id String ID of a team labeling task. - ========= ====== =========================== - -Example Requests ----------------- - -Creating a Team Labeling Task - -.. code-block:: - - { - "workspace_id" : "0", - "task_name" : "task-eb17", - "task_type" : 0, - "description" : "", - "version_id" : "", - "labels" : [ { - "name" : "Cat", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ], - "synchronize_data" : false, - "synchronize_auto_labeling_data" : false, - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "feSUo5NUIUnQAQNNTiS", - "workers" : [ { - "email" : "xxx@xxx.com" - }, { - "email" : "xxx@xxx.com" - }, { - "email" : "xxx@xxx.com" - } ] - } ] - }, - "auto_sync_dataset" : false - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "6phXEto29utpaMwbQkg" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/deleting_a_team_labeling_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/deleting_a_team_labeling_task.rst deleted file mode 100644 index 20428f64..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/deleting_a_team_labeling_task.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _DeleteWorkforceTask: - -Deleting a Team Labeling Task -============================= - -Function --------- - -This API is used to delete a team labeling task. - -URI ---- - -DELETE /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Team Labeling Task - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/index.rst b/modelarts/api-ref/result/data_management/labeling_task_management/index.rst deleted file mode 100644 index b0873795..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _label_task_management: - -======================== -Labeling Task Management -======================== - -.. toctree:: - :maxdepth: 1 - - querying_the_team_labeling_task_list_of_a_dataset - creating_a_team_labeling_task - querying_details_about_a_team_labeling_task - starting_a_team_labeling_task - updating_a_team_labeling_task - deleting_a_team_labeling_task - creating_a_team_labeling_acceptance_task - querying_the_report_of_a_team_labeling_acceptance_task - updating_the_status_of_a_team_labeling_acceptance_task - querying_the_team_labeling_task_list_by_a_team_member diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/querying_details_about_a_team_labeling_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/querying_details_about_a_team_labeling_task.rst deleted file mode 100644 index b961fb50..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/querying_details_about_a_team_labeling_task.rst +++ /dev/null @@ -1,688 +0,0 @@ -.. _DescWorkforceTask: - -Querying Details About a Team Labeling Task -=========================================== - -Function --------- - -This API is used to query the details about a team labeling task. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | label_stats | No | Boolean | Whether to return label statistics. The options are as follows: | - | | | | | - | | | | - **true**: Return label statistics. | - | | | | | - | | | | - **false**: Do not return label statistics. (Default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | sample_stats | No | Boolean | Whether to return sample statistics. The options are as follows: | - | | | | | - | | | | - **true**: Return sample statistics. | - | | | | | - | | | | - **false**: Do not return sample statistics. (Default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | workforce_stats | No | Boolean | Whether to return personnel statistics. The options are as follows: | - | | | | | - | | | | - **true**: Return personnel statistics. | - | | | | | - | | | | - **false**: Do not return personnel statistics. (Default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================================+=================================================================================================+===================================================================================================================================================================================================================================================================================================================================================+ - | auto_sync_dataset | Boolean | Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: | - | | | | - | | | - **true**: Automatically synchronize the result of a team labeling task to the dataset. | - | | | | - | | | - **false**: Do not automatically synchronize the result of a team labeling task to the dataset. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | check_rate | Double | Acceptance ratio of a team labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_task_desc | :ref:`WorkforceSamplingTaskDesc ` object | Details about the current acceptance task of a team labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a labeling task is created. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics of a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pass_rate | Double | Acceptance pass rate of a team labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repetition | Integer | Number of persons who label each sample in a team labeling task. The minimum value is **1**. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_search_conditions | Array of :ref:`SearchCondition ` objects | Sample search conditions when creating a task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_stats | :ref:`SampleStats ` object | Sample statistics of a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | Double | Average acceptance score of a team labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a team labeling task. The options are as follows: | - | | | | - | | | - **6**: created. The owner has created a task but does not start it. Only the owner and manager can view the task list. | - | | | | - | | | - **0**: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started. | - | | | | - | | | - **1**: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again. | - | | | | - | | | - **2**: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed. | - | | | | - | | | - **3**: passed. The team labeling task has been completed. | - | | | | - | | | - **4**: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing. | - | | | | - | | | - **5**: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized. | - | | | | - | | | - **7**: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_auto_labeling_data | Boolean | Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: | - | | | | - | | | - **true**: Synchronize the results to be confirmed to team members after auto labeling is complete. | - | | | | - | | | - **false**: Do not synchronize the auto labeling results. (Default value) | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_data | Boolean | Whether to synchronize the added data of a team labeling task. The options are as follows: | - | | | | - | | | - **true**: Upload files, synchronize data sources, and synchronize imported unlabeled files to team members. | - | | | | - | | | - **false**: Do not synchronize the added data. (Default value) | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | ID of a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | String | Name of a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling task is updated. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version ID of the dataset associated with a labeling task. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_stats | Array of :ref:`WorkerTask ` objects | Labeling progress statistics on team labeling task members. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_stats | :ref:`WorkforceStats ` object | Statistics on team labeling task members. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforces_config | :ref:`WorkforcesConfig ` object | Team labeling task information: Tasks can be assigned by the team administrator or a specified team. | - +--------------------------------+-------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_workforcesamplingtaskdesc: - -.. table:: **Table 4** WorkforceSamplingTaskDesc - - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================================================================+==================================================================================================================================================+ - | action | Integer | Action after the acceptance. The options are as follows: | - | | | | - | | | - **0**: Pass all samples when the acceptance is completed (including single-rejected samples) | - | | | | - | | | - **1**: Reject all samples when the acceptance is completed (including single-accepted samples) | - | | | | - | | | - **4**: Pass only single-accepted samples and unaccepted samples. | - | | | | - | | | - **5**: Reject only single-rejected samples and unaccepted samples. | - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_stats | :ref:`CheckTaskStats ` object | Real-time report of acceptance tasks. | - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_task_id | String | ID of the current acceptance task. | - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | overwrite_last_result | Boolean | Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows: | - | | | | - | | | - **true**: Overwrite the labeled result. | - | | | | - | | | - **false**: Do not overwrite the labeled result. (Default value) | - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_stats | :ref:`CheckTaskStats ` object | Overall report of historical acceptance tasks. | - +-----------------------+---------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_checktaskstats: - -.. table:: **Table 5** CheckTaskStats - - ====================== ======= ==================================== - Parameter Type Description - ====================== ======= ==================================== - accepted_sample_count Integer Accepted samples. - checked_sample_count Integer Checked samples. - pass_rate Double Pass rate of samples. - rejected_sample_count Integer Rejected samples. - sampled_sample_count Integer Number of sampled samples. - sampling_num Integer Samples of an acceptance task. - sampling_rate Double Sampling rate of an acceptance task. - score String Acceptance score. - task_id String ID of an acceptance task. - total_sample_count Integer Total samples. - total_score Long Total acceptance score. - unchecked_sample_count Integer Unchecked samples. - ====================== ======= ==================================== - -.. _descworkforcetask__response_labelstats: - -.. table:: **Table 6** LabelStats - - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=====================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_labelattribute: - -.. table:: **Table 7** LabelAttribute - - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _descworkforcetask__response_labelattributevalue: - -.. table:: **Table 8** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _descworkforcetask__response_labelproperty: - -.. table:: **Table 9** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_searchcondition: - -.. table:: **Table 10** SearchCondition - - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+-----------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_searchlabels: - -.. table:: **Table 11** SearchLabels - - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+-------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_searchlabel: - -.. table:: **Table 12** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_searchprop: - -.. table:: **Table 13** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -.. _descworkforcetask__response_samplestats: - -.. table:: **Table 14** SampleStats - - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============================+=========+=====================================================================================================+ - | accepted_sample_count | Integer | Number of samples accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | auto_annotation_sample_count | Integer | Number of samples to be confirmed after intelligent labeling. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | rejected_sample_count | Integer | Number of samples that failed to pass the owner acceptance. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | sampled_sample_count | Integer | Number of samples that are to be accepted by the owner and sampled. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unannotated_sample_count | Integer | Number of unlabeled samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | uncheck_sample_count | Integer | Number of samples that have been approved by the reviewer and are to be accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unreviewed_sample_count | Integer | Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_workertask: - -.. table:: **Table 15** WorkerTask - - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=====================================================================+==================================================================================================+ - | create_time | Long | Time when a labeling team member's task is created. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | dataset_id | String | ID of a dataset associated with a labeling team member's task. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | dataset_type | Integer | Labeling type of a team member's task. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | email_status | Integer | Email notification status of a labeling team member's labeling task. The options are as follows: | - | | | | - | | | - **0**: The email has not been sent. | - | | | | - | | | - **1**: The email format is incorrect. | - | | | | - | | | - **2**: The email address is unreachable. | - | | | | - | | | - **3**: The email has been sent. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | last_notify_time | Long | Timestamp of the latest notification email sent to a labeling team member. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | pass_rate | Double | Pass rate of task acceptance review for a labeling team member. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | role | Integer | Role of a labeling team member. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | sample_stats | :ref:`SampleStats ` object | Sample statistics of a labeling team member's task. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | score | Double | Average acceptance score of labeling team members' task samples. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | task_id | String | Team labeling task ID associated with a member's task. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | task_status | Integer | Task status of a labeling team member. The options are as follows: | - | | | | - | | | - **6**: created | - | | | | - | | | - **0**: starting | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: under acceptance | - | | | | - | | | - **3**: approved, indicating the team labeling task is complete | - | | | | - | | | - **4**: rejected, indicating that the task needs to be labeled and reviewed again | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling team member's task is updated. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | workforce_task_name | String | Team labeling task name associated with a member's task. | - +-----------------------+---------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_workforcestats: - -.. table:: **Table 16** WorkforceStats - - =============== ======= =========================== - Parameter Type Description - =============== ======= =========================== - labeler_count Integer Number of labeling persons. - reviewer_count Integer Number of reviewers. - workforce_count Integer Number of teams. - =============== ======= =========================== - -.. _descworkforcetask__response_workforcesconfig: - -.. table:: **Table 17** WorkforcesConfig - - +------------+---------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Type | Description | - +============+=======================================================================================+============================================+ - | agency | String | Administrator. | - +------------+---------------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+---------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _descworkforcetask__response_workforceconfig: - -.. table:: **Table 18** WorkforceConfig - - +----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=====================================================================+=================================================================================================================================+ - | workers | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _descworkforcetask__response_worker: - -.. table:: **Table 19** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Team Labeling Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "dataset_id" : "WxCREuCkBSAlQr9xrde", - "task_id" : "iYZx7gScPUozOXner9k", - "task_name" : "task-e63f", - "status" : 1, - "create_time" : 1606184400278, - "update_time" : 1606184400278, - "repetition" : 1, - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "q3ZFSwORu1ztKljDLYQ", - "workers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", - "role" : 0 - } ] - } ] - }, - "synchronize_data" : false, - "synchronize_auto_labeling_data" : false, - "workforce_stats" : { - "workforce_count" : 1, - "labeler_count" : 1, - "reviewer_count" : 0 - }, - "sample_stats" : { - "total_sample_count" : 317, - "unannotated_sample_count" : 310, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 0, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 7, - "auto_annotation_sample_count" : 0 - }, - "checking_task_desc" : { - "checking_task_id" : "onSbri2oqYOmDjDyW17", - "action" : 0, - "overwrite_last_result" : false - }, - "auto_check_samples" : true, - "auto_sync_dataset" : true, - "worker_stats" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", - "role" : 0, - "task_id" : "iYZx7gScPUozOXner9k", - "workforce_task_name" : "task-e63f", - "dataset_id" : "WxCREuCkBSAlQr9xrde", - "sample_stats" : { - "total_sample_count" : 317, - "unannotated_sample_count" : 310, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 0, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 7, - "auto_annotation_sample_count" : 0 - }, - "create_time" : 1606184400278, - "update_time" : 1606184795050, - "email_status" : 3, - "last_notify_time" : 0, - "user" : { - "domainId" : "04f924738800d3270fc0c013a47363a0", - "domainName" : "test_123", - "projectId" : "04f924739300d3272fc3c013e36bb4b8", - "userId" : "04f924743b00d4331f31c0131ada6769", - "userName" : "test_123" - } - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_report_of_a_team_labeling_acceptance_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_report_of_a_team_labeling_acceptance_task.rst deleted file mode 100644 index 904b8435..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_report_of_a_team_labeling_acceptance_task.rst +++ /dev/null @@ -1,126 +0,0 @@ -.. _GetWorkforceSamplingTask: - -Querying the Report of a Team Labeling Acceptance Task -====================================================== - -Function --------- - -This API is used to query the report of a team labeling acceptance task. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/report - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - ================ ========= ====== ===================================== - Parameter Mandatory Type Description - ================ ========= ====== ===================================== - checking_task_id Yes String ID of the task that is being checked. - ================ ========= ====== ===================================== - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +----------------+----------------------------------------------------------------------------------+----------------------------------+ - | Parameter | Type | Description | - +================+==================================================================================+==================================+ - | checking_stats | :ref:`CheckTaskStats ` object | Real-time acceptance statistics. | - +----------------+----------------------------------------------------------------------------------+----------------------------------+ - | total_stats | :ref:`CheckTaskStats ` object | Historical statistics. | - +----------------+----------------------------------------------------------------------------------+----------------------------------+ - -.. _getworkforcesamplingtask__response_checktaskstats: - -.. table:: **Table 4** CheckTaskStats - - ====================== ======= ==================================== - Parameter Type Description - ====================== ======= ==================================== - accepted_sample_count Integer Accepted samples. - checked_sample_count Integer Checked samples. - pass_rate Double Pass rate of samples. - rejected_sample_count Integer Rejected samples. - sampled_sample_count Integer Number of sampled samples. - sampling_num Integer Samples of an acceptance task. - sampling_rate Double Sampling rate of an acceptance task. - score String Acceptance score. - task_id String ID of an acceptance task. - total_sample_count Integer Total samples. - total_score Long Total acceptance score. - unchecked_sample_count Integer Unchecked samples. - ====================== ======= ==================================== - -Example Requests ----------------- - -Querying the Report of a Team Labeling Acceptance Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/report - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_stats" : { - "sampling_rate" : 1.0, - "sampling_num" : 3, - "pass_rate" : 0.0, - "score" : "E", - "total_score" : 0, - "total_sample_count" : 3, - "sampled_sample_count" : 3, - "unchecked_sample_count" : 3, - "checked_sample_count" : 0, - "accepted_sample_count" : 0, - "rejected_sample_count" : 0 - } - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_by_a_team_member.rst b/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_by_a_team_member.rst deleted file mode 100644 index 5e8737b1..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_by_a_team_member.rst +++ /dev/null @@ -1,250 +0,0 @@ -.. _ListWorkerTasks: - -Querying the Team Labeling Task List by a Team Member -===================================================== - -Function --------- - -This API is used to query the team labeling task list by a team member. - -URI ---- - -GET /v2/{project_id}/workforces/worker-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting method. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Fuzzy search keyword. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **workforce_task_name**: Sort by task name. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+---------------------------------------------------------------------------+------------------------------------------+ - | Parameter | Type | Description | - +==============+===========================================================================+==========================================+ - | count | Integer | Total number of team labeling tasks. | - +--------------+---------------------------------------------------------------------------+------------------------------------------+ - | worker_tasks | Array of :ref:`WorkerTask ` objects | Team labeling task list queried by page. | - +--------------+---------------------------------------------------------------------------+------------------------------------------+ - -.. _listworkertasks__response_workertask: - -.. table:: **Table 4** WorkerTask - - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================+==================================================================================================+ - | create_time | Long | Time when a labeling team member's task is created. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | dataset_id | String | ID of a dataset associated with a labeling team member's task. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | dataset_type | Integer | Labeling type of a team member's task. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | email_status | Integer | Email notification status of a labeling team member's labeling task. The options are as follows: | - | | | | - | | | - **0**: The email has not been sent. | - | | | | - | | | - **1**: The email format is incorrect. | - | | | | - | | | - **2**: The email address is unreachable. | - | | | | - | | | - **3**: The email has been sent. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | last_notify_time | Long | Timestamp of the latest notification email sent to a labeling team member. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | pass_rate | Double | Pass rate of task acceptance review for a labeling team member. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | role | Integer | Role of a labeling team member. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | sample_stats | :ref:`SampleStats ` object | Sample statistics of a labeling team member's task. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | score | Double | Average acceptance score of labeling team members' task samples. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | task_id | String | Team labeling task ID associated with a member's task. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | task_status | Integer | Task status of a labeling team member. The options are as follows: | - | | | | - | | | - **6**: created | - | | | | - | | | - **0**: starting | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: under acceptance | - | | | | - | | | - **3**: approved, indicating the team labeling task is complete | - | | | | - | | | - **4**: rejected, indicating that the task needs to be labeled and reviewed again | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling team member's task is updated. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - | workforce_task_name | String | Team labeling task name associated with a member's task. | - +-----------------------+-------------------------------------------------------------------+--------------------------------------------------------------------------------------------------+ - -.. _listworkertasks__response_samplestats: - -.. table:: **Table 5** SampleStats - - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============================+=========+=====================================================================================================+ - | accepted_sample_count | Integer | Number of samples accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | auto_annotation_sample_count | Integer | Number of samples to be confirmed after intelligent labeling. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | rejected_sample_count | Integer | Number of samples that failed to pass the owner acceptance. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | sampled_sample_count | Integer | Number of samples that are to be accepted by the owner and sampled. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unannotated_sample_count | Integer | Number of unlabeled samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | uncheck_sample_count | Integer | Number of samples that have been approved by the reviewer and are to be accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unreviewed_sample_count | Integer | Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Team Labeling Task List by a Team Member - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces/worker-tasks?offset=0&limit=10&sort_by=create_time&order=desc&filePreview=false - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "count" : 2, - "worker_tasks" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "role" : 0, - "task_id" : "tY330MHxV9dqIPVaTRM", - "workforce_task_name" : "task-cd60", - "dataset_id" : "WxCREuCkBSAlQr9xrde", - "sample_stats" : { - "total_sample_count" : 309, - "unannotated_sample_count" : 308, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 1, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 0, - "auto_annotation_sample_count" : 0 - }, - "create_time" : 1606224714358, - "update_time" : 1606224878490, - "email_status" : 3, - "last_notify_time" : 0, - "dataset_type" : 1, - "task_status" : 1, - "user" : { - "domainId" : "04f924738800d3270fc0c013a47363a0", - "domainName" : "test_123", - "projectId" : "04f924739300d3272fc3c013e36bb4b8", - "userId" : "04f924743b00d4331f31c0131ada6769", - "userName" : "test_123" - } - }, { - "email" : "xxx@xxx.com", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "role" : 0, - "task_id" : "MJVjCQDMso95a8dvUm4", - "workforce_task_name" : "task-2720", - "dataset_id" : "OY82gjEHxt9w1efgrhS", - "sample_stats" : { - "total_sample_count" : 50005, - "unannotated_sample_count" : 50005, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 0, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 0, - "auto_annotation_sample_count" : 0 - }, - "create_time" : 1605949737134, - "update_time" : 1605949737134, - "email_status" : 3, - "last_notify_time" : 0, - "dataset_type" : 0, - "task_status" : 2, - "user" : { - "domainId" : "04f924738800d3270fc0c013a47363a0", - "domainName" : "test_123", - "projectId" : "04f924739300d3272fc3c013e36bb4b8", - "userId" : "04f924743b00d4331f31c0131ada6769", - "userName" : "test_123" - } - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_of_a_dataset.rst b/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_of_a_dataset.rst deleted file mode 100644 index df51c0b3..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/querying_the_team_labeling_task_list_of_a_dataset.rst +++ /dev/null @@ -1,649 +0,0 @@ -.. _ListWorkforceTasks: - -Querying the Team Labeling Task List of a Dataset -================================================= - -Function --------- - -This API is used to query the team labeling task list of a dataset. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------+------------------------------------------------------------------------------------+------------------------------------------+ - | Parameter | Type | Description | - +===========+====================================================================================+==========================================+ - | count | Integer | Total number of team labeling tasks. | - +-----------+------------------------------------------------------------------------------------+------------------------------------------+ - | tasks | Array of :ref:`WorkforceTask ` objects | Team labeling task list queried by page. | - +-----------+------------------------------------------------------------------------------------+------------------------------------------+ - -.. _listworkforcetasks__response_workforcetask: - -.. table:: **Table 3** WorkforceTask - - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================================+==================================================================================================+===================================================================================================================================================================================================================================================================================================================================================+ - | auto_sync_dataset | Boolean | Whether to automatically synchronize the result of a team labeling task to the dataset. The options are as follows: | - | | | | - | | | - **true**: Automatically synchronize the result of a team labeling task to the dataset. | - | | | | - | | | - **false**: Do not automatically synchronize the result of a team labeling task to the dataset. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | check_rate | Double | Acceptance ratio of a team labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_task_desc | :ref:`WorkforceSamplingTaskDesc ` object | Details about the current acceptance task of a team labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a labeling task is created. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_stats | Array of :ref:`LabelStats ` objects | Label statistics of a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pass_rate | Double | Acceptance pass rate of a team labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repetition | Integer | Number of persons who label each sample in a team labeling task. The minimum value is **1**. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_search_conditions | Array of :ref:`SearchCondition ` objects | Sample search criteria when creating a task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_stats | :ref:`SampleStats ` object | Sample statistics of a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | Double | Average acceptance score of a team labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a team labeling task. The options are as follows: | - | | | | - | | | - **6**: created. The owner has created a task but does not start it. Only the owner and manager can view the task list. | - | | | | - | | | - **0**: starting. The owner or manager starts the task and assigns the files to be labeled. The owner, manager, labeler, and reviewer can view the task list. If the task assignment is not complete, a new task cannot be started. | - | | | | - | | | - **1**: running. The task is labeled and reviewed by the labeler and reviewer, respectively and is accepted by the owner. If auto labeling files are added or synchronized, or unlabeled files are imported, the new files need to be assigned again. | - | | | | - | | | - **2**: under acceptance. The owner initiates an acceptance task but does not complete it. In this state, a new acceptance task cannot be initiated until the current one is completed. | - | | | | - | | | - **3**: passed. The team labeling task has been completed. | - | | | | - | | | - **4**: rejected. In this state, the manager starts the task again and assigns it for labeling and reviewing. | - | | | | - | | | - **5**: synchronizing acceptance result. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance result is being synchronized. | - | | | | - | | | - **7**: acceptance sampling. This state is displayed when acceptance tasks are changed to be asynchronous. In this state, new acceptance tasks cannot be initiated and the current acceptance task cannot be continued. In the task name area, a message is displayed, indicating that the acceptance sampling is in progress. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_auto_labeling_data | Boolean | Whether to synchronize the auto labeling result of a team labeling task. The options are as follows: | - | | | | - | | | - **true**: Synchronize the results to be confirmed to team members after auto labeling is complete. | - | | | | - | | | - **false**: Do not synchronize the auto labeling results. (Default value) | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | synchronize_data | Boolean | Whether to synchronize the added data of a team labeling task. The options are as follows: | - | | | | - | | | - **true**: Synchronize uploaded files, data sources, and imported unlabeled files to team members. | - | | | | - | | | - **false**: Do not synchronize the added data. (Default value) | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | ID of a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | String | Name of a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling task is updated. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version ID of the dataset associated with a labeling task. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_stats | :ref:`WorkforceStats ` object | Statistics on team labeling task members. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workforces_config | :ref:`WorkforcesConfig ` object | Team labeling task information: Tasks can be assigned by the team administrator or a specified team. | - +--------------------------------+--------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_workforcesamplingtaskdesc: - -.. table:: **Table 4** WorkforceSamplingTaskDesc - - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================+==================================================================================================================================================+ - | action | Integer | Action after the acceptance. The options are as follows: | - | | | | - | | | - **0**: Pass all samples when the acceptance is completed (including single-rejected samples) | - | | | | - | | | - **1**: Reject all samples when the acceptance is completed (including single-accepted samples) | - | | | | - | | | - **4**: Pass only single-accepted samples and unaccepted samples. | - | | | | - | | | - **5**: Reject only single-rejected samples and unaccepted samples. | - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_stats | :ref:`CheckTaskStats ` object | Real-time report of acceptance tasks. | - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | checking_task_id | String | ID of the current acceptance task. | - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | overwrite_last_result | Boolean | Whether to use the acceptance result to overwrite the labeled result if a sample has been labeled during acceptance. The options are as follows: | - | | | | - | | | - **true**: Overwrite the labeled result. | - | | | | - | | | - **false**: Do not overwrite the labeled result. (Default value) | - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_stats | :ref:`CheckTaskStats ` object | Overall report of historical acceptance tasks. | - +-----------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_checktaskstats: - -.. table:: **Table 5** CheckTaskStats - - ====================== ======= ==================================== - Parameter Type Description - ====================== ======= ==================================== - accepted_sample_count Integer Accepted samples. - checked_sample_count Integer Checked samples. - pass_rate Double Pass rate of samples. - rejected_sample_count Integer Rejected samples. - sampled_sample_count Integer Number of sampled samples. - sampling_num Integer Samples of an acceptance task. - sampling_rate Double Sampling rate of an acceptance task. - score String Acceptance score. - task_id String ID of an acceptance task. - total_sample_count Integer Total samples. - total_score Long Total acceptance score. - unchecked_sample_count Integer Unchecked samples. - ====================== ======= ==================================== - -.. _listworkforcetasks__response_labelstats: - -.. table:: **Table 6** LabelStats - - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+======================================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of labels. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | sample_count | Integer | Number of samples containing the label. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_labelattribute: - -.. table:: **Table 7** LabelAttribute - - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+------------------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listworkforcetasks__response_labelattributevalue: - -.. table:: **Table 8** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _listworkforcetasks__response_labelproperty: - -.. table:: **Table 9** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_searchcondition: - -.. table:: **Table 10** SearchCondition - - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================+==================================================================================================================================================================================================================================================================+ - | coefficient | String | Filter by coefficient of difficulty. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | frame_in_video | Integer | A frame in the video. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | hard | String | Whether a sample is a hard sample. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | import_origin | String | Filter by data source. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | kvp | String | CT dosage, filtered by dosage. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_list | :ref:`SearchLabels ` object | Label search criteria. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labeler | String | Labeler. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SearchProp ` object | Search by sample attribute. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parent_sample_id | String | Parent sample ID. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Directory where data samples are stored (the directory must end with a slash (/)). Only samples in the specified directory are searched for. Recursive search of directories is not supported. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Search by sample name, including the file name extension. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | String | When a sample is added to the dataset, an index is created based on the last modification time (accurate to day) of the sample on OBS. You can search for the sample based on the time. The options are as follows: | - | | | | - | | | - **month**: Search for samples added from 30 days ago to the current day. | - | | | | - | | | - **day**: Search for samples added from yesterday (one day ago) to the current day. | - | | | | - | | | - **yyyyMMdd-yyyyMMdd**: Search for samples added in a specified period (at most 30 days), in the format of **Start date-End date**. For example, **20190901-2019091501** indicates that samples generated from September 1 to September 15, 2019 are searched. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Search by confidence. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | slice_thickness | String | DICOM layer thickness. Samples are filtered by layer thickness. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | study_date | String | DICOM scanning time. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | time_in_video | String | A time point in the video. | - +-----------------------+------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_searchlabels: - -.. table:: **Table 11** SearchLabels - - +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================+==============================================================================================================================================================+ - | labels | Array of :ref:`SearchLabel ` objects | List of label search criteria. | - +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | If you want to search for multiple labels, **op** must be specified. If you search for only one label, **op** can be left blank. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_searchlabel: - -.. table:: **Table 12** SearchLabel - - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+========================================================================================================================================================================================================================================================================================+ - | name | String | Label name. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | op | String | Operation type between multiple attributes. The options are as follows: | - | | | | - | | | - **OR**: OR operation | - | | | | - | | | - **AND**: AND operation | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | Map> | Label attribute, which is in the Object format and stores any key-value pairs. **key** indicates the attribute name, and **value** indicates the value list. If **value** is **null**, the search is not performed by value. Otherwise, the search value can be any value in the list. | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_searchprop: - -.. table:: **Table 13** SearchProp - - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=======================================================================+ - | op | String | Relationship between attribute values. The options are as follows: | - | | | | - | | | - **AND**: AND relationship | - | | | | - | | | - **OR**: OR relationship | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - | props | Map> | Search criteria of an attribute. Multiple search criteria can be set. | - +-----------------------+---------------------------+-----------------------------------------------------------------------+ - -.. _listworkforcetasks__response_samplestats: - -.. table:: **Table 14** SampleStats - - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============================+=========+=====================================================================================================+ - | accepted_sample_count | Integer | Number of samples accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | auto_annotation_sample_count | Integer | Number of samples to be confirmed after intelligent labeling. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | rejected_sample_count | Integer | Number of samples that failed to pass the owner acceptance. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | sampled_sample_count | Integer | Number of samples that are to be accepted by the owner and sampled. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | total_sample_count | Integer | Total number of samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unannotated_sample_count | Integer | Number of unlabeled samples. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | uncheck_sample_count | Integer | Number of samples that have been approved by the reviewer and are to be accepted by the owner. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - | unreviewed_sample_count | Integer | Number of samples that have been labeled by the labeler but have not been reviewed by the reviewer. | - +------------------------------+---------+-----------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_workforcestats: - -.. table:: **Table 15** WorkforceStats - - =============== ======= =========================== - Parameter Type Description - =============== ======= =========================== - labeler_count Integer Number of labeling persons. - reviewer_count Integer Number of reviewers. - workforce_count Integer Number of teams. - =============== ======= =========================== - -.. _listworkforcetasks__response_workforcesconfig: - -.. table:: **Table 16** WorkforcesConfig - - +------------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Type | Description | - +============+========================================================================================+============================================+ - | agency | String | Administrator. | - +------------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+----------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _listworkforcetasks__response_workforceconfig: - -.. table:: **Table 17** WorkforceConfig - - +----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+======================================================================+=================================================================================================================================+ - | workers | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasks__response_worker: - -.. table:: **Table 18** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Team Labeling Task List of a Dataset - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "count" : 2, - "tasks" : [ { - "dataset_id" : "WxCREuCkBSAlQr9xrde", - "task_id" : "tY330MHxV9dqIPVaTRM", - "task_name" : "task-cd60", - "status" : 1, - "create_time" : 1606224714358, - "update_time" : 1606224714358, - "repetition" : 1, - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "0PfqwXA8M59pppYBx4k", - "workforce_name" : "team-123", - "workers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "6db04ae0afb54d7274a2982255516c29", - "role" : 2 - }, { - "email" : "xxx@xxx.com", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "role" : 0 - } ] - } ] - }, - "synchronize_data" : true, - "synchronize_auto_labeling_data" : true, - "workforce_stats" : { - "workforce_count" : 1, - "labeler_count" : 1, - "reviewer_count" : 0 - }, - "sample_stats" : { - "total_sample_count" : 309, - "unannotated_sample_count" : 308, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 1, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 0, - "auto_annotation_sample_count" : 0 - }, - "auto_check_samples" : true, - "auto_sync_dataset" : true, - "project_id" : "04f924739300d3272fc3c013e36bb4b8", - "task_type" : 1, - "dataset_name" : "dataset-95a6", - "total_sample_count" : 309, - "annotated_sample_count" : 0, - "feature_supports" : [ "0" ], - "label_task_status" : 1, - "sync_labels" : true, - "workforce_task" : true - }, { - "dataset_id" : "WxCREuCkBSAlQr9xrde", - "task_id" : "iYZx7gScPUozOXner9k", - "task_name" : "task-e63f", - "status" : 1, - "create_time" : 1606184400278, - "update_time" : 1606184400278, - "repetition" : 1, - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "q3ZFSwORu1ztKljDLYQ", - "workforce_name" : "modelarts-team", - "workers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", - "role" : 0 - } ] - } ] - }, - "synchronize_data" : false, - "synchronize_auto_labeling_data" : false, - "workforce_stats" : { - "workforce_count" : 1, - "labeler_count" : 1, - "reviewer_count" : 0 - }, - "sample_stats" : { - "total_sample_count" : 317, - "unannotated_sample_count" : 310, - "unreviewed_sample_count" : 0, - "uncheck_sample_count" : 0, - "sampled_sample_count" : 0, - "rejected_sample_count" : 0, - "accepted_sample_count" : 7, - "auto_annotation_sample_count" : 0 - }, - "checking_task_desc" : { - "checking_task_id" : "onSbri2oqYOmDjDyW17", - "action" : 0, - "overwrite_last_result" : false - }, - "auto_check_samples" : true, - "auto_sync_dataset" : true, - "project_id" : "04f924739300d3272fc3c013e36bb4b8", - "task_type" : 1, - "dataset_name" : "dataset-95a6", - "total_sample_count" : 317, - "annotated_sample_count" : 0, - "feature_supports" : [ "0" ], - "label_task_status" : 1, - "sync_labels" : true, - "workforce_task" : true - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/starting_a_team_labeling_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/starting_a_team_labeling_task.rst deleted file mode 100644 index 5160cfbe..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/starting_a_team_labeling_task.rst +++ /dev/null @@ -1,160 +0,0 @@ -.. _StartWorkforceTask: - -Starting a Team Labeling Task -============================= - -Function --------- - -This API is used to start a team labeling task. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-------------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+===============================================================================+======================================================================================================+ - | dataset_id | No | String | Dataset ID. | - +-------------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ - | task_id | No | String | ID of a team labeling task. | - +-------------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ - | workforces_config | No | :ref:`WorkforcesConfig ` object | Team labeling task information: Tasks can be assigned by the team administrator or a specified team. | - +-------------------+-----------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------+ - -.. _startworkforcetask__request_workforcesconfig: - -.. table:: **Table 3** WorkforcesConfig - - +------------+-----------+---------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+=======================================================================================+============================================+ - | agency | No | String | Administrator. | - +------------+-----------+---------------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | No | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+-----------+---------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _startworkforcetask__request_workforceconfig: - -.. table:: **Table 4** WorkforceConfig - - +----------------+-----------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+=====================================================================+=================================================================================================================================+ - | workers | No | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+-----------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +----------------+-----------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | No | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+-----------+---------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _startworkforcetask__request_worker: - -.. table:: **Table 5** Worker - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | create_time | No | Long | Creation time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | No | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - | | | | | - | | | | - **3**: dataset owner | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | | - | | | | - **0**: The invitation email has not been sent. | - | | | | | - | | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | | - | | | | - **2**: The user has logged in. | - | | | | | - | | | | - **3**: The labeling team member has been deleted. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | No | Long | Update time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Starting a Team Labeling Task - -.. code-block:: - - { - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "l4u9Hpz2JJ67DNN1Hg9", - "workers" : [ { - "email" : "xiaozhang@163.com" - }, { - "email" : "xiaoli@163.com" - } ] - } ] - } - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/updating_a_team_labeling_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/updating_a_team_labeling_task.rst deleted file mode 100644 index d00d1ce0..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/updating_a_team_labeling_task.rst +++ /dev/null @@ -1,164 +0,0 @@ -.. _UpdateWorkforceTask: - -Updating a Team Labeling Task -============================= - -Function --------- - -This API is used to update a team labeling task. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id} - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+================================================================================+========================================================================================================================================+ - | dataset_id | No | String | Dataset ID. | - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Team labeling task description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | No | String | ID of a team labeling task. | - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | No | String | Team labeling task name. The value contains 1 to 64 characters and only letters, digits, underscores (_), and hyphens (-) are allowed. | - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | workforces_config | No | :ref:`WorkforcesConfig ` object | Team labeling task information: Tasks can be assigned by the team administrator or a specified team. | - +-------------------+-----------+--------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcetask__request_workforcesconfig: - -.. table:: **Table 3** WorkforcesConfig - - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========================================================================================+============================================+ - | agency | No | String | Administrator. | - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - | workforces | No | Array of :ref:`WorkforceConfig ` objects | List of teams that execute labeling tasks. | - +------------+-----------+----------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _updateworkforcetask__request_workforceconfig: - -.. table:: **Table 4** WorkforceConfig - - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+======================================================================+=================================================================================================================================+ - | workers | No | Array of :ref:`Worker ` objects | List of labeling team members. | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | No | String | Name of a labeling team. The value contains 0 to 1024 characters and does not support the following special characters: !<>=&"' | - +----------------+-----------+----------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcetask__request_worker: - -.. table:: **Table 5** Worker - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | create_time | No | Long | Creation time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | No | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - | | | | | - | | | | - **3**: dataset owner | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | | - | | | | - **0**: The invitation email has not been sent. | - | | | | | - | | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | | - | | | | - **2**: The user has logged in. | - | | | | | - | | | | - **3**: The labeling team member has been deleted. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | No | Long | Update time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | No | String | ID of a labeling team. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Updating a Team Labeling Task - -.. code-block:: - - { - "workforces_config" : { - "workforces" : [ { - "workforce_id" : "3frbQ90hb8ZKksAhyR8", - "workers" : [ { - "email" : "xxx@xxx.com" - }, { - "email" : "xxx@xxx.com" - } ] - } ] - } - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_task_management/updating_the_status_of_a_team_labeling_acceptance_task.rst b/modelarts/api-ref/result/data_management/labeling_task_management/updating_the_status_of_a_team_labeling_acceptance_task.rst deleted file mode 100644 index 28458853..00000000 --- a/modelarts/api-ref/result/data_management/labeling_task_management/updating_the_status_of_a_team_labeling_acceptance_task.rst +++ /dev/null @@ -1,536 +0,0 @@ -.. _UpdateWorkforceSamplingTask: - -Updating the Status of a Team Labeling Acceptance Task -====================================================== - -Function --------- - -This API is used to update the sample status by confirming the acceptance scope and whether the labeled data is overwritten before the acceptance of the team labeling task is completed. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/status - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=======================================+ - | locale | Yes | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-----------------+-----------------+-----------------+---------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 3** Request body parameters - - +-----------------------+-----------------+-----------------+----------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+================================================================+ - | action | No | Integer | Acceptance action. The options are as follows: | - | | | | | - | | | | - **0**: Pass all samples. | - | | | | | - | | | | - **1**: Reject all samples. | - | | | | | - | | | | - **2**: Cancel acceptance. | - | | | | | - | | | | - **3**: View the list of conflicted samples. | - | | | | | - | | | | - **4**: Pass single-accepted samples and unaccepted samples. | - | | | | | - | | | | - **5**: Pass only single-accepted samples. | - +-----------------------+-----------------+-----------------+----------------------------------------------------------------+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-----------------------+-----------------+-----------------+----------------------------------------------------------------+ - | overwrite_last_result | No | Boolean | Whether to overwrite labeled data. The options are as follows: | - | | | | | - | | | | - **true**: Overwrite labeled data. | - | | | | | - | | | | - **false**: Do not overwrite labeled data. (Default value) | - +-----------------------+-----------------+-----------------+----------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +--------------+-------------------------------------------------------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +==============+=======================================================================================================+===================================+ - | sample_count | Integer | Total number of accepted samples. | - +--------------+-------------------------------------------------------------------------------------------------------+-----------------------------------+ - | samples | Array of :ref:`DescribeSampleResp ` objects | List of accepted samples. | - +--------------+-------------------------------------------------------------------------------------------------------+-----------------------------------+ - -.. _updateworkforcesamplingtask__response_describesampleresp: - -.. table:: **Table 5** DescribeSampleResp - - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _updateworkforcesamplingtask__response_worker: - -.. table:: **Table 7** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcesamplingtask__response_samplelabel: - -.. table:: **Table 8** SampleLabel - - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcesamplingtask__response_samplelabelproperty: - -.. table:: **Table 9** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcesamplingtask__response_samplemetadata: - -.. table:: **Table 10** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -All Tasks Are Accepted. - -.. code-block:: - - { - "action" : 0 - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/creating_a_labeling_team.rst b/modelarts/api-ref/result/data_management/labeling_team_management/creating_a_labeling_team.rst deleted file mode 100644 index aa1290ce..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/creating_a_labeling_team.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _CreateWorkforce: - -Creating a Labeling Team -======================== - -Function --------- - -This API is used to create a labeling team. - -URI ---- - -POST /v2/{project_id}/workforces - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+===================================================================================================================================+ - | description | No | String | Labeling team description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | Yes | String | Labeling team name. The value contains 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-). | - +----------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 201** - -.. table:: **Table 3** Response body parameters - - ============ ====== ====================== - Parameter Type Description - ============ ====== ====================== - workforce_id String ID of a labeling team. - ============ ====== ====================== - -Example Requests ----------------- - -Creating a Labeling Team - -.. code-block:: - - { - "workforce_name" : "team-123", - "description" : "my team" - } - -Example Responses ------------------ - -**Status code: 201** - -Created - -.. code-block:: - - { - "workforce_id" : "ZUH8gqkjuaib8pxkDdz" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -201 Created -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/deleting_a_labeling_team.rst b/modelarts/api-ref/result/data_management/labeling_team_management/deleting_a_labeling_team.rst deleted file mode 100644 index 27965c75..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/deleting_a_labeling_team.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _DeleteWorkforce: - -Deleting a Labeling Team -======================== - -Function --------- - -This API is used to delete a labeling team. - -URI ---- - -DELETE /v2/{project_id}/workforces/{workforce_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 204** - -.. table:: **Table 2** Response body parameters - - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=================================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Result of deleting team members in batches. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+---------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _deleteworkforce__response_batchresponse: - -.. table:: **Table 3** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting a Labeling Team - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/workforces/{workforce_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/index.rst b/modelarts/api-ref/result/data_management/labeling_team_management/index.rst deleted file mode 100644 index d7a5aeb2..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _workforce_management: - -======================== -Labeling Team Management -======================== - -.. toctree:: - :maxdepth: 1 - - querying_the_labeling_team_list - creating_a_labeling_team - querying_details_about_a_labeling_team - updating_a_labeling_team - deleting_a_labeling_team diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/querying_details_about_a_labeling_team.rst b/modelarts/api-ref/result/data_management/labeling_team_management/querying_details_about_a_labeling_team.rst deleted file mode 100644 index 6ed6646b..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/querying_details_about_a_labeling_team.rst +++ /dev/null @@ -1,98 +0,0 @@ -.. _DescWorkforce: - -Querying Details About a Labeling Team -====================================== - -Function --------- - -This API is used to query the details about a labeling team. - -URI ---- - -GET /v2/{project_id}/workforces/{workforce_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=================================================================================================================================+ - | create_time | Long | Time when a labeling team is created. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling team is updated. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | worker_count | Integer | Total number of labeling team members. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Labeling Team - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces/{workforce_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "workforce_id" : "gyb7IaAvkLc5IhEY2dv", - "workforce_name" : "team-aed7", - "description" : "", - "worker_count" : 2, - "create_time" : 1575104620882, - "update_time" : 1575104620882 - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/querying_the_labeling_team_list.rst b/modelarts/api-ref/result/data_management/labeling_team_management/querying_the_labeling_team_list.rst deleted file mode 100644 index c5aa0bbf..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/querying_the_labeling_team_list.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. _ListWorkforces: - -Querying the Labeling Team List -=============================== - -Function --------- - -This API is used to query the labeling team list. - -URI ---- - -GET /v2/{project_id}/workforces - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+===============================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Fuzzy search keyword. By default, this parameter is left blank. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **workforce_name**: Sort by labeling team name. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | No | String | ID of a team labeling task. | - +-------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+------------------------------------------------------------------------+-------------------------------------+ - | Parameter | Type | Description | - +==============+========================================================================+=====================================+ - | total_number | Integer | Total number of labeling teams. | - +--------------+------------------------------------------------------------------------+-------------------------------------+ - | workforces | Array of :ref:`Workforce ` objects | Labeling team list queried by page. | - +--------------+------------------------------------------------------------------------+-------------------------------------+ - -.. _listworkforces__response_workforce: - -.. table:: **Table 4** Workforce - - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=================================================================================================================================+ - | create_time | Long | Time when a labeling team is created. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Time when a labeling team is updated. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | worker_count | Integer | Total number of labeling team members. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | String | Name of a labeling team. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Labeling Team List - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_number" : 2, - "workforces" : [ { - "workforce_id" : "ZUH8gqkjuaib8pxkDdz", - "workforce_name" : "team-123", - "description" : "my team", - "worker_count" : 0, - "create_time" : 1606354772548, - "update_time" : 1606354772548 - }, { - "workforce_id" : "3Ry04NsqvEybuWYLDvC", - "workforce_name" : "team-170a", - "description" : "", - "worker_count" : 1, - "create_time" : 1604644946891, - "update_time" : 1606238678626 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_management/updating_a_labeling_team.rst b/modelarts/api-ref/result/data_management/labeling_team_management/updating_a_labeling_team.rst deleted file mode 100644 index c89717fb..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_management/updating_a_labeling_team.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _UpdateWorkforce: - -Updating a Labeling Team -======================== - -Function --------- - -This API is used to update a labeling team. - -URI ---- - -PUT /v2/{project_id}/workforces/{workforce_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+========+========================================================================================================================================+ - | description | No | String | Labeling team description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_name | No | String | Name of a labeling team. The value contains 1 to 64 characters and only letters, digits, hyphens (-), and underscores (_) are allowed. | - +----------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Updating a Labeling Team - -.. code-block:: - - { - "description" : "my team" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/creating_a_labeling_team_member.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/creating_a_labeling_team_member.rst deleted file mode 100644 index b871d1fa..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/creating_a_labeling_team_member.rst +++ /dev/null @@ -1,91 +0,0 @@ -.. _CreateWorker: - -Creating a Labeling Team Member -=============================== - -Function --------- - -This API is used to create a labeling team member. - -URI ---- - -POST /v2/{project_id}/workforces/{workforce_id}/workers - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================================================+ - | description | No | String | Member description. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ - | emails | Yes | String | Email address of a labeling team member. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ - | role | Yes | Integer | Member role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Creating a Labeling Team Member - -.. code-block:: - - { - "emails" : "xxx@xxx.com", - "description" : "", - "role" : "2" - } - -Example Responses ------------------ - -**Status code: 201** - -Created - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -201 Created -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_a_labeling_team_member.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_a_labeling_team_member.rst deleted file mode 100644 index debdbef8..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_a_labeling_team_member.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _DeleteWorker: - -Deleting a Labeling Team Member -=============================== - -Function --------- - -This API is used to delete a labeling team member. - -URI ---- - -DELETE /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | worker_id | Yes | String | ID of a labeling team member. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Labeling Team Member - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_labeling_team_members_in_batches.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_labeling_team_members_in_batches.rst deleted file mode 100644 index 064750ad..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/deleting_labeling_team_members_in_batches.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _DeleteWorkers: - -Deleting Labeling Team Members in Batches -========================================= - -Function --------- - -This API is used to delete labeling team members in batches. - -URI ---- - -POST /v2/{project_id}/workforces/{workforce_id}/workers/batch-delete - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - ========= ========= ================ ==================== - Parameter Mandatory Type Description - ========= ========= ================ ==================== - workers No Array of strings Team member ID list. - ========= ========= ================ ==================== - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Result of deleting team members in batches. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _deleteworkers__response_batchresponse: - -.. table:: **Table 4** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting Labeling Team Members in Batches - -.. code-block:: - - { - "workers" : [ "89d4ae38431b8905449821605abdc3a9", "a2abd3f27b4e92c593c15282f8b6bd29" ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true, - "results" : [ { - "success" : true - }, { - "success" : true - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/index.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/index.rst deleted file mode 100644 index 8467dfdb..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _workforce_worker_management: - -=============================== -Labeling Team Member Management -=============================== - -.. toctree:: - :maxdepth: 1 - - sending_an_email_to_a_labeling_team_member - querying_the_list_of_all_labeling_team_members - querying_the_list_of_labeling_team_members - creating_a_labeling_team_member - deleting_labeling_team_members_in_batches - querying_details_about_labeling_team_members - updating_a_labeling_team_member - deleting_a_labeling_team_member diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_details_about_labeling_team_members.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_details_about_labeling_team_members.rst deleted file mode 100644 index 3a94c395..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_details_about_labeling_team_members.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _DescWorker: - -Querying Details About Labeling Team Members -============================================ - -Function --------- - -This API is used to query details about labeling team members. - -URI ---- - -GET /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | worker_id | Yes | String | ID of a labeling team member. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About Labeling Team Members - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "email" : "xxx@xxx.com", - "worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2", - "workforce_id" : "gyb7IaAvkLc5IhEY2dv", - "status" : 0, - "role" : 2, - "description" : "", - "create_time" : 1606356324223, - "update_time" : 1606356324223 - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_all_labeling_team_members.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_all_labeling_team_members.rst deleted file mode 100644 index 1398c4e4..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_all_labeling_team_members.rst +++ /dev/null @@ -1,170 +0,0 @@ -.. _ListAllWorkers: - -Querying the List of All Labeling Team Members -============================================== - -Function --------- - -This API is used to query the list of all labeling team members. - -URI ---- - -GET /v2/{project_id}/workforces/workers - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Filtering query based on the member role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel (default value) | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **email**: Sort by email. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+------------------------------------------------------------------+---------------------------------------------+ - | Parameter | Type | Description | - +==============+==================================================================+=============================================+ - | total_number | Integer | Total number of labeling team members. | - +--------------+------------------------------------------------------------------+---------------------------------------------+ - | workers | Array of :ref:`Worker ` objects | Labeling team members list queried by page. | - +--------------+------------------------------------------------------------------+---------------------------------------------+ - -.. _listallworkers__response_worker: - -.. table:: **Table 4** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying All Labeling Team Administrators - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces/workers??role=2 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_number" : 2, - "workers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "df40e4afcb793d13f01f6c9022341e6f", - "workforce_id" : "feSUo5NUIUnQAQNNTiS", - "status" : 0, - "role" : 2, - "description" : "", - "create_time" : 1595927749772, - "update_time" : 1595927749772 - }, { - "email" : "xxx@xxx.com", - "worker_id" : "27906df1d06c0827b7c24f761d618541", - "workforce_id" : "XiL5RcHmxyIt3aYIOtI", - "status" : 0, - "role" : 2, - "description" : "", - "create_time" : 1590027298717, - "update_time" : 1590027298717 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_labeling_team_members.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_labeling_team_members.rst deleted file mode 100644 index 218bada6..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/querying_the_list_of_labeling_team_members.rst +++ /dev/null @@ -1,173 +0,0 @@ -.. _ListWorkers: - -Querying the List of Labeling Team Members -========================================== - -Function --------- - -This API is used to query the list of labeling team members. - -URI ---- - -GET /v2/{project_id}/workforces/{workforce_id}/workers - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===============================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **email**: Sort by email. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+---------------------------------------------------------------+---------------------------------------------+ - | Parameter | Type | Description | - +==============+===============================================================+=============================================+ - | total_number | Integer | Total number of labeling team members. | - +--------------+---------------------------------------------------------------+---------------------------------------------+ - | workers | Array of :ref:`Worker ` objects | Labeling team members list queried by page. | - +--------------+---------------------------------------------------------------+---------------------------------------------+ - -.. _listworkers__response_worker: - -.. table:: **Table 4** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the List of Labeling Team Members - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/workforces/{workforce_id}/workers - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_number" : 3, - "workers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "b1e4054407ecb36a7bcde70f52ba37f2", - "workforce_id" : "gyb7IaAvkLc5IhEY2dv", - "status" : 0, - "role" : 2, - "description" : "", - "create_time" : 1606356324223, - "update_time" : 1606356324223 - }, { - "email" : "xxx@xxx.com", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "workforce_id" : "gyb7IaAvkLc5IhEY2dv", - "status" : 0, - "role" : 0, - "description" : "", - "create_time" : 1591783804629, - "update_time" : 1591783804629 - }, { - "email" : "xxx@xxx.com", - "worker_id" : "2880f38d660dd68ca6ab578b5a1d9558", - "workforce_id" : "gyb7IaAvkLc5IhEY2dv", - "status" : 0, - "role" : 0, - "description" : "", - "create_time" : 1575104629439, - "update_time" : 1575104629439 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/sending_an_email_to_a_labeling_team_member.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/sending_an_email_to_a_labeling_team_member.rst deleted file mode 100644 index bc5d3f3a..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/sending_an_email_to_a_labeling_team_member.rst +++ /dev/null @@ -1,119 +0,0 @@ -.. _SendEmails: - -Sending an Email to a Labeling Team Member -========================================== - -Function --------- - -This API is used to send an email to a labeling team member. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/notify - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+------------------+---------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==================+=======================================+ - | emails | Yes | Array of strings | Email list of a labeling team member. | - +-----------+-----------+------------------+---------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Result of sending an email to a labeling team member. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+----------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _sendemails__response_batchresponse: - -.. table:: **Table 4** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Sending an Email to a Labeling Team Member - -.. code-block:: - - { - "emails" : [ "xxx@xxx.com", "xxx@xxx.com" ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/labeling_team_member_management/updating_a_labeling_team_member.rst b/modelarts/api-ref/result/data_management/labeling_team_member_management/updating_a_labeling_team_member.rst deleted file mode 100644 index d346e546..00000000 --- a/modelarts/api-ref/result/data_management/labeling_team_member_management/updating_a_labeling_team_member.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _UpdateWorker: - -Updating a Labeling Team Member -=============================== - -Function --------- - -This API is used to update a labeling team member. - -URI ---- - -PUT /v2/{project_id}/workforces/{workforce_id}/workers/{worker_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | worker_id | Yes | String | ID of a labeling team member. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_id | Yes | String | ID of a labeling team. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | description | No | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | No | Integer | Role. The options are as follows: | - | | | | | - | | | | - **0**: labeling personnel | - | | | | | - | | | | - **1**: reviewer | - | | | | | - | | | | - **2**: team administrator | - | | | | | - | | | | - **3**: dataset owner | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Updating a Labeling Team Member - -.. code-block:: - - { - "description" : "My name is Tom", - "role" : 2 - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/manual_labeling/index.rst b/modelarts/api-ref/result/data_management/manual_labeling/index.rst deleted file mode 100644 index 93aa2909..00000000 --- a/modelarts/api-ref/result/data_management/manual_labeling/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _manual_annotation_management: - -=============== -Manual Labeling -=============== - -.. toctree:: - :maxdepth: 1 - - updating_sample_labels_in_batches diff --git a/modelarts/api-ref/result/data_management/manual_labeling/updating_sample_labels_in_batches.rst b/modelarts/api-ref/result/data_management/manual_labeling/updating_sample_labels_in_batches.rst deleted file mode 100644 index 654f45a2..00000000 --- a/modelarts/api-ref/result/data_management/manual_labeling/updating_sample_labels_in_batches.rst +++ /dev/null @@ -1,429 +0,0 @@ -.. _UpdateSamples: - -Updating Sample Labels in Batches -================================= - -Function --------- - -This API is used to update sample labels in batches, including adding, modifying, and deleting sample labels. If the parameter **Labels** of a sample in the request body is not specified, the label of the sample is deleted. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+----------------------------------------------------------------------------+------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+============================================================================+==========================================+ - | email | No | String | Email address of a labeling team member. | - +-----------+-----------+----------------------------------------------------------------------------+------------------------------------------+ - | samples | No | Array of :ref:`SampleLabels ` objects | Updated sample list. | - +-----------+-----------+----------------------------------------------------------------------------+------------------------------------------+ - -.. _updatesamples__request_samplelabels: - -.. table:: **Table 3** SampleLabels - - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==========================================================================+====================================================================================+ - | labels | No | Array of :ref:`SampleLabel ` objects | Sample label list. If this parameter is left blank, all sample labels are deleted. | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_id | No | String | Sample ID. | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_type | No | Integer | Sample type. The options are as follows: | - | | | | | - | | | | - **0**: image | - | | | | | - | | | | - **1**: text | - | | | | | - | | | | - **2**: speech | - | | | | | - | | | | - **4**: table | - | | | | | - | | | | - **6**: video | - | | | | | - | | | | - **9**: custom format | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_usage | No | String | Sample usage. The options are as follows: | - | | | | | - | | | | - **TRAIN**: training | - | | | | | - | | | | - **EVAL**: evaluation | - | | | | | - | | | | - **TEST**: test | - | | | | | - | | | | - **INFERENCE**: inference | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | source | No | String | Source address of sample data. | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+--------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - -.. _updatesamples__request_samplelabel: - -.. table:: **Table 4** SampleLabel - - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+================================================================================+=======================================================================================================================================+ - | annotated_by | No | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | | - | | | | - **human**: manual labeling | - | | | | | - | | | | - **auto**: automatic labeling | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Label ID. | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | Float | Confidence. | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+--------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updatesamples__request_samplelabelproperty: - -.. table:: **Table 5** SampleLabelProperty - - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | No | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | No | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | | - | | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | | - | | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | No | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | No | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | | - | | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | | - | | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | | - | | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | | - | | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | | - | | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | No | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | No | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | | - | | | | - **0/false**: not a hard example | - | | | | | - | | | | - **1/true**: hard example | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | No | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | No | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | No | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | No | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | No | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updatesamples__request_samplemetadata: - -.. table:: **Table 6** SampleMetadata - - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+===================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | No | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | No | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response list for updating sample labels in batches. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------+ - -.. _updatesamples__response_batchresponse: - -.. table:: **Table 8** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Updating Sample Labels in Batches - -.. code-block:: - - { - "samples" : [ { - "sample_id" : "8b583c44bf249f8ba43ea42c92920221", - "labels" : [ { - "name" : "yunbao" - } ] - }, { - "sample_id" : "b5fe3039879660a2e6bf18166e247f68", - "labels" : [ { - "name" : "yunbao" - } ] - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/creating_a_data_processing_task_version.rst b/modelarts/api-ref/result/data_management/processing_task/creating_a_data_processing_task_version.rst deleted file mode 100644 index ea222c1e..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/creating_a_data_processing_task_version.rst +++ /dev/null @@ -1,241 +0,0 @@ -.. _CreateProcessorTaskVersion: - -Creating a Data Processing Task Version -======================================= - -Function --------- - -This API is used to create a data processing task version. - -URI ---- - -POST /v2/{project_id}/processor-tasks/{task_id}/versions - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================================================+=====================================================================================================================================================+ - | create_version | No | Boolean | Whether to synchronously create a task version when creating a task. The options are as follows: | - | | | | | - | | | | - **true**: Create a task version when creating a task. | - | | | | | - | | | | - **false**: Do not create a task version when creating a task. (Default value) | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | No | :ref:`ProcessorDataSource ` object | Data source. Either this parameter or **inputs** is delivered. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of a data processing task. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | inputs | No | Array of :ref:`ProcessorDataSource ` objects | Data source list. Either this parameter or **data_source** is delivered. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Name of a data processing task. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | template | No | :ref:`TemplateParam ` object | Data processing template, such as the algorithm ID and parameters. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Dataset version ID. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | No | :ref:`WorkPath ` object | Working directory of a data processing task. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortaskversion__request_processordatasource: - -.. table:: **Table 3** ProcessorDataSource - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================================================================================================================+ - | name | No | String | Dataset name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | Data source path. The options are as follows: | - | | | | | - | | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | | - | | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | | - | | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | | - | | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Data source type. The options are as follows: | - | | | | | - | | | | - **OBS**: Data obtained from OBS | - | | | | | - | | | | - **TASK**: Data processing task | - | | | | | - | | | | - **DATASET**: Dataset | - | | | | | - | | | | - **CUSTOM**: Data called by resource tenants | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Version of a dataset. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | Dataset version name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortaskversion__request_templateparam: - -.. table:: **Table 4** TemplateParam - - +-----------------+-----------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================================================================================+===================================================================================+ - | id | No | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | | - | | | | - **sys_data_analyse**: feature analysis | - | | | | | - | | | | - **sys_data_cleaning**: data cleansing | - | | | | | - | | | | - **sys_data_augmentation**: data augmentation | - | | | | | - | | | | - **sys_data_validation**: data validation | - | | | | | - | | | | - **sys_data_selection**: data selection | - +-----------------+-----------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | No | String | Template name. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | No | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------+-----------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _createprocessortaskversion__request_operatorparam: - -.. table:: **Table 5** OperatorParam - - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | No | Boolean | Advanced parameter switch. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | ID of an operator. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name of an operator. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | No | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortaskversion__request_workpath: - -.. table:: **Table 6** WorkPath - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | name | No | String | Dataset name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | No | String | Output path. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | No | String | Working path. The options are as follows: | - | | | | | - | | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | | - | | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Type of a working path. The options are as follows: | - | | | | | - | | | | - **OBS**: OBS path | - | | | | | - | | | | - **DATASET**: dataset | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Version of a dataset. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - ========== ====== ===================================== - Parameter Type Description - ========== ====== ===================================== - version_id String Version ID of a data processing task. - ========== ====== ===================================== - -Example Requests ----------------- - -Creating a Data Validation Task Version - -.. code-block:: - - { - "name" : "PRE-e77c", - "inputs" : [ { - "type" : "DATASET", - "source" : "PYc9H2HGv5BJNwBGXyK", - "version_id" : "Osc8SZ7TZStiRV4vYkZ" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "PYc9H2HGv5BJNwBGXyK", - "version_name" : "V0011" - }, - "description" : "", - "template" : { - "id" : "sys_data_validation", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "1920", - "image_max_height" : "1920", - "total_status" : "[0,1,2]" - } - } ] - }, - "workspace_id" : "0" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "version_id" : "qSaudx2sbPvthHygckA" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/creating_a_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/creating_a_processing_task.rst deleted file mode 100644 index e40e7c4d..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/creating_a_processing_task.rst +++ /dev/null @@ -1,370 +0,0 @@ -.. _CreateProcessorTask: - -Creating a Processing Task -========================== - -Function --------- - -This API is used to create a processing task. You can create feature analysis tasks and data processing tasks. You can specify the **id** field of **template** composite parameter in the request body to create a task. - -- Feature analysis refers to the process of analyzing the features of an image based on the image or target box, such as the blurring degree and brightness, and drawing a visualized curve to help process the dataset. - -- Data processing refers to extracting or generating data that is valuable and meaningful to a particular person from a large amount of, cluttered, and incomprehensible data. Data processing includes data validation, data cleansing, data selection, and data augmentation. - -- Data validation indicates that the dataset is verified to ensure data accuracy. - -- Data cleansing refers to the process of denoising, correcting, or supplementing data. - -- Data selection indicates the process of selecting data subsets from full data. - -- Data augmentation indicates that data volume is increased through simple data amplification operations such as scaling, cropping, transformation, and composition. - -URI ---- - -POST /v2/{project_id}/processor-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+================================================================================================+========================================================================================================================================================================================================================================================+ - | create_version | No | Boolean | Whether to synchronously create a task version when creating a task. Set this parameter to **true** only when creating a data processing task. For other types of tasks, this parameter is set to **false** or left blank. The options are as follows: | - | | | | | - | | | | - **true**: Create a task version when creating a task. | - | | | | | - | | | | - **false**: Do not create a task version when creating a task. (Default value) | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | No | :ref:`ProcessorDataSource ` object | Data source. Either this parameter or **inputs** is used. A data source path cannot be an OBS path in a KMS-encrypted bucket. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description of a data processing task. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inputs | No | Array of :ref:`ProcessorDataSource ` objects | Data sources. Either this parameter or **data_source** is used. A data source path cannot be an OBS path in a KMS-encrypted bucket. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes | String | Name of a data processing task. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template | No | :ref:`TemplateParam ` object | Data processing template, such as the algorithm ID and parameters. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Dataset version ID. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | No | :ref:`WorkPath ` object | Work directory of a data processing task. A work directory cannot be an OBS path in a KMS-encrypted bucket. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------+-----------------+------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortask__request_processordatasource: - -.. table:: **Table 3** ProcessorDataSource - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================================================================================================================+ - | name | No | String | Dataset name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | Data source path. The options are as follows: | - | | | | | - | | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | | - | | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | | - | | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | | - | | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Data source type. The options are as follows: | - | | | | | - | | | | - **OBS**: Data obtained from OBS | - | | | | | - | | | | - **TASK**: Data processing task | - | | | | | - | | | | - **DATASET**: Dataset | - | | | | | - | | | | - **CUSTOM**: Data called by resource tenants | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Version of a dataset. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | Dataset version name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortask__request_templateparam: - -.. table:: **Table 4** TemplateParam - - +-----------------+-----------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+====================================================================================+===================================================================================+ - | id | No | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | | - | | | | - **sys_data_analyse**: feature analysis | - | | | | | - | | | | - **sys_data_cleaning**: data cleansing | - | | | | | - | | | | - **sys_data_augmentation**: data augmentation | - | | | | | - | | | | - **sys_data_validation**: data validation | - | | | | | - | | | | - **sys_data_selection**: data selection | - +-----------------+-----------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | No | String | Template name. | - +-----------------+-----------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | No | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------+-----------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _createprocessortask__request_operatorparam: - -.. table:: **Table 5** OperatorParam - - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +========================+===========+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | No | Boolean | Advanced parameter switch. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | ID of an operator. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name of an operator. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | No | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+-----------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createprocessortask__request_workpath: - -.. table:: **Table 6** WorkPath - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | name | No | String | Dataset name. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | No | String | Output path. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | No | String | Working path. The options are as follows: | - | | | | | - | | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | | - | | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Type of a working path. The options are as follows: | - | | | | | - | | | | - **OBS**: OBS path | - | | | | | - | | | | - **DATASET**: dataset | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Version of a dataset. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | No | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - ========= ====== ============================= - Parameter Type Description - ========= ====== ============================= - task_id String ID of a data processing task. - ========= ====== ============================= - -Example Requests ----------------- - -- Creating a Data Processing (Data Validation) Task - - .. code-block:: - - { - "name" : "PRE-e77c", - "inputs" : [ { - "type" : "DATASET", - "source" : "PYc9H2HGv5BJNwBGXyK", - "version_id" : "yoJ5ssClpNlOrsjjFDa" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "PYc9H2HGv5BJNwBGXyK", - "version_name" : "V0010" - }, - "description" : "", - "create_version" : true, - "template" : { - "id" : "sys_data_validation", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "1920", - "image_max_height" : "1920", - "total_status" : "[0,1,2]" - } - } ] - }, - "workspace_id" : "0" - } - -- Creating a Data Processing (Data Cleansing) Task - - .. code-block:: - - { - "name" : "PRE-330f", - "inputs" : [ { - "type" : "DATASET", - "source" : "gfghHSokody6AJigS5A", - "version_id" : "54IXbeJhfttGpL46lbv" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "gfghHSokody6AJigS5A", - "version_name" : "V004" - }, - "description" : "", - "create_version" : true, - "template" : { - "id" : "sys_data_cleaning", - "operator_params" : [ { - "name" : "PCC", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_cleaning_select", - "prototype_sample_path" : "obs://test-obs/classify/data/cat-dog/", - "criticism_sample_path" : "", - "n_clusters" : "auto", - "simlarity_threshold" : "0.9", - "embedding_distance" : "0.2", - "checkpoint_path" : "/home/work/user-job-dir/test-lxm/resnet_v1_50", - "total_status" : "[0,2]", - "do_validation" : "True" - } - } ] - }, - "workspace_id" : "0" - } - -- Creating a Data Processing (Data Selection) Task - - .. code-block:: - - { - "name" : "PRE-aae5", - "inputs" : [ { - "type" : "DATASET", - "source" : "gLNSdlQ1iAAmPgl0Won", - "version_id" : "WAVPSYpKE3FggbgRxiK" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "gLNSdlQ1iAAmPgl0Won", - "version_name" : "V003" - }, - "description" : "", - "create_version" : true, - "template" : { - "id" : "sys_data_selection", - "operator_params" : [ { - "name" : "SimDeduplication", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_deduplication_select", - "simlarity_threshold" : "0.9", - "total_status" : "[0,2]", - "do_validation" : "True" - } - } ] - }, - "workspace_id" : "0" - } - -- Creating a Data Processing (Data Augmentation) Task - - .. code-block:: - - { - "name" : "PRE-637c", - "inputs" : [ { - "type" : "DATASET", - "source" : "XGrRZuCV1qmMxnsmD5u", - "version_id" : "kjPDTOSi6BQqhtXZlFv" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "XGrRZuCV1qmMxnsmD5u", - "version_name" : "V002" - }, - "description" : "", - "create_version" : true, - "template" : { - "id" : "sys_data_augmentation", - "operator_params" : [ { - "name" : "AddNoise", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "AddNoise" : "1", - "noise_type" : "Gauss", - "loc" : "0", - "scale" : "1", - "lam" : "2", - "p" : "0.01", - "total_status" : "[3]", - "filter_func" : "data_augmentation", - "do_validation" : "True" - } - } ] - }, - "workspace_id" : "0" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "SNEJua7qdZZN8GvkcEr" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/deleting_a_data_processing_task_version.rst b/modelarts/api-ref/result/data_management/processing_task/deleting_a_data_processing_task_version.rst deleted file mode 100644 index b2c94a97..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/deleting_a_data_processing_task_version.rst +++ /dev/null @@ -1,72 +0,0 @@ -.. _DeleteProcessorTaskVersion: - -Deleting a Data Processing Task Version -======================================= - -Function --------- - -This API is used to delete a data processing task version. - -URI ---- - -DELETE /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Version ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Data Processing Task Version - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} - -Example Responses ------------------ - -**Status code: 204** - -No Content - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -204 No Content -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/deleting_a_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/deleting_a_processing_task.rst deleted file mode 100644 index 19ff812b..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/deleting_a_processing_task.rst +++ /dev/null @@ -1,70 +0,0 @@ -.. _DeleteProcessorTask: - -Deleting a Processing Task -========================== - -Function --------- - -This API is used to delete a processing task. You can delete feature analysis tasks and data processing tasks. A specific task can be deleted by specifying the **task_id** path parameter. - -URI ---- - -DELETE /v2/{project_id}/processor-tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Deleting a Data Processing Task - -.. code-block:: - - DELETE https://{endpoint}/v2/{project_id}/processor-tasks/{task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/index.rst b/modelarts/api-ref/result/data_management/processing_task/index.rst deleted file mode 100644 index a95d4895..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _process_task: - -=============== -Processing Task -=============== - -.. toctree:: - :maxdepth: 1 - - querying_the_list_of_a_processing_task - creating_a_processing_task - querying_the_algorithm_type_for_data_processing - querying_details_about_a_processing_task - updating_a_processing_task - deleting_a_processing_task - querying_the_version_list_of_a_data_processing_task - creating_a_data_processing_task_version - querying_the_details_about_the_version_of_a_data_processing_task - deleting_a_data_processing_task_version - querying_the_result_of_a_data_processing_task_version - stopping_the_version_of_a_data_processing_task diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_details_about_a_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/querying_details_about_a_processing_task.rst deleted file mode 100644 index 9dbf4746..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_details_about_a_processing_task.rst +++ /dev/null @@ -1,264 +0,0 @@ -.. _DescribeProcessorTask: - -Querying Details About a Processing Task -======================================== - -Function --------- - -This API is used to query the details about processing tasks. You can query feature analysis tasks and data processing tasks. You can specify the **task_id** parameter to query the details about a specific task. - -URI ---- - -GET /v2/{project_id}/processor-tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===================================================================================================+===========================================================================================================================================================+ - | create_time | Long | Time when a data processing task is created. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | :ref:`ProcessorDataSource ` object | Input of a data processing task. Either this parameter or **inputs** is delivered. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration_seconds | Integer | Running time of data processing, in seconds. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Error message. This field is displayed when the value of status is **3**. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inputs | Array of :ref:`ProcessorDataSource ` objects | Input channel list of a data processing task. Either this parameter or **data_source** is delivered. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current task is the latest of the same type of this version. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result | Object | Output result of a data processing task. This field is displayed when status is set to **2** and is valid for a feature analysis task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a data processing task. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | ID of a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template | :ref:`TemplateParam ` object | Data processing template, such as the algorithm ID and parameters. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_count | Integer | Version number of a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID corresponding to a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name corresponding to a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | :ref:`WorkPath ` object | Working directory of a data processing task. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID of a data processing task. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------------+---------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeprocessortask__response_processordatasource: - -.. table:: **Table 3** ProcessorDataSource - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Data source path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | - | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Data source type. The options are as follows: | - | | | | - | | | - **OBS**: Data obtained from OBS | - | | | | - | | | - **TASK**: Data processing task | - | | | | - | | | - **DATASET**: Dataset | - | | | | - | | | - **CUSTOM**: Data called by resource tenants | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeprocessortask__response_templateparam: - -.. table:: **Table 4** TemplateParam - - +-----------------------+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================================================================================+===================================================================================+ - | id | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | - | | | - **sys_data_analyse**: feature analysis | - | | | | - | | | - **sys_data_cleaning**: data cleansing | - | | | | - | | | - **sys_data_augmentation**: data augmentation | - | | | | - | | | - **sys_data_validation**: data validation | - | | | | - | | | - **sys_data_selection**: data selection | - +-----------------------+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | String | Template name. | - +-----------------------+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------------+---------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _describeprocessortask__response_operatorparam: - -.. table:: **Table 5** OperatorParam - - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | Boolean | Advanced parameter switch. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | ID of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeprocessortask__response_workpath: - -.. table:: **Table 6** WorkPath - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | String | Output path. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | String | Working path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a working path. The options are as follows: | - | | | | - | | | - **OBS**: OBS path | - | | | | - | | | - **DATASET**: dataset | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Data Processing Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks/{task_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "SSzH9AdmHTvIBeihArb", - "name" : "PRE-6c83", - "description" : "test", - "inputs" : [ { - "type" : "DATASET", - "source" : "qjHAs14pRu4n2so1Qlb", - "version_id" : "cUELhTAYGIR36YpTE5Y", - "name" : "dataset-dba1", - "version_name" : "V001" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "qjHAs14pRu4n2so1Qlb", - "name" : "dataset-dba1", - "version_name" : "V002", - "output_path" : "/test-lxm/data-out/EnyHCFzjTFY20U3sYSE/" - }, - "template" : { - "id" : "sys_data_validation", - "name" : "data validation template name", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "-1", - "image_max_height" : "-1", - "total_status" : "[0,1,2]" - } - } ] - }, - "status" : 2, - "duration_seconds" : 277, - "create_time" : 1614245065569, - "workspace_id" : "0", - "version_count" : 1, - "ai_project" : "" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_the_algorithm_type_for_data_processing.rst b/modelarts/api-ref/result/data_management/processing_task/querying_the_algorithm_type_for_data_processing.rst deleted file mode 100644 index 742db063..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_the_algorithm_type_for_data_processing.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _GetProcessorTaskItems: - -Querying the Algorithm Type for Data Processing -=============================================== - -Function --------- - -This API is used to query the algorithm type for data processing. - -URI ---- - -GET /v2/{project_id}/processor-tasks/items - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------+-----------------------------------------------------------------------------------------------+----------------------+ - | Parameter | Type | Description | - +===========+===============================================================================================+======================+ - | items | Array of :ref:`ProcessorTaskItem ` objects | Algorithm type list. | - +-----------+-----------------------------------------------------------------------------------------------+----------------------+ - | total | Integer | Total number. | - +-----------+-----------------------------------------------------------------------------------------------+----------------------+ - -.. _getprocessortaskitems__response_processortaskitem: - -.. table:: **Table 3** ProcessorTaskItem - - =========== ====== ================================== - Parameter Type Description - =========== ====== ================================== - label_en String English name of an algorithm type. - label_zh String Chinese name of an algorithm type. - template_id String Algorithm type ID. - =========== ====== ================================== - -Example Requests ----------------- - -Querying the List of the Algorithm Type for Data Processing - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks/items - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total" : 4, - "items" : [ { - "template_id" : "sys_data_cleaning", - "label_zh" : "label_zh to translate", - "label_en" : "data cleaning" - }, { - "template_id" : "sys_data_validation", - "label_zh" : "label_zh to translate", - "label_en" : "data validation" - }, { - "template_id" : "sys_data_selection", - "label_zh" : "label_zh to translate", - "label_en" : "data selection" - }, { - "template_id" : "sys_data_augmentation", - "label_zh" : "label_zh to translate", - "label_en" : "data augmentation" - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_the_details_about_the_version_of_a_data_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/querying_the_details_about_the_version_of_a_data_processing_task.rst deleted file mode 100644 index cb5e1922..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_the_details_about_the_version_of_a_data_processing_task.rst +++ /dev/null @@ -1,262 +0,0 @@ -.. _DescProcessorTaskVersion: - -Querying the Details About the Version of a Data Processing Task -================================================================ - -Function --------- - -This API is used to query the details about the version of a data processing task. - -URI ---- - -GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Version ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+======================================================================================================+===============================================================+ - | add_sample_count | Integer | Number of added images after processing. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | create_time | Long | Time when a data processing task is created. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted images after processing. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | description | String | Version description of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | duration_seconds | Integer | Running time of a data processing task, in seconds. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | inputs | Array of :ref:`ProcessorDataSource ` objects | Input channel of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified images after processing. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | origin_sample_count | Integer | Number of images before processing. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | status | Integer | Status of a data processing task. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | task_id | String | ID of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | task_version_id | String | Version ID of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | template | :ref:`TemplateParam ` object | Algorithm template, such as the algorithm ID and parameters. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | unmodified_sample_count | Integer | Number of unmodified images after processing. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | update_time | Long | Time when a data processing task is created. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | version_name | String | Version name of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | work_path | :ref:`WorkPath ` object | Output channel of a data processing task. | - +-------------------------+------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -.. _descprocessortaskversion__response_processordatasource: - -.. table:: **Table 3** ProcessorDataSource - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Data source path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | - | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Data source type. The options are as follows: | - | | | | - | | | - **OBS**: Data obtained from OBS | - | | | | - | | | - **TASK**: Data processing task | - | | | | - | | | - **DATASET**: Dataset | - | | | | - | | | - **CUSTOM**: Data called by resource tenants | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descprocessortaskversion__response_templateparam: - -.. table:: **Table 4** TemplateParam - - +-----------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==========================================================================================+===================================================================================+ - | id | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | - | | | - **sys_data_analyse**: feature analysis | - | | | | - | | | - **sys_data_cleaning**: data cleansing | - | | | | - | | | - **sys_data_augmentation**: data augmentation | - | | | | - | | | - **sys_data_validation**: data validation | - | | | | - | | | - **sys_data_selection**: data selection | - +-----------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | String | Template name. | - +-----------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------------+------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _descprocessortaskversion__response_operatorparam: - -.. table:: **Table 5** OperatorParam - - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | Boolean | Advanced parameter switch. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | ID of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _descprocessortaskversion__response_workpath: - -.. table:: **Table 6** WorkPath - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | String | Output path. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | String | Working path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a working path. The options are as follows: | - | | | | - | | | - **OBS**: OBS path | - | | | | - | | | - **DATASET**: dataset | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Data Processing Task Version - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions/{version_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_version_id" : "qSaudx2sbPvthHygckA", - "task_id" : "kM7j9TSa611ZzBThzSr", - "version_name" : "V002", - "description" : "", - "status" : 0, - "create_time" : 1606377874450, - "inputs" : [ { - "type" : "DATASET", - "source" : "PYc9H2HGv5BJNwBGXyK", - "version_id" : "Osc8SZ7TZStiRV4vYkZ", - "name" : "dataset-test", - "version_name" : "V0010" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "PYc9H2HGv5BJNwBGXyK", - "name" : "dataset-test", - "version_name" : "V0011", - "output_path" : "/test-obs/classify/output/qSaudx2sbPvthHygckA/" - }, - "template" : { - "id" : "sys_data_validation", - "name" : "name to translate", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "1920", - "image_max_height" : "1920", - "total_status" : "[0,1,2]" - } - } ] - }, - "duration_seconds" : 312 - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_the_list_of_a_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/querying_the_list_of_a_processing_task.rst deleted file mode 100644 index f4984bb3..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_the_list_of_a_processing_task.rst +++ /dev/null @@ -1,372 +0,0 @@ -.. _ListProcessorTasks: - -Querying the List of a Processing Task -====================================== - -Function --------- - -This API is used to query the list of a processing task. You can query the feature analysis tasks and data processing tasks. You can specify the **task_type** parameter to query the list of a specific type of tasks. - -- Feature analysis refers to the process of analyzing the features of an image based on the image or target box, such as the blurring degree and brightness, and drawing a visualized curve to help process the dataset. - -- Data processing refers to extracting or generating data that is valuable and meaningful to a particular person from a large amount of, cluttered, and incomprehensible data. Data processing includes data validation, data cleansing, data selection, and data augmentation. - -- Data validation indicates that the dataset is verified to ensure data accuracy. - -- Data cleansing refers to the process of denoising, correcting, or supplementing data. - -- Data selection indicates the process of selecting data subsets from full data. - -- Data augmentation indicates that data volume is increased through simple data amplification operations such as scaling, cropping, transformation, and composition. - -URI ---- - -GET /v2/{project_id}/processor-tasks - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | query_current | No | Boolean | Whether to query only the latest tasks of dataset version. The options are as follows: | - | | | | | - | | | | - **true**: Query only the latest tasks of the dataset version. | - | | | | | - | | | | - **false**: Query all tasks of the dataset version. (Default value) | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | return_result | No | Boolean | Whether to return the task result. The options are as follows: | - | | | | | - | | | | - **true**: Return the task result. (Default value) | - | | | | | - | | | | - **false**: Do not return the task result. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **name**: Sort by task name. | - | | | | | - | | | | - **duration_seconds**: Sort by running time. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | No | String | Data source path of the query. The options are as follows: | - | | | | | - | | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | | - | | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | | - | | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | | - | | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | No | String | Data source type of the query. If this parameter is not specified, all data sources are queried by default. The options are as follows: | - | | | | | - | | | | - **OBS**: Data obtained from OBS | - | | | | | - | | | | - **TASK**: Data processing task | - | | | | | - | | | | - **DATASET**: Dataset | - | | | | | - | | | | - **CUSTOM**: Data called by resource tenants | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | Integer | Task status of the query. If this parameter is not specified, tasks in all states are queried by default. The options are as follows: | - | | | | | - | | | | - **0**: initialized | - | | | | | - | | | | - **1**: running | - | | | | | - | | | | - **2**: completed | - | | | | | - | | | | - **3**: failed | - | | | | | - | | | | - **4**: stopped | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_name | No | String | Fuzzy search keyword. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_type | No | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | | - | | | | - **sys_data_analyse**: feature analysis | - | | | | | - | | | | - **sys_data_cleaning**: data cleansing | - | | | | | - | | | | - **sys_data_augmentation**: data augmentation | - | | | | | - | | | | - **sys_data_validation**: data validation | - | | | | | - | | | | - **sys_data_selection**: data selection | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | Array | Version ID list of a specific dataset of the query. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------+------------------------------------------------------------------------------------------------------------+--------------------------------------------+ - | Parameter | Type | Description | - +===========+============================================================================================================+============================================+ - | count | Integer | Total number of data processing tasks. | - +-----------+------------------------------------------------------------------------------------------------------------+--------------------------------------------+ - | tasks | Array of :ref:`DescribeProcessorTaskResp ` objects | Data processing task list queried by page. | - +-----------+------------------------------------------------------------------------------------------------------------+--------------------------------------------+ - -.. _listprocessortasks__response_describeprocessortaskresp: - -.. table:: **Table 4** DescribeProcessorTaskResp - - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+================================================================================================+===========================================================================================================================================================+ - | create_time | Long | Time when a data processing task is created. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | :ref:`ProcessorDataSource ` object | Input of a data processing task. Either this parameter or **inputs** is delivered. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Description of a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration_seconds | Integer | Running time of data processing, in seconds. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Error message. This field is displayed when the value of status is **3**. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inputs | Array of :ref:`ProcessorDataSource ` objects | Input channel list of a data processing task. Either this parameter or **data_source** is delivered. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_current | Boolean | Whether the current task is the latest of the same type of this version. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result | Object | Output result of a data processing task. This field is displayed when status is set to **2** and is valid for a feature analysis task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a data processing task. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | task_id | String | ID of a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template | :ref:`TemplateParam ` object | Data processing template, such as the algorithm ID and parameters. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_count | Integer | Version number of a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Dataset version ID corresponding to a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name corresponding to a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | work_path | :ref:`WorkPath ` object | Working directory of a data processing task. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID of a data processing task. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------------+------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listprocessortasks__response_processordatasource: - -.. table:: **Table 5** ProcessorDataSource - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Data source path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | - | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Data source type. The options are as follows: | - | | | | - | | | - **OBS**: Data obtained from OBS | - | | | | - | | | - **TASK**: Data processing task | - | | | | - | | | - **DATASET**: Dataset | - | | | | - | | | - **CUSTOM**: Data called by resource tenants | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listprocessortasks__response_templateparam: - -.. table:: **Table 6** TemplateParam - - +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+====================================================================================+===================================================================================+ - | id | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | - | | | - **sys_data_analyse**: feature analysis | - | | | | - | | | - **sys_data_cleaning**: data cleansing | - | | | | - | | | - **sys_data_augmentation**: data augmentation | - | | | | - | | | - **sys_data_validation**: data validation | - | | | | - | | | - **sys_data_selection**: data selection | - +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | String | Template name. | - +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------------+------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _listprocessortasks__response_operatorparam: - -.. table:: **Table 7** OperatorParam - - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | Boolean | Advanced parameter switch. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | ID of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listprocessortasks__response_workpath: - -.. table:: **Table 8** WorkPath - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | String | Output path. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | String | Working path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a working path. The options are as follows: | - | | | | - | | | - **OBS**: OBS path | - | | | | - | | | - **DATASET**: dataset | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Query historical data validation tasks of a specified dataset. - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks?offset=0&limit=10&sort_by=create_time&order=desc&source_type=DATASET&source=qjHAs14pRu4n2so1Qlb&task_type=sys_data_validation&return_result=false - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "task_id" : "SSzH9AdmHTvIBeihArb", - "name" : "PRE-6c83", - "description" : "test", - "inputs" : [ { - "type" : "DATASET", - "source" : "qjHAs14pRu4n2so1Qlb", - "version_id" : "cUELhTAYGIR36YpTE5Y", - "name" : "dataset-dba1", - "version_name" : "V001" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "qjHAs14pRu4n2so1Qlb", - "name" : "dataset-dba1", - "version_name" : "V002", - "output_path" : "/test-lxm/data-out/EnyHCFzjTFY20U3sYSE/" - }, - "template" : { - "id" : "sys_data_validation", - "name" : "data validation template name", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "-1", - "image_max_height" : "-1", - "total_status" : "[0,1,2]" - } - } ] - }, - "status" : 2, - "duration_seconds" : 277, - "create_time" : 1614245065569, - "workspace_id" : "0", - "version_count" : 1, - "ai_project" : "" - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_the_result_of_a_data_processing_task_version.rst b/modelarts/api-ref/result/data_management/processing_task/querying_the_result_of_a_data_processing_task_version.rst deleted file mode 100644 index 0f0925a5..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_the_result_of_a_data_processing_task_version.rst +++ /dev/null @@ -1,174 +0,0 @@ -.. _ListProcessorTaskVersionResults: - -Querying the Result of a Data Processing Task Version -===================================================== - -Function --------- - -This API is used to query the result of a data processing task version. - -URI ---- - -GET /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/results - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Version ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=====================================================================================================================================================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | process_parameter | No | String | Image resizing setting, which is the same as the OBS resizing setting. For details, see . For example, **image/resize,m_lfit,h_200** indicates that the target image is resized proportionally and the height is set to 200 pixels. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result_property | No | String | Sample status. If this parameter is not delivered or is set to **-1**, all samples are returned by default. The options are as follows: | - | | | | | - | | | | - **-1**: all | - | | | | | - | | | | - **0**: reserve | - | | | | | - | | | | - **1**: modify | - | | | | | - | | | | - **2**: delete | - | | | | | - | | | | - **3**: add | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------+---------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ - | Parameter | Type | Description | - +===========+=============================================================================================================================================+===================================+ - | count | Integer | Total number of results. | - +-----------+---------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ - | has_more | Boolean | Whether all results are returned. | - +-----------+---------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ - | results | Array of :ref:`DescProcessorTaskVersionResultsResp ` objects | Result displayed by page. | - +-----------+---------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------+ - -.. _listprocessortaskversionresults__response_descprocessortaskversionresultsresp: - -.. table:: **Table 4** DescProcessorTaskVersionResultsResp - - +-----------------------+-----------------------+------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================+ - | new_source | String | Address of the sample after processing. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | origin_source | String | Source address of a sample. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | result_description | Array of objects | Processing description of a sample. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | result_property | Integer | Processing status of a sample. The options are as follows: | - | | | | - | | | - **-1**: all | - | | | | - | | | - **0**: reserve | - | | | | - | | | - **1**: modify | - | | | | - | | | - **2**: delete | - | | | | - | | | - **3**: add | - +-----------------------+-----------------------+------------------------------------------------------------+ - | sample_id | String | Sample ID, which is generated by **md5** in the OBS path. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | signed_new_source | String | Address of the processed sample after signature. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | signed_origin_source | String | Source sample address after signature. | - +-----------------------+-----------------------+------------------------------------------------------------+ - | version_id | String | Version ID of a data processing task. | - +-----------------------+-----------------------+------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Result of a Data Processing Task Version - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/results?offset=0&limit=14&result_property=-1 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "count" : 3, - "results" : [ { - "sample_id" : "0ac9aee517acbef965f547bb5a3268af", - "version_id" : "7PoIhUzSk92OglQrTxr", - "origin_source" : "s3://test-obs/classify/data/cat-dog/8.jpg", - "new_source" : "obs://test-obs/classify/output/7PoIhUzSk92OglQrTxr/Data/8.jpg", - "signed_origin_source" : "https://test-obs.obs.xxx.com:443/classify/data/cat-dog/8.jpg?AccessKeyId=I5IZ9R29S1W9WACNJJ0J&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jQ5yFSR1TfKXjeawutgyAnMrdoGNaSkeSBOKK...&Signature=GbnVBZ5JxUWhiAulUzpV9TD835Q%3D", - "signed_new_source" : "https://test-obs.obs.xxx.com:443/classify/output/7PoIhUzSk92OglQrTxr/Data/8.jpg?AccessKeyId=I5IZ9R29S1W9WACNJJ0J&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jQ5yFSR1TfKXjeawutgyAnMrdoGNaSkeSBOKK...&Signature=Q5stFFFfVx9kykR49S8PPBlFqe0%3D", - "result_property" : 3, - "result_description" : [ [ "use AddNoise augmentation" ], [ "result_description to translate" ] ] - }, { - "sample_id" : "196799b2d731727b1800b70851fc60b0", - "version_id" : "7PoIhUzSk92OglQrTxr", - "origin_source" : "s3://test-obs/classify/data/cat-dog/2.jpg", - "new_source" : "obs://test-obs/classify/output/7PoIhUzSk92OglQrTxr/Data/2.jpg", - "signed_origin_source" : "https://test-obs.obs.xxx.com:443/classify/data/cat-dog/2.jpg?AccessKeyId=QEKFB6WFGZWC2YUP2JPK&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jdUZcXVRCNOHjWNNWiuu2E9Q...&Signature=6yvhJufi5kQO6UjToQgR0ztP%2Bis%3D", - "signed_new_source" : "https://test-obs.obs.xxx.com:443/classify/output/7PoIhUzSk92OglQrTxr/Data/2.jpg?AccessKeyId=QEKFB6WFGZWC2YUP2JPK&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jdUZcXVRCNOHjWNNWiuu2E...&Signature=Zr%2BAEBDJwKS%2FpS6vzxK7MSzjblA%3D", - "result_property" : 3, - "result_description" : [ [ "use AddNoise augmentation" ], [ "result_description to translate" ] ] - }, { - "sample_id" : "1dc7351b78dcb24850f71d20267edd0e", - "version_id" : "7PoIhUzSk92OglQrTxr", - "origin_source" : "s3://test-obs/classify/data/cat-dog/import_1603716822103/test-obs/classify/output/E8ZLnTQvPBVtbZ6QsAp/Data/13.jpg", - "new_source" : "obs://test-obs/classify/output/7PoIhUzSk92OglQrTxr/Data/13.jpg", - "signed_origin_source" : "https://test-obs.obs.xxx.com:443/classify/data/cat-dog/import_1603716822103/test-obs/classify/output/E8ZLnTQvPBVtbZ6QsAp/Data/13.jpg?AccessKeyId=W6TSX9F1BRS8AUBDYKPY&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jVVFic8iObvdqZLuWxyIHlAjbJPCTX...&Signature=WV73XnoMkBDoSuVe%2BFSUaP1GxKw%3D", - "signed_new_source" : "https://test-obs.obs.xxx.com:443/classify/output/7PoIhUzSk92OglQrTxr/Data/13.jpg?AccessKeyId=W6TSX9F1BRS8AUBDYKPY&Expires=1606380154&x-obs-security-token=gQpjbi1ub3J0aC03jVVFic8iObvdqZLuWxyIHlAjbJPCTXeYXkQh8z...&Signature=%2FYsgrsbyrz5ZQrndrQ9QyoHluYQ%3D", - "result_property" : 3, - "result_description" : [ [ "use AddNoise augmentation" ], [ "result_description to translate" ] ] - } ], - "has_more" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/querying_the_version_list_of_a_data_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/querying_the_version_list_of_a_data_processing_task.rst deleted file mode 100644 index 9f30e547..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/querying_the_version_list_of_a_data_processing_task.rst +++ /dev/null @@ -1,342 +0,0 @@ -.. _ListProcessorTaskVersions: - -Querying the Version List of a Data Processing Task -=================================================== - -Function --------- - -This API is used to query the version list of a data processing task. - -URI ---- - -GET /v2/{project_id}/processor-tasks/{task_id}/versions - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+================================================================================================================+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **100**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. The options are as follows: | - | | | | | - | | | | - **create_time**: Sort by creation time. (Default value) | - | | | | | - | | | | - **version_name**: Sort by task version name. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=======================================================================================================+=========================================================+ - | count | Integer | Total number of versions. | - +-----------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ - | versions | Array of :ref:`DescTaskVersionResp ` objects | Version list of a data processing task queried by page. | - +-----------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------+ - -.. _listprocessortaskversions__response_desctaskversionresp: - -.. table:: **Table 4** DescTaskVersionResp - - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================================================================================================+===============================================================+ - | add_sample_count | Integer | Number of added images after processing. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | create_time | Long | Time when a data processing task is created. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | deleted_sample_count | Integer | Number of deleted images after processing. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | description | String | Version description of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | duration_seconds | Integer | Running time of a data processing task, in seconds. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | inputs | Array of :ref:`ProcessorDataSource ` objects | Input channel of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | modified_sample_count | Integer | Number of modified images after processing. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | origin_sample_count | Integer | Number of images before processing. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | status | Integer | Status of a data processing task. The options are as follows: | - | | | | - | | | - **0**: initialized | - | | | | - | | | - **1**: running | - | | | | - | | | - **2**: completed | - | | | | - | | | - **3**: failed | - | | | | - | | | - **4**: stopped | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | task_id | String | ID of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | task_version_id | String | Version ID of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | template | :ref:`TemplateParam ` object | Algorithm template, such as the algorithm ID and parameters. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | unmodified_sample_count | Integer | Number of unmodified images after processing. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | update_time | Long | Time when a data processing task is created. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | version_name | String | Version name of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - | work_path | :ref:`WorkPath ` object | Output channel of a data processing task. | - +-------------------------+-------------------------------------------------------------------------------------------------------+---------------------------------------------------------------+ - -.. _listprocessortaskversions__response_processordatasource: - -.. table:: **Table 5** ProcessorDataSource - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Data source path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **TASK**, **source** is a task ID. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - | | | | - | | | - If **type** is set to **CUSTOM** and the API is called by resource tenants, set **source** to the **project_id** of the actual user. Otherwise, this field is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Data source type. The options are as follows: | - | | | | - | | | - **OBS**: Data obtained from OBS | - | | | | - | | | - **TASK**: Data processing task | - | | | | - | | | - **DATASET**: Dataset | - | | | | - | | | - **CUSTOM**: Data called by resource tenants | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Dataset version name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listprocessortaskversions__response_templateparam: - -.. table:: **Table 6** TemplateParam - - +-----------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================================================================================+===================================================================================+ - | id | String | Task type, that is, ID of a data processing template. The options are as follows: | - | | | | - | | | - **sys_data_analyse**: feature analysis | - | | | | - | | | - **sys_data_cleaning**: data cleansing | - | | | | - | | | - **sys_data_augmentation**: data augmentation | - | | | | - | | | - **sys_data_validation**: data validation | - | | | | - | | | - **sys_data_selection**: data selection | - +-----------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | name | String | Template name. | - +-----------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - | operator_params | Array of :ref:`OperatorParam ` objects | Operator parameter list. | - +-----------------------+-------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------+ - -.. _listprocessortaskversions__response_operatorparam: - -.. table:: **Table 7** OperatorParam - - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +========================+=========+==============================================================================================================================================================================================================================================================================================================================================================+ - | advanced_params_switch | Boolean | Advanced parameter switch. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | ID of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of an operator. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Operator parameter. The parameter type is map. Currently, object only supports the types of Boolean, Integer, Long, String, List and Map. For two special scenarios of object detection and image classification in a data preprocessing task, the value of **task_type** is **object_detection** or **image_classification**. | - +------------------------+---------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listprocessortaskversions__response_workpath: - -.. table:: **Table 8** WorkPath - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | name | String | Dataset name. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | output_path | String | Output path. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | path | String | Working path. The options are as follows: | - | | | | - | | | - If **type** is set to **OBS**, **source** is an OBS path. | - | | | | - | | | - If **type** is set to **DATASET**, **source** is a dataset ID. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a working path. The options are as follows: | - | | | | - | | | - **OBS**: OBS path | - | | | | - | | | - **DATASET**: dataset | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | String | Version of a dataset. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Name of a dataset version. The value can contain 0 to 32 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Version List of a Data Processing Task - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions?offset=0&limit=5 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "count" : 2, - "versions" : [ { - "task_version_id" : "qSaudx2sbPvthHygckA", - "task_id" : "kM7j9TSa611ZzBThzSr", - "version_name" : "V002", - "description" : "", - "status" : 0, - "create_time" : 1606377874450, - "inputs" : [ { - "type" : "DATASET", - "source" : "PYc9H2HGv5BJNwBGXyK", - "version_id" : "Osc8SZ7TZStiRV4vYkZ", - "name" : "dataset-test", - "version_name" : "V0010" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "PYc9H2HGv5BJNwBGXyK", - "name" : "dataset-test", - "version_name" : "V0011", - "output_path" : "/test-obs/classify/output/qSaudx2sbPvthHygckA/" - }, - "template" : { - "id" : "sys_data_validation", - "name" : "name to translate", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "1920", - "image_max_height" : "1920", - "total_status" : "[0,1,2]" - } - } ] - }, - "duration_seconds" : 151 - }, { - "task_version_id" : "YHFWU18zXuNbqxtzegG", - "task_id" : "kM7j9TSa611ZzBThzSr", - "version_name" : "V001", - "description" : "", - "status" : 2, - "create_time" : 1606375407276, - "inputs" : [ { - "type" : "DATASET", - "source" : "PYc9H2HGv5BJNwBGXyK", - "version_id" : "yoJ5ssClpNlOrsjjFDa", - "name" : "dataset-test", - "version_name" : "V009" - } ], - "work_path" : { - "type" : "DATASET", - "path" : "PYc9H2HGv5BJNwBGXyK", - "name" : "dataset-test", - "version_id" : "Osc8SZ7TZStiRV4vYkZ", - "version_name" : "V0010", - "output_path" : "/test-obs/classify/output/YHFWU18zXuNbqxtzegG/" - }, - "template" : { - "id" : "sys_data_validation", - "name" : "name to translate", - "operator_params" : [ { - "name" : "MetaValidation", - "advanced_params_switch" : false, - "params" : { - "task_type" : "image_classification", - "dataset_type" : "manifest", - "source_service" : "select", - "filter_func" : "data_validation_select", - "image_max_width" : "1920", - "image_max_height" : "1920", - "total_status" : "[0,1,2]" - } - } ] - }, - "duration_seconds" : 812, - "origin_sample_count" : 18, - "add_sample_count" : 0, - "modified_sample_count" : 0, - "unmodified_sample_count" : 18, - "deleted_sample_count" : 0 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/stopping_the_version_of_a_data_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/stopping_the_version_of_a_data_processing_task.rst deleted file mode 100644 index 28a83490..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/stopping_the_version_of_a_data_processing_task.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _StopProcessorTaskVersion: - -Stopping the Version of a Data Processing Task -============================================== - -Function --------- - -This API is used to stop the version of a data processing task. - -URI ---- - -POST /v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/stop - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | String | Version ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -This API is used to stop the version of a data processing task. - -.. code-block:: - - POST https://{endpoint}/v2/{project_id}/processor-tasks/{task_id}/versions/{version_id}/stop - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/processing_task/updating_a_processing_task.rst b/modelarts/api-ref/result/data_management/processing_task/updating_a_processing_task.rst deleted file mode 100644 index 09c91511..00000000 --- a/modelarts/api-ref/result/data_management/processing_task/updating_a_processing_task.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _UpdateProcessorTask: - -Updating a Processing Task -========================== - -Function --------- - -This API is used to update a processing task. You can update feature analysis tasks and data processing tasks. Only the description of updated tasks is supported. You can specify the **task_id** path parameter to update a specific task. - -URI ---- - -PUT /v2/{project_id}/processor-tasks/{task_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | task_id | Yes | String | ID of a data processing task. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=====================================================================================================================================================+ - | description | No | String | Description of a data processing task. The description contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Updating a Data Processing Task - -.. code-block:: - - { - "description" : "test" - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/adding_samples_in_batches.rst b/modelarts/api-ref/result/data_management/sample_management/adding_samples_in_batches.rst deleted file mode 100644 index 76ac782e..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/adding_samples_in_batches.rst +++ /dev/null @@ -1,532 +0,0 @@ -.. _UploadSamplesJson: - -Adding Samples in Batches -========================= - -Function --------- - -This API is used to add samples in batches. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +------------------+-----------------+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==================+=================+====================================================================+=======================================================================================================================================================================+ - | final_annotation | No | Boolean | Whether to directly import to the final result. The options are as follows: | - | | | | | - | | | | - **true**: Import labels to the labeled dataset. (Default value). | - | | | | | - | | | | - **false**: Import labels to the to-be-confirmed dataset. Currently, to-be-confirmed datasets only support categories of image classification and object detection. | - +------------------+-----------------+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_format | No | :ref:`LabelFormat ` object | Label format. This parameter is used only for text datasets. | - +------------------+-----------------+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | No | Array of :ref:`Sample ` objects | Sample list. | - +------------------+-----------------+--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_labelformat: - -.. table:: **Table 3** LabelFormat - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+=========================================================================================================================================================================================================================================================================+ - | label_type | No | String | Label type of text classification. The options are as follows: | - | | | | | - | | | | - **0**: The label is separated from the text, and they are distinguished by the fixed suffix **\_result**. For example, the text file is **abc.txt**, and the label file is **abc_result.txt**. | - | | | | | - | | | | - **1**: Default value. Labels and texts are stored in the same file and separated by separators. You can use **text_sample_separator** to specify the separator between the text and label and **text_label_separator** to specify the separator between labels. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_label_separator | No | String | Separator between labels. By default, the comma (,) is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | text_sample_separator | No | String | Separator between the text and label. By default, the **Tab** key is used as the separator. The separator needs to be escaped. Only one character can be used as the separator. The value must contain letters, digits, and one special character (!@#$%^&*_=|?/':.;,). | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_sample: - -.. table:: **Table 4** Sample - - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==============================================================================+================================================================================================================================================================+ - | data | No | Object | Byte data of sample files. The type is **java.nio.ByteBuffer**. When this parameter is called, the string converted from the byte data is uploaded. | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | No | :ref:`DataSource ` object | Data source. | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | encoding | No | String | Encoding type of sample files, which is used to upload .txt or .csv files. The value can be **UTF-8**, **GBK**, or **GB2312**. The default value is **UTF-8**. | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labels | No | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Name of sample files. The value contains 0 to 1,024 characters and cannot contain special characters (!<>=&"'). | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | No | Integer | Sample type. The options are as follows: | - | | | | | - | | | | - **0**: image | - | | | | | - | | | | - **1**: text | - | | | | | - | | | | - **2**: speech | - | | | | | - | | | | - **4**: table | - | | | | | - | | | | - **6**: video | - | | | | | - | | | | - **9**: custom format | - +-----------------+-----------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_datasource: - -.. table:: **Table 5** DataSource - - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+==========================================================================+============================================================================================================================+ - | data_path | No | String | Data source path. | - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | data_type | No | Integer | Data type. The options are as follows: | - | | | | | - | | | | - **0**: OBS bucket (default value) | - | | | | | - | | | | - **1**: GaussDB(DWS) | - | | | | | - | | | | - **2**: DLI | - | | | | | - | | | | - **3**: RDS | - | | | | | - | | | | - **4**: MRS | - | | | | | - | | | | - **5**: AI Gallery | - | | | | | - | | | | - **6**: Inference service | - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | schema_maps | No | Array of :ref:`SchemaMap ` objects | Schema mapping information corresponding to the table data. | - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | source_info | No | :ref:`SourceInfo ` object | Information required for importing a table data source. | - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - | with_column_header | No | Boolean | Whether the first row in the file is a column name. This field is valid for the table dataset. The options are as follows: | - | | | | | - | | | | - **true**: The first row in the file is the column name. | - | | | | | - | | | | - **false**: The first row in the file is not the column name. | - +--------------------+-----------------+--------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_schemamap: - -.. table:: **Table 6** SchemaMap - - ========= ========= ====== =============================== - Parameter Mandatory Type Description - ========= ========= ====== =============================== - dest_name No String Name of the destination column. - src_name No String Name of the source column. - ========= ========= ====== =============================== - -.. _uploadsamplesjson__request_sourceinfo: - -.. table:: **Table 7** SourceInfo - - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================+ - | cluster_id | No | String | ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_mode | No | String | Running mode of an MRS cluster. The options are as follows: | - | | | | | - | | | | - **0**: normal cluster | - | | | | | - | | | | - **1**: security cluster | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | cluster_name | No | String | Name of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | database_name | No | String | Name of the database to which the table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | input | No | String | HDFS path of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | ip | No | String | IP address of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | port | No | String | Port number of your GaussDB(DWS) cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | queue_name | No | String | DLI queue name of a table dataset. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | subnet_id | No | String | Subnet ID of an MRS cluster. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | table_name | No | String | Name of the table to which a table dataset is imported. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_name | No | String | Username, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | user_password | No | String | User password, which is mandatory for GaussDB(DWS) data. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - | vpc_id | No | String | ID of the VPC where an MRS cluster resides. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------+ - -.. _uploadsamplesjson__request_samplelabel: - -.. table:: **Table 8** SampleLabel - - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+====================================================================================+=======================================================================================================================================+ - | annotated_by | No | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | | - | | | | - **human**: manual labeling | - | | | | | - | | | | - **auto**: automatic labeling | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Label ID. | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | Float | Confidence. | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_samplelabelproperty: - -.. table:: **Table 9** SampleLabelProperty - - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | No | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | No | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | | - | | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | | - | | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | No | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | No | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | | - | | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | | - | | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | | - | | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | | - | | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | | - | | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | No | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | No | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | | - | | | | - **0/false**: not a hard example | - | | | | | - | | | | - **1/true**: hard example | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | No | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | No | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | No | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | No | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | No | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _uploadsamplesjson__request_samplemetadata: - -.. table:: **Table 10** SampleMetadata - - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+===================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | No | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | No | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 11** Response body parameters - - +-----------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | results | Array of :ref:`UploadSampleResp ` objects | Response list for adding samples in batches. | - +-----------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+-----------------------------------------------------------------------------------------+------------------------------------------------------------------+ - -.. _uploadsamplesjson__response_uploadsampleresp: - -.. table:: **Table 12** UploadSampleResp - - +-----------------------+-----------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | info | String | Description. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | name | String | Name of a sample file. | - +-----------------------+-----------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+-----------------------+------------------------------------------------------------------+ - -Example Requests ----------------- - -Adding Samples in Batches - -.. code-block:: - - { - "samples" : [ { - "name" : "2.jpg", - "data" : "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCAA1AJUDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true, - "results" : [ { - "success" : true, - "name" : "/test-obs/classify/input/cat-dog/2.jpg", - "info" : "960585877c92d63911ba555ab3129d36" - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/deleting_samples_in_batches.rst b/modelarts/api-ref/result/data_management/sample_management/deleting_samples_in_batches.rst deleted file mode 100644 index 6a5d1870..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/deleting_samples_in_batches.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _DeleteSamples: - -Deleting Samples in Batches -=========================== - -Function --------- - -This API is used to delete samples in batches. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/delete - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================+=============================================================================================================================================================================================================================================+ - | delete_source | No | Boolean | Whether to delete the source file. This field is valid for non-text datasets. (A text dataset is the entire text file. Therefore, deleting a piece of data from the text file does not affect the source text.) The options are as follows: | - | | | | | - | | | | - **false**: Do not delete the source file. (Default value) | - | | | | | - | | | | - **true**: Delete the source file. (Note: This operation may affect the dataset versions or other datasets that have used these files. As a result, the page display, training, or inference is abnormal.) | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | samples | No | Array of strings | Sample ID list. | - +-----------------+-----------------+------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response list for deleting a sample in batches. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------+ - -.. _deletesamples__response_batchresponse: - -.. table:: **Table 4** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting Samples in Batches - -.. code-block:: - - { - "samples" : [ "9cb9bc9b34bf53b6ec9a84998b1711bf", "9ea63ef78d8c9037c9bcb12b477821bf" ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/index.rst b/modelarts/api-ref/result/data_management/sample_management/index.rst deleted file mode 100644 index e0f2a658..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _sample_management: - -================= -Sample Management -================= - -.. toctree:: - :maxdepth: 1 - - querying_the_sample_list - adding_samples_in_batches - deleting_samples_in_batches - querying_details_about_a_sample - obtaining_sample_search_condition - querying_the_sample_list_of_a_team_labeling_task_by_page - querying_details_about_team_labeling_samples diff --git a/modelarts/api-ref/result/data_management/sample_management/obtaining_sample_search_condition.rst b/modelarts/api-ref/result/data_management/sample_management/obtaining_sample_search_condition.rst deleted file mode 100644 index d8be3e0e..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/obtaining_sample_search_condition.rst +++ /dev/null @@ -1,202 +0,0 @@ -.. _ListSearch: - -Obtaining Sample Search Condition -================================= - -Function --------- - -This API is used to obtain sample search condition. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/search-condition - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------+------------------------------------------------------------+----------------------------------------+ - | Parameter | Type | Description | - +===========+============================================================+========================================+ - | labelers | Array of strings | List of labeling team members. | - +-----------+------------------------------------------------------------+----------------------------------------+ - | labels | Array of :ref:`Label ` objects | Label list. | - +-----------+------------------------------------------------------------+----------------------------------------+ - | metadata | Map> | Attribute key-value pair of a dataset. | - +-----------+------------------------------------------------------------+----------------------------------------+ - -.. _listsearch__response_label: - -.. table:: **Table 3** Label - - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==============================================================================+==================================================================================================================================+ - | attributes | Array of :ref:`LabelAttribute ` objects | Multi-dimensional attribute of a label. For example, if the label is music, attributes such as style and artist may be included. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`LabelProperty ` object | Basic attribute key-value pair of a label, such as color and shortcut keys. | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------+ - -.. _listsearch__response_labelattribute: - -.. table:: **Table 4** LabelAttribute - - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========================================================================================+===================================================+ - | default_value | String | Default value of a label attribute. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | id | String | Label attribute ID. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | name | String | Label attribute name. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | type | String | Label attribute type. The options are as follows: | - | | | | - | | | - **text**: text | - | | | | - | | | - **select**: single-choice drop-down list | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - | values | Array of :ref:`LabelAttributeValue ` objects | List of label attribute values. | - +-----------------------+----------------------------------------------------------------------------------------+---------------------------------------------------+ - -.. _listsearch__response_labelattributevalue: - -.. table:: **Table 5** LabelAttributeValue - - ========= ====== ========================= - Parameter Type Description - ========= ====== ========================= - id String Label attribute value ID. - value String Label attribute value. - ========= ====== ========================= - -.. _listsearch__response_labelproperty: - -.. table:: **Table 6** LabelProperty - - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==========================+=======================+================================================================================================================================================================================================================+ - | @modelarts:color | String | Default attribute: Label color, which is a hexadecimal code of the color. By default, this parameter is left blank. Example: **#FFFFF0**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:default_shape | String | Default attribute: Default shape of an object detection label (dedicated attribute). By default, this parameter is left blank. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from_type | String | Default attribute: Type of the head entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:rename_to | String | Default attribute: The new name of the label. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shortcut | String | Default attribute: Label shortcut key. By default, this parameter is left blank. For example: **D**. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to_type | String | Default attribute: Type of the tail entity in the triplet relationship label. This attribute must be specified when a relationship label is created. This parameter is used only for the text triplet dataset. | - +--------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Obtaining Sample Search Condition - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/search-condition - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "labels" : [ { - "name" : "Cat", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - }, { - "name" : "Dog", - "type" : 0, - "property" : { - "@modelarts:color" : "#3399ff" - } - } ], - "metadata" : { }, - "labelers" : [ "human/test_123/test_123", "human/xxx@xxx.com", "human/xxx@xxx.com" ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/querying_details_about_a_sample.rst b/modelarts/api-ref/result/data_management/sample_management/querying_details_about_a_sample.rst deleted file mode 100644 index 91633042..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/querying_details_about_a_sample.rst +++ /dev/null @@ -1,542 +0,0 @@ -.. _DescribeSample: - -Querying Details About a Sample -=============================== - -Function --------- - -Query details about a sample. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id} - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | sample_id | Yes | String | Sample ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _describesample__response_worker: - -.. table:: **Table 5** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describesample__response_samplelabel: - -.. table:: **Table 6** SampleLabel - - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+----------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describesample__response_samplelabelproperty: - -.. table:: **Table 7** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describesample__response_samplemetadata: - -.. table:: **Table 8** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Sample - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/samples/{sample_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_id" : "012f99f3cf405860130b6ed2350c2228", - "sample_type" : 0, - "labels" : [ { - "name" : "car", - "type" : 0, - "property" : { } - } ], - "source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/36502.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606297079&Signature=Ju4FYpEu973ii%2FAdUVLTfpLCTbg%3D", - "metadata" : { - "@modelarts:import_origin" : 0 - }, - "sample_time" : 1589190552106, - "sample_status" : "MANUAL_ANNOTATION", - "annotated_by" : "human/test_123/test_123", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "5d8d4033b428fed5ac158942c33940a2", - "role" : 0 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/querying_details_about_team_labeling_samples.rst b/modelarts/api-ref/result/data_management/sample_management/querying_details_about_team_labeling_samples.rst deleted file mode 100644 index 40d047fc..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/querying_details_about_team_labeling_samples.rst +++ /dev/null @@ -1,541 +0,0 @@ -.. _DescribeWorkforceTaskSample: - -Querying Details About Team Labeling Samples -============================================ - -Function --------- - -This API is used to query details about team labeling samples. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sample_id} - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | sample_id | Yes | String | Sample ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+-----------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _describeworkforcetasksample__response_worker: - -.. table:: **Table 5** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeworkforcetasksample__response_samplelabel: - -.. table:: **Table 6** SampleLabel - - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-----------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeworkforcetasksample__response_samplelabelproperty: - -.. table:: **Table 7** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _describeworkforcetasksample__response_samplemetadata: - -.. table:: **Table 8** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About Team Labeling Samples - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples/{sample_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_id" : "26c6dd793d80d3274eb89349ec76d678", - "sample_type" : 0, - "labels" : [ ], - "source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000016.png?AccessKeyId=4D34AYDTK93HUY79NSD7&Expires=1606300437&x-obs-security-token=gQpjbi1ub3J0aC03jELficNKUP87aSTIhvsHQAvImcyVbXlYTrU2XJIc28F7kiXanJ3TyJV39iXl0yi5mzQ...", - "metadata" : { - "@modelarts:import_origin" : 0, - "@modelarts:size" : [ 1242, 375, 3 ] - }, - "sample_time" : 1598263639997, - "sample_status" : "UN_ANNOTATION", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", - "role" : 0 - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list.rst b/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list.rst deleted file mode 100644 index 99f6cf25..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list.rst +++ /dev/null @@ -1,641 +0,0 @@ -.. _ListSamples: - -Querying the Sample List -======================== - -Function --------- - -This API is used to query the sample list by page. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/data-annotations/samples - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=====================================================================================================================================================================================================================================+ - | email | No | String | Email address of a labeling team member. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | high_score | No | String | Upper confidence limit. The default value is **1**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_name | No | String | Label name. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | No | Integer | Labeling type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | low_score | No | String | Lower confidence limit. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting sequence of the query. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | preview | No | Boolean | Whether to support preview. The options are as follows: | - | | | | | - | | | | - **true**: Preview is supported. | - | | | | | - | | | | - **false**: Preview is not supported. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | process_parameter | No | String | Image resizing setting, which is the same as the OBS resizing setting. For details, see . For example, **image/resize,m_lfit,h_200** indicates that the target image is resized proportionally and the height is set to 200 pixels. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | No | Integer | Sample file type. The options are as follows: | - | | | | | - | | | | - **0**: image | - | | | | | - | | | | - **1**: text | - | | | | | - | | | | - **2**: audio | - | | | | | - | | | | - **4**: table | - | | | | | - | | | | - **6**: video | - | | | | | - | | | | - **9**: custom format (default value) | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | No | String | Multi-dimensional search condition after URL encoding. The relationship between multiple search conditions is AND. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | No | String | Dataset version ID. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+---------------------------------------------------------------------------------------+--------------------+ - | Parameter | Type | Description | - +==============+=======================================================================================+====================+ - | sample_count | Integer | Number of samples. | - +--------------+---------------------------------------------------------------------------------------+--------------------+ - | samples | Array of :ref:`DescribeSampleResp ` objects | Sample list. | - +--------------+---------------------------------------------------------------------------------------+--------------------+ - -.. _listsamples__response_describesampleresp: - -.. table:: **Table 4** DescribeSampleResp - - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+-------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 5** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _listsamples__response_worker: - -.. table:: **Table 6** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listsamples__response_samplelabel: - -.. table:: **Table 7** SampleLabel - - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===============================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+-------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listsamples__response_samplelabelproperty: - -.. table:: **Table 8** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listsamples__response_samplemetadata: - -.. table:: **Table 9** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Sample List by Page - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/data-annotations/samples - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_count" : 2, - "samples" : [ { - "sample_id" : "012f99f3cf405860130b6ed2350c2228", - "sample_type" : 0, - "labels" : [ { - "name" : "car", - "type" : 0, - "property" : { } - } ], - "source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/36502.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606296688&x-image-process=image%2Fresize%2Cm_lfit%2Ch_200&Signature=icyvHhFew9vnmy3zh1uZMP15Mbg%3D", - "metadata" : { - "@modelarts:import_origin" : 0 - }, - "sample_time" : 1589190552106, - "sample_status" : "MANUAL_ANNOTATION", - "annotated_by" : "human/test_123/test_123", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "5d8d4033b428fed5ac158942c33940a2", - "role" : 0 - } ] - }, { - "sample_id" : "0192f3acfb000666033a0f85c21577c7", - "sample_type" : 0, - "labels" : [ { - "name" : "car", - "type" : 0, - "property" : { } - } ], - "source" : "https://test-obs.obs.xxx.com:443/image/aifood/%E5%86%B0%E6%BF%80%E5%87%8C/36139.jpg?AccessKeyId=RciyO7RHmhNTfOZVryUH&Expires=1606296688&x-image-process=image%2Fresize%2Cm_lfit%2Ch_200&Signature=RRr9r2cghLCXk%2B0%2BfHtYJi8eZ4k%3D", - "metadata" : { - "@modelarts:import_origin" : 0 - }, - "sample_time" : 1589190543327, - "sample_status" : "MANUAL_ANNOTATION", - "annotated_by" : "human/test_123/test_123", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "a2abd3f27b4e92c593c15282f8b6bd29", - "role" : 0 - } ] - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list_of_a_team_labeling_task_by_page.rst b/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list_of_a_team_labeling_task_by_page.rst deleted file mode 100644 index e54e7d9f..00000000 --- a/modelarts/api-ref/result/data_management/sample_management/querying_the_sample_list_of_a_team_labeling_task_by_page.rst +++ /dev/null @@ -1,603 +0,0 @@ -.. _ListWorkforceTaskSamples: - -Querying the Sample List of a Team Labeling Task by Page -======================================================== - -Function --------- - -This API is used to query the sample list of a team labeling task by page. - -URI ---- - -GET /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a team labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+=================+=====================================================================================================================================================================================================================================+ - | label_name | No | String | Label name. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | label_type | No | Integer | Labeling type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet | - | | | | | - | | | | - **200**: sound classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **400**: table dataset | - | | | | | - | | | | - **600**: video labeling | - | | | | | - | | | | - **900**: custom format | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The value ranges from 1 to 100. The default value is **10**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | locale | No | String | Language. The options are as follows: | - | | | | | - | | | | - **en-us**: English (default value) | - | | | | | - | | | | - **zh-cn**: Chinese | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. The default value is **0**. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | process_parameter | No | String | Image resizing setting, which is the same as the OBS resizing setting. For details, see . For example, **image/resize,m_lfit,h_200** indicates that the target image is resized proportionally and the height is set to 200 pixels. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sample_state | No | String | Sample status. The options are as follows: | - | | | | | - | | | | - **ALL**: labeled | - | | | | | - | | | | - **NONE**: unlabeled | - | | | | | - | | | | - **UNCHECK**: pending acceptance | - | | | | | - | | | | - **ACCEPTED**: accepted | - | | | | | - | | | | - **REJECTED**: rejected | - | | | | | - | | | | - **UNREVIEWED**: pending review | - | | | | | - | | | | - **REVIEWED**: reviewed | - | | | | | - | | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | | - | | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | | - | | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | | - | | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | | - | | | | - **AUTO_ANNOTATION**: to be confirmed | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_conditions | No | String | Multi-dimensional search condition after URL encoding. The relationship between multiple search conditions is AND. | - +-------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +--------------+----------------------------------------------------------------------------------------------------+--------------------+ - | Parameter | Type | Description | - +==============+====================================================================================================+====================+ - | sample_count | Integer | Number of samples. | - +--------------+----------------------------------------------------------------------------------------------------+--------------------+ - | samples | Array of :ref:`DescribeSampleResp ` objects | Sample list. | - +--------------+----------------------------------------------------------------------------------------------------+--------------------+ - -.. _listworkforcetasksamples__response_describesampleresp: - -.. table:: **Table 4** DescribeSampleResp - - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+======================================================================================+========================================================================================================================================+ - | check_accept | Boolean | Whether the acceptance is passed, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: The acceptance is passed. | - | | | | - | | | - **false**: The acceptance is not passed. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_comment | String | Acceptance comment, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | check_score | String | Acceptance score, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | deletion_reasons | Array of strings | Reason for deleting a sample, which is used for healthcare. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | hard_details | Map | Details about difficulties, including description, causes, and suggestions of difficult problems. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labelers | Array of :ref:`Worker ` objects | Labeling personnel list of sample assignment. The labelers record the team members to which the sample is allocated for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | labels | Array of :ref:`SampleLabel ` objects | Sample label list. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | metadata | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_accept | Boolean | Whether to accept the review, which is used for team labeling. The options are as follows: | - | | | | - | | | - **true**: accepted | - | | | | - | | | - **false**: rejected | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_comment | String | Review comment, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | review_score | String | Review score, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_data | Array of strings | Sample data list. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_dir | String | Sample path. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_id | String | Sample ID. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_name | String | Sample name. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_size | Long | Sample size or text length, in bytes. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_status | String | Sample status. The options are as follows: | - | | | | - | | | - **ALL**: labeled | - | | | | - | | | - **NONE**: unlabeled | - | | | | - | | | - **UNCHECK**: pending acceptance | - | | | | - | | | - **ACCEPTED**: accepted | - | | | | - | | | - **REJECTED**: rejected | - | | | | - | | | - **UNREVIEWED**: pending review | - | | | | - | | | - **REVIEWED**: reviewed | - | | | | - | | | - **WORKFORCE_SAMPLED**: sampled | - | | | | - | | | - **WORKFORCE_SAMPLED_UNCHECK**: sampling unchecked | - | | | | - | | | - **WORKFORCE_SAMPLED_CHECKED**: sampling checked | - | | | | - | | | - **WORKFORCE_SAMPLED_ACCEPTED**: sampling accepted | - | | | | - | | | - **WORKFORCE_SAMPLED_REJECTED**: sampling rejected | - | | | | - | | | - **AUTO_ANNOTATION**: to be confirmed | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_time | Long | Sample time, when OBS is last modified. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sample_type | Integer | Sample type. The options are as follows: | - | | | | - | | | - **0**: image | - | | | | - | | | - **1**: text | - | | | | - | | | - **2**: speech | - | | | | - | | | - **4**: table | - | | | | - | | | - **6**: video | - | | | | - | | | - **9**: custom format | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | score | String | Comprehensive score, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | source | String | Source address of sample data. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | sub_sample_url | String | Subsample URL, which is used for healthcare. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member, which is used for team labeling. | - +-----------------------+--------------------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 5** HardDetail - - ========== ======= ==================== - Parameter Type Description - ========== ======= ==================== - alo_name String Alias. - id Integer Reason ID. - reason String Reason description. - suggestion String Handling suggestion. - ========== ======= ==================== - -.. _listworkforcetasksamples__response_worker: - -.. table:: **Table 6** Worker - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | create_time | Long | Creation time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Labeling team member description. The value contains 0 to 256 characters and does not support the following special characters: ^!<>=&"' | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | email | String | Email address of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | role | Integer | Role. The options are as follows: | - | | | | - | | | - **0**: labeling personnel | - | | | | - | | | - **1**: reviewer | - | | | | - | | | - **2**: team administrator | - | | | | - | | | - **3**: dataset owner | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Current login status of a labeling team member. The options are as follows: | - | | | | - | | | - **0**: The invitation email has not been sent. | - | | | | - | | | - **1**: The invitation email has been sent but the user has not logged in. | - | | | | - | | | - **2**: The user has logged in. | - | | | | - | | | - **3**: The labeling team member has been deleted. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Long | Update time. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_id | String | ID of a labeling team member. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workforce_id | String | ID of a labeling team. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasksamples__response_samplelabel: - -.. table:: **Table 7** SampleLabel - - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================================+=======================================================================================================================================+ - | annotated_by | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | - | | | - **human**: manual labeling | - | | | | - | | | - **auto**: automatic labeling | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | String | Label ID. | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Label name. | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | Float | Confidence. | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | Integer | Label type. The options are as follows: | - | | | | - | | | - **0**: image classification | - | | | | - | | | - **1**: object detection | - | | | | - | | | - **100**: text classification | - | | | | - | | | - **101**: named entity recognition | - | | | | - | | | - **102**: text triplet relationship | - | | | | - | | | - **103**: text triplet entity | - | | | | - | | | - **200**: speech classification | - | | | | - | | | - **201**: speech content | - | | | | - | | | - **202**: speech paragraph labeling | - | | | | - | | | - **600**: video classification | - +-----------------------+--------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasksamples__response_samplelabelproperty: - -.. table:: **Table 8** SampleLabelProperty - - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | - | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | - | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | - | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | - | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | - | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | - | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | - | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | - | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | - | | | - **0/false**: not a hard example | - | | | | - | | | - **1/true**: hard example | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | - | | | - **bndbox**: rectangle | - | | | | - | | | - **polygon**: polygon | - | | | | - | | | - **circle**: circle | - | | | | - | | | - **line**: straight line | - | | | | - | | | - **dashed**: dotted line | - | | | | - | | | - **point**: point | - | | | | - | | | - **polyline**: polyline | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _listworkforcetasksamples__response_samplemetadata: - -.. table:: **Table 9** SampleMetadata - - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: non-hard sample | - | | | | - | | | - **1**: hard sample | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | - | | | - **0**: No target objects are identified. | - | | | | - | | | - **1**: The confidence is low. | - | | | | - | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | - | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | - | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | - | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | - | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | - | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | - | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | - | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | - | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | - | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | - | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | - | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | - | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | - | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | - | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | - | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | - | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | - | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | - | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | - | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | - | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | - | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying the Sample List of a Team Labeling Task by Page - -.. code-block:: - - GET https://{endpoint}/v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "sample_count" : 2, - "samples" : [ { - "sample_id" : "26c6dd793d80d3274eb89349ec76d678", - "sample_type" : 0, - "labels" : [ ], - "source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000016.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtCa6W_J4DxT0nYIfx...", - "metadata" : { - "@modelarts:import_origin" : 0, - "@modelarts:size" : [ 1242, 375, 3 ] - }, - "sample_time" : 1598263639997, - "sample_status" : "UN_ANNOTATION", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "afdda13895bc66322ffbf36ae833bcf0", - "role" : 0 - } ] - }, { - "sample_id" : "2971815bbb11a462161b48dddf19344f", - "sample_type" : 0, - "labels" : [ ], - "source" : "https://test-obs.obs.xxx.com:443/detect/data/dataset-car-and-person/IMG_kitti_0000_000011.png?AccessKeyId=P19W9X830R1Z39P5X5M5&Expires=1606300137&x-obs-security-token=gQpjbi1ub3J0aC03jKj8N6gtS4VsdTTW3QFoHMtpMoFLtC...", - "metadata" : { - "@modelarts:import_origin" : 0, - "@modelarts:size" : [ 1242, 375, 3 ] - }, - "sample_time" : 1598263639997, - "sample_status" : "UN_ANNOTATION", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "labelers" : [ { - "email" : "xxx@xxx.com", - "worker_id" : "305595e1901a526017d2e11f3ab0ffe1", - "role" : 0 - } ] - } ] - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/team_labeling_process_management/index.rst b/modelarts/api-ref/result/data_management/team_labeling_process_management/index.rst deleted file mode 100644 index a5a3cdf4..00000000 --- a/modelarts/api-ref/result/data_management/team_labeling_process_management/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _workforce_process_management: - -================================ -Team Labeling Process Management -================================ - -.. toctree:: - :maxdepth: 1 - - submitting_sample_review_comments_of_an_acceptance_task - reviewing_team_labeling_results - updating_labels_of_team_labeling_samples_in_batches diff --git a/modelarts/api-ref/result/data_management/team_labeling_process_management/reviewing_team_labeling_results.rst b/modelarts/api-ref/result/data_management/team_labeling_process_management/reviewing_team_labeling_results.rst deleted file mode 100644 index 49f0a99c..00000000 --- a/modelarts/api-ref/result/data_management/team_labeling_process_management/reviewing_team_labeling_results.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. _ReviewSamples: - -Reviewing Team Labeling Results -=============================== - -Function --------- - -This API is used to review team labeling results. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/review - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+------------------------------------------------------------------------------+----------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==============================================================================+======================+ - | comments | No | Array of :ref:`SampleComment ` objects | Review comment list. | - +-----------+-----------+------------------------------------------------------------------------------+----------------------+ - -.. _reviewsamples__request_samplecomment: - -.. table:: **Table 3** SampleComment - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================+ - | accept | Yes | Boolean | Whether the submitted sample review comments are passed. The options are as follows: | - | | | | | - | | | | - **true**: passed | - | | | | | - | | | | - **false**: not passed | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | comment | No | String | Review comment, which contains 0 to 256 characters, excluding special characters (!<>=&"'). | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | sample_id | No | String | Sample ID. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | score | No | String | Review score, whose value can be **A**, **B**, **C**, or **D**, in descending order. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Reviewing Team Labeling Results - -.. code-block:: - - { - "comments" : [ { - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "sample_id" : "0d43f9811d3808a3146c673257d4a1dbhh", - "accept" : true, - "comment" : "", - "score" : "A" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/team_labeling_process_management/submitting_sample_review_comments_of_an_acceptance_task.rst b/modelarts/api-ref/result/data_management/team_labeling_process_management/submitting_sample_review_comments_of_an_acceptance_task.rst deleted file mode 100644 index fae3e2f1..00000000 --- a/modelarts/api-ref/result/data_management/team_labeling_process_management/submitting_sample_review_comments_of_an_acceptance_task.rst +++ /dev/null @@ -1,109 +0,0 @@ -.. _AcceptSamples: - -Submitting Sample Review Comments of an Acceptance Task -======================================================= - -Function --------- - -This API is used to submit sample review comments of an acceptance task. - -URI ---- - -POST /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/acceptance/batch-comment - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+------------------------------------------------------------------------------+----------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+==============================================================================+======================+ - | comments | No | Array of :ref:`SampleComment ` objects | Review comment list. | - +-----------+-----------+------------------------------------------------------------------------------+----------------------+ - -.. _acceptsamples__request_samplecomment: - -.. table:: **Table 3** SampleComment - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================+ - | accept | Yes | Boolean | Whether the submitted sample review comments are passed. The options are as follows: | - | | | | | - | | | | - **true**: passed | - | | | | | - | | | | - **false**: not passed | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | comment | No | String | Review comment, which contains 0 to 256 characters, excluding special characters (!<>=&"'). | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | sample_id | No | String | Sample ID. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | score | No | String | Review score, whose value can be **A**, **B**, **C**, or **D**, in descending order. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -None - -Example Requests ----------------- - -Submitting Sample Review Comments of an Acceptance Task - -.. code-block:: - - { - "comments" : [ { - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "sample_id" : "09ac49d5b06385849c8769fdcf0f6d60", - "accept" : true, - "comment" : "", - "score" : "A" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/data_management/team_labeling_process_management/updating_labels_of_team_labeling_samples_in_batches.rst b/modelarts/api-ref/result/data_management/team_labeling_process_management/updating_labels_of_team_labeling_samples_in_batches.rst deleted file mode 100644 index cc57fd16..00000000 --- a/modelarts/api-ref/result/data_management/team_labeling_process_management/updating_labels_of_team_labeling_samples_in_batches.rst +++ /dev/null @@ -1,433 +0,0 @@ -.. _UpdateWorkforceTaskSamples: - -Updating Labels of Team Labeling Samples in Batches -=================================================== - -Function --------- - -This API is used to update labels of team labeling samples in batches. - -URI ---- - -PUT /v2/{project_id}/datasets/{dataset_id}/workforce-tasks/{workforce_task_id}/data-annotations/samples - -.. table:: **Table 1** Path parameters - - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+===========+========+====================================================================================================================+ - | dataset_id | Yes | String | Dataset ID. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workforce_task_id | Yes | String | ID of a labeling task. | - +-------------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========================================================================================+==========================================+ - | email | No | String | Email address of a labeling team member. | - +-----------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------+ - | samples | No | Array of :ref:`SampleLabels ` objects | Updated sample list. | - +-----------+-----------+-----------------------------------------------------------------------------------------+------------------------------------------+ - -.. _updateworkforcetasksamples__request_samplelabels: - -.. table:: **Table 3** SampleLabels - - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=======================================================================================+====================================================================================+ - | labels | No | Array of :ref:`SampleLabel ` objects | Sample label list. If this parameter is left blank, all sample labels are deleted. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | metadata | No | :ref:`SampleMetadata ` object | Key-value pair of the sample **metadata** attribute. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_id | No | String | Sample ID. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_type | No | Integer | Sample type. The options are as follows: | - | | | | | - | | | | - **0**: image | - | | | | | - | | | | - **1**: text | - | | | | | - | | | | - **2**: speech | - | | | | | - | | | | - **4**: table | - | | | | | - | | | | - **6**: video | - | | | | | - | | | | - **9**: custom format | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | sample_usage | No | String | Sample usage. The options are as follows: | - | | | | | - | | | | - **TRAIN**: training | - | | | | | - | | | | - **EVAL**: evaluation | - | | | | | - | | | | - **TEST**: test | - | | | | | - | | | | - **INFERENCE**: inference | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | source | No | String | Source address of sample data. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - | worker_id | No | String | ID of a labeling team member. | - +-----------------+-----------------+---------------------------------------------------------------------------------------+------------------------------------------------------------------------------------+ - -.. _updateworkforcetasksamples__request_samplelabel: - -.. table:: **Table 4** SampleLabel - - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=============================================================================================+=======================================================================================================================================+ - | annotated_by | No | String | Video labeling method, which is used to distinguish whether a video is labeled manually or automatically. The options are as follows: | - | | | | | - | | | | - **human**: manual labeling | - | | | | | - | | | | - **auto**: automatic labeling | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | String | Label ID. | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Label name. | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | :ref:`SampleLabelProperty ` object | Attribute key-value pair of the sample label, such as the object shape and shape feature. | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | score | No | Float | Confidence. | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | Integer | Label type. The options are as follows: | - | | | | | - | | | | - **0**: image classification | - | | | | | - | | | | - **1**: object detection | - | | | | | - | | | | - **100**: text classification | - | | | | | - | | | | - **101**: named entity recognition | - | | | | | - | | | | - **102**: text triplet relationship | - | | | | | - | | | | - **103**: text triplet entity | - | | | | | - | | | | - **200**: speech classification | - | | | | | - | | | | - **201**: speech content | - | | | | | - | | | | - **202**: speech paragraph labeling | - | | | | | - | | | | - **600**: video classification | - +-----------------+-----------------+---------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcetasksamples__request_samplelabelproperty: - -.. table:: **Table 5** SampleLabelProperty - - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+=================+===========================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:content | No | String | Speech text content, which is a default attribute dedicated to the speech label (including the speech content and speech start and end points). | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | No | Integer | End position of the text, which is a default attribute dedicated to the named entity label. The end position does not include the character corresponding to the value of **end_index**. Examples are as follows. | - | | | | | - | | | | - If the text content is "Barack Hussein Obama II (born August 4, 1961) is an American attorney and politician.", the **start_index** and **end_index** values of "Barack Hussein Obama II" are **0** and **23**, respectively. | - | | | | | - | | | | - If the text content is "By the end of 2018, the company has more than 100 employees.", the **start_index** and **end_index** values of "By the end of 2018" are **0** and **18**, respectively. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | No | String | Speech end time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:feature | No | Object | Shape feature, which is a default attribute dedicated to the object detection label, with type of **List**. The upper left corner of an image is used as the coordinate origin **[0,0]**. Each coordinate point is represented by *[x, y]*. *x* indicates the horizontal coordinate, and *y* indicates the vertical coordinate (both *x* and *y* are greater than or equal to 0). The format of each shape is as follows: | - | | | | | - | | | | - **bndbox**: consists of two points, for example, **[[0,10],[50,95]]**. The first point is located at the upper left corner of the rectangle and the second point is located at the lower right corner of the rectangle. That is, the X coordinate of the first point must be smaller than that of the second point, and the Y coordinate of the second point must be smaller than that of the first point. | - | | | | | - | | | | - **polygon**: consists of multiple points that are connected in sequence to form a polygon, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - | | | | | - | | | | - **circle**: consists of the center point and radius, for example, **[[100,100],[50]]**. | - | | | | | - | | | | - **line**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **dashed**: consists of two points, for example, **[[0,100],[50,95]]**. The first point is the start point, and the second point is the end point. | - | | | | | - | | | | - **point**: consists of one point, for example, **[[0,100]]**. | - | | | | | - | | | | - **polyline**: consists of multiple points, for example, **[[0,100],[50,95],[10,60],[500,400]]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | No | String | ID of the head entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard | No | String | Sample labeled as a hard sample or not, which is a default attribute. Options: | - | | | | | - | | | | - **0/false**: not a hard example | - | | | | | - | | | | - **1/true**: hard example | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | String | Coefficient of difficulty of each label level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | String | Reasons that the sample is a hard sample, which is a default attribute. Use a hyphen (-) to separate every two hard sample reason IDs, for example, **3-20-21-19**. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:shape | No | String | Object shape, which is a default attribute dedicated to the object detection label and is left empty by default. The options are as follows: | - | | | | | - | | | | - **bndbox**: rectangle | - | | | | | - | | | | - **polygon**: polygon | - | | | | | - | | | | - **circle**: circle | - | | | | | - | | | | - **line**: straight line | - | | | | | - | | | | - **dashed**: dotted line | - | | | | | - | | | | - **point**: point | - | | | | | - | | | | - **polyline**: polyline | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | No | String | Speech source, which is a default attribute dedicated to the speech start/end point label and can be set to a speaker or narrator. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_index | No | Integer | Start position of the text, which is a default attribute dedicated to the named entity label. The start value begins from 0, including the character corresponding to the value of **start_index**. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:start_time | No | String | Speech start time, which is a default attribute dedicated to the speech start/end point label, in the format of **hh:mm:ss.SSS**. (**hh** indicates hour; **mm** indicates minute; **ss** indicates second; and **SSS** indicates millisecond.) | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | No | String | ID of the tail entity in the triplet relationship label, which is a default attribute dedicated to the triplet relationship label. | - +-----------------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkforcetasksamples__request_samplemetadata: - -.. table:: **Table 6** SampleMetadata - - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============================+=================+===================+====================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | @modelarts:hard | No | Double | Whether the sample is labeled as a hard sample, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: non-hard sample | - | | | | | - | | | | - **1**: hard sample | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_coefficient | No | Double | Coefficient of difficulty of each sample level, which is a default attribute. The value range is **[0,1]**. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:hard_reasons | No | Array of integers | ID of a hard sample reason, which is a default attribute. The options are as follows: | - | | | | | - | | | | - **0**: No target objects are identified. | - | | | | | - | | | | - **1**: The confidence is low. | - | | | | | - | | | | - **2**: The clustering result based on the training dataset is inconsistent with the prediction result. | - | | | | | - | | | | - **3**: The prediction result is greatly different from the data of the same type in the training dataset. | - | | | | | - | | | | - **4**: The prediction results of multiple consecutive similar images are inconsistent. | - | | | | | - | | | | - **5**: There is a large offset between the image resolution and the feature distribution of the training dataset. | - | | | | | - | | | | - **6**: There is a large offset between the aspect ratio of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **7**: There is a large offset between the brightness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **8**: There is a large offset between the saturation of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **9**: There is a large offset between the color richness of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **10**: There is a large offset between the definition of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **11**: There is a large offset between the number of frames of the image and the feature distribution of the training dataset. | - | | | | | - | | | | - **12**: There is a large offset between the standard deviation of area of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **13**: There is a large offset between the aspect ratio of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **14**: There is a large offset between the area portion of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **15**: There is a large offset between the edge of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **16**: There is a large offset between the brightness of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **17**: There is a large offset between the definition of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **18**: There is a large offset between the stack of image frames and the feature distribution of the training dataset. | - | | | | | - | | | | - **19**: The data enhancement result based on GaussianBlur is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **20**: The data enhancement result based on fliplr is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **21**: The data enhancement result based on Crop is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **22**: The data enhancement result based on flipud is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **23**: The data enhancement result based on scale is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **24**: The data enhancement result based on translate is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **25**: The data enhancement result based on shear is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **26**: The data enhancement result based on superpixels is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **27**: The data enhancement result based on sharpen is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **28**: The data enhancement result based on add is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **29**: The data enhancement result based on invert is inconsistent with the prediction result of the original image. | - | | | | | - | | | | - **30**: The data is predicted to be abnormal. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:size | No | Array of objects | Image size (width, height, and depth of the image), which is a default attribute, with type of **List**. In the list, the first number indicates the width (pixels), the second number indicates the height (pixels), and the third number indicates the depth (the depth can be left blank and the default value is **3**). For example, **[100,200,3]** and **[100,200]** are both valid. Note: This parameter is mandatory only when the sample label list contains the object detection label. | - +-----------------------------+-----------------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 7** Response body parameters - - +-----------------------+--------------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+============================================================================================+==================================================================+ - | error_code | String | Error code. | - +-----------------------+--------------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+--------------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | results | Array of :ref:`BatchResponse ` objects | Response list for updating sample labels in batches. | - +-----------------------+--------------------------------------------------------------------------------------------+------------------------------------------------------------------+ - | success | Boolean | Whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: successful | - | | | | - | | | - **false**: failed | - +-----------------------+--------------------------------------------------------------------------------------------+------------------------------------------------------------------+ - -.. _updateworkforcetasksamples__response_batchresponse: - -.. table:: **Table 8** BatchResponse - - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================================+ - | error_code | String | Error code. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | error_msg | String | Error message. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - | success | Boolean | Check whether the operation is successful. The options are as follows: | - | | | | - | | | - **true**: The operation is successful. | - | | | | - | | | - **false**: The operation is failed. | - +-----------------------+-----------------------+------------------------------------------------------------------------+ - -Example Requests ----------------- - -Updating Labels of Team Labeling Samples in Batches - -.. code-block:: - - { - "samples" : [ { - "sample_id" : "0a0939d6d3c48a3d2a2619245943ac21", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "labels" : [ { - "name" : "tulips" - } ] - }, { - "sample_id" : "0e1b5a16a5a577ee53aeb34278a4b3e7", - "worker_id" : "8c15ad080d3eabad14037b4eb00d6a6f", - "labels" : [ { - "name" : "tulips" - } ] - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "success" : true - } - -Status Codes ------------- - -=========== ============ -Status Code Description -=========== ============ -200 OK -401 Unauthorized -403 Forbidden -404 Not Found -=========== ============ - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/devenviron/creating_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/creating_a_development_environment_instance.rst deleted file mode 100644 index 0a37125b..00000000 --- a/modelarts/api-ref/result/devenviron/creating_a_development_environment_instance.rst +++ /dev/null @@ -1,684 +0,0 @@ -.. _modelarts_03_0110: - -Creating a Development Environment Instance -=========================================== - -Function --------- - -This API is used to create a development environment instance for code development. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the API described in :ref:`Querying the Details About a Development Environment Instance `. - -URI ---- - -POST /v1/{project_id}/demanager/instances - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0110__en-us_topic_0136223949_table569625523811: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0110__en-us_topic_0136223949_table2542581515: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================+ - | name | Yes | String | Instance name, which contains a maximum of 64 characters. | - | | | | | - | | | | The value can contain letters, digits, hyphens (-), and underscores (_). | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | profile_id | Yes | String | Configuration ID. The options are as follows: | - | | | | | - | | | | - Ascend-Power-Engine 1.0(python3) | - | | | | - Multi-Engine 1.0 (python3)-cpu | - | | | | - Multi-Engine 1.0 (python3)-gpu | - | | | | - Multi-Engine 2.0 (python3) | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Instance description. The value contains a maximum of 512 characters and cannot contain the following special characters: &<>"'/. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | Yes | String | Instance flavor. The options are as follows: | - | | | | | - | | | | - modelarts.kat1.xlarge | - | | | | - modelarts.vm.cpu.2u | - | | | | - modelarts.vm.cpu.8u | - | | | | - modelarts.vm.gpu.v100 | - | | | | | - | | | | The preceding flavors are for reference only. The actual flavors depend on the region. If you need to use other flavors, contact the administrator to change the flavors. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec | Yes | Object | Instance definition. Only **Notebook** is supported. For example, see :ref:`Table 3 `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace | No | Object | Workspace. The default workspace ID is **0**. For details, see :ref:`Table 7 `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool | No | Object | Resource pool. For details, see :ref:`Table 8 `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | No | Object | AI project. For details, see :ref:`Table 10 `. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table1661540121718: - -.. table:: **Table 3** **notebook** parameters - - +----------------+-----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +================+===========+====================+===========================================================================================================================================================================================================================+ - | storage | Yes | Object | Storage path. For details, see :ref:`Table 4 `. | - +----------------+-----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_storage | No | Array | Extended storage list. For details, see :ref:`Table 4 `. Extended storage supports only **obsfs** and is available only for certain dedicated resource pools. | - +----------------+-----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_stop | No | Object | Auto stop parameter. For details, see :ref:`Table 6 `. | - +----------------+-----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotations | No | Map | Label information, which can be extended. By default, this parameter is left blank. | - +----------------+-----------+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table14531721311: - -.. table:: **Table 4** **storage** parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================================================================================+ - | type | Yes | String | Storage type. | - | | | | | - | | | | Only **obs** and **evs** are supported. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | location | No | Object | Storage location. If **type** is set to **obs**, this parameter is mandatory. See :ref:`Table 5 `. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table10263721145: - -.. table:: **Table 5** **location** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================================================+ - | path | No | String | Storage path | - | | | | | - | | | | - If **type** is set to **obs**, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table756291982911: - -.. table:: **Table 6** **auto_stop** parameters - - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+=================================================================================================================================================================================================================================================================================+ - | enable | No | Boolean | Whether to enable the auto stop function. The value **true** indicates that the function is enabled and the instance will automatically stop when the running duration is reached. The value **false** indicates that the function is disabled. The default value is **false**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | No | Integer | Running duration, in seconds. The value ranges from 3,600 to 86,400. After this parameter is set, it is valid for each startup. This parameter is mandatory when **enable** is set to **true**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | prompt | No | Boolean | Whether to display a prompt again. This parameter is provided for the console to determine whether to display a prompt again. The default value is **true**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table195831523711: - -.. table:: **Table 7** **workspace** parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=================================================================================================================================+ - | id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_request_poolspec: - -.. table:: **Table 8** **poolSpec** parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===========================================================================================================================+ - | id | Yes | String | Resource pool ID. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Resource pool type. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Resource pool name. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | owner | No | Object | Owner of the resource pool. For details, see :ref:`Table 9 `. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_request_userspec: - -.. table:: **Table 9** **userSpec** parameters - - +------------+-----------+--------+--------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+==================================================+ - | project_id | No | String | ID of the project to which the resource belongs. | - +------------+-----------+--------+--------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_request_aiproject: - -.. table:: **Table 10** **AIProject** parameters - - ========= ========= ====== ========================================== - Parameter Mandatory Type Description - ========= ========= ====== ========================================== - id No String AI project ID. This parameter is reserved. - ========= ========= ====== ========================================== - -Response Body -------------- - -:ref:`Table 11 ` describes the response parameters. - -.. _modelarts_03_0110__en-us_topic_0136223949_table1282791914324: - -.. table:: **Table 11** Parameters - - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+========+===================================================================================================================================================================================================================+ - | id | String | Instance ID | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Instance description | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | creation_timestamp | String | Time when an instance is created | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | latest_update_timestamp | String | Time when an instance is modified | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | profile | Object | Configuration information. For details, see :ref:`Table 12 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | For details about the flavor, see :ref:`Table 16 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool | Object | For details about the dedicated resource pool, see :ref:`Table 17 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Instance definition For details about parameters of a notebook instance, see :ref:`Table 19 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace | Object | Workspace. For details, see :ref:`Table 24 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | Object | AI project. For details, see :ref:`Table 25 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. For details, see :ref:`Error Codes `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | queuing_info | Object | Queuing information. For details, see :ref:`Table 26 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | Object | User information. For details, see :ref:`Table 27 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 28 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table14360146192514: - -.. table:: **Table 12** **profile** parameters - - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+=========================================================================================================================+ - | id | String | Configuration ID | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | name | String | Configuration name | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | description | String | Configuration description | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. Only **Notebook** is supported. | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | flavor_type | String | Hardware, which can be **CPU**, **GPU**, or **Ascend**. | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | provision | Object | Deployment information. For details, see :ref:`Table 13 `. | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - | labels | Map | Label | - +-------------+--------------------+-------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table108415111491: - -.. table:: **Table 13** **provision** parameters - - +-----------+--------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================================+ - | type | String | Deployment type. Only **Docker** is supported. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Deployment details. For details, see :ref:`Table 14 `. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table368911231548: - -.. table:: **Table 14** **spec** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+======================================================================================================================================================+ - | engine | String | Deployment engine. Only **CCE** is supported. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Deployment parameters. Only **Docker** is supported. For details, see :ref:`Table 15 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table932452015018: - -.. table:: **Table 15** Docker deployment parameters - - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+=====================================================================================+ - | namespace | String | SWR organization name, which is globally unique | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_name | String | Image name | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_tag | String | Image tag | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | annotations | Map | Label information, which can be extended. By default, this parameter is left blank. | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table15315195310273: - -.. table:: **Table 16** **flavor_details** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | name | String | Flavor name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | status | String | Flavor sale status The options are as follows: | - | | | | - | | | - **onSale** | - | | | - **soldOut** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queuing_num | Integer | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queue_left_time | Integer | Left queuing time, in seconds | - | | | | - | | | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | storage_list | Array | Supported storage type. The options are as follows: | - | | | | - | | | - **obs** | - | | | - **evs** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | is_permitted | Boolean | Whether the current user has the permission to use this flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | type | String | Flavor status. The options are as follows: | - | | | | - | | | - **GPU** | - | | | - **CPU** | - | | | - **ASCEND** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | params | Dict | Parameters that describing flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | promo_type | String | Promotion type. The options are as follows: | - | | | | - | | | - Free | - | | | - NoDiscount | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | instance_num | Integer | Number of instances of this flavor the current created | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | duration | Integer | Auto stop time after startup, in seconds | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | store_time | Integer | Maximum retention period of an inactive instance of this flavor in the database, in hours | - | | | | - | | | The default value is **-1**, indicating that the instance can be permanently saved. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_flavor | String | Billing specifications. If this field is left blank, the specifications name is used for billing. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_params | Integer | Billing ratio This parameter is mandatory when **billing_flavor** is specified. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table1757552712913: - -.. table:: **Table 17** **pool** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+========================================================================================================================================================================+ - | id | String | ID of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a resource pool. **USER_DEFINED** indicates a dedicated resource pool. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | Object | This parameter is mandatory when **type** is set to **USER_DEFINED**. For details, see :ref:`Table 18 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table1532233153818: - -.. table:: **Table 18** **owner** parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - project_id String Project ID - ========== ====== =========== - -.. _modelarts_03_0110__en-us_topic_0136223949_table8449155512217: - -.. table:: **Table 19** **notebook** parameters - - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===================================================================================================================================================================================================================+ - | log_path | String | Path for storing custom image logs | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_script_path | String | Path for storing custom initialization scripts used when a notebook instance is started | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | storage | Object | Storage path. For details, see :ref:`Table 20 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | AK and SK for accessing OBS. For details, see :ref:`Table 30 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 28 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_reserved_timestamp | Integer | Time when the resource is reserved | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_stop | Object | Auto stop parameter. For details, see :ref:`Table 23 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_reasons | Object | Cause for a creation or startup failure. For details, see :ref:`Table 22 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotations | Map | Annotations | - | | | | - | | | The generated URL cannot be directly accessed. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_params | Map | Extended parameter | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table9228954163219: - -.. table:: **Table 20** **storage** parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================================================================================================+ - | type | String | Storage type. | - | | | | - | | | Only **obs** and **evs** are supported. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | location | Object | Storage location. If **type** is set to **obs**, this parameter is mandatory. See :ref:`Table 21 `. By default, this parameter is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table212131963416: - -.. table:: **Table 21** **location** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================================================================+ - | path | String | Storage path | - | | | | - | | | - If **type** is set to **obs**, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_size | Integer | If **type** is set to **obs**, this parameter does not need to be set. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table72771614152013: - -.. table:: **Table 22** **failed_reasons** parameters - - ========= ================== ============= - Parameter Type Description - ========= ================== ============= - code String Error code. - message String Error message - detail Map Error details - ========= ================== ============= - -.. _modelarts_03_0110__en-us_topic_0136223949_table14279174582613: - -.. table:: **Table 23** **auto_stop** parameters - - +----------------+---------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=======================================================================================+ - | enable | Boolean | Whether to enable the auto stop function | - +----------------+---------+---------------------------------------------------------------------------------------+ - | duration | Integer | Running duration, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - | prompt | Boolean | Whether to display a prompt again. This parameter is provided for the console to use. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | stop_timestamp | Integer | Time when the instance stops. The value is a 13-digit timestamp. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | remain_time | Integer | Remaining time before actual stop, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table11410143081110: - -.. table:: **Table 24** **workspace** parameters - - ========= ====== ============ - Parameter Type Description - ========= ====== ============ - id String Workspace ID - ========= ====== ============ - -.. _modelarts_03_0110__en-us_topic_0136223949_response_aiproject: - -.. table:: **Table 25** **AIProject** parameters - - ========= ====== ============= - Parameter Type Description - ========= ====== ============= - id String AI project ID - ========= ====== ============= - -.. _modelarts_03_0110__en-us_topic_0136223949_table1535133818408: - -.. table:: **Table 26** **queuing_info** parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================+ - | id | String | Instance ID | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. By default, all types are returned. | - | | | | - | | | Only **Notebook** is supported. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor. By default, all types are returned. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details, which display the flavor information and whether the flavor is sold out For details, see :ref:`Table 16 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. By default, all statuses are returned, including: | - | | | | - | | | - **CREATE_QUEUING** | - | | | - **START_QUEUING** | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_timestamp | Integer | Time when an instance starts queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remain_time | Integer | Left queuing time, in seconds | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_timestamp | Integer | Time when an instance completes queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rank | Integer | Ranking of an instance in a queue | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table478950164319: - -.. table:: **Table 27** **user** parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String User ID - name String Username - ========= ====== =========== - -.. _modelarts_03_0110__en-us_topic_0136223949_table63971252184512: - -.. table:: **Table 28** **repository** parameters - - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================================================================+ - | id | String | Repository ID | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | branch | String | Repository branch | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | Repository username | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_email | String | Repository user mailbox | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Repository type. The options are **CodeClub** and **GitHub**. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | connection_info | Object | Repository link information. For details, see :ref:`Table 29 `. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table13487192116490: - -.. table:: **Table 29** **connection_info** parameters - - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+==========================================================================================================================+ - | protocol | String | Repository link protocol. The options are **ssh** and **https**. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | url | String | Repository link address | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | Certificate information. For details, see :ref:`Table 30 `. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0110__en-us_topic_0136223949_table970685216555: - -.. table:: **Table 30** **credential** parameters - - =============== ====== ======================= - Parameter Type Description - =============== ====== ======================= - ssh_private_key String SSH private certificate - access_token String OAuth token of GitHub - =============== ====== ======================= - -Samples -------- - -The following shows how to create the **notebook-instance** instance with ID **Python3-gpu**. - -- Sample request - - .. code-block:: - - { - "name": "notebook-instance", - "description": "", - "profile_id": "Multi-Engine 1.0 (python3)-gpu", - "flavor": "modelarts.bm.gpu.v100NV32", - "spec": { - "storage": { - "location": { - "volume_size": 5 - }, - "type": "evs" - }, - "auto_stop": { - "enable": true, - "duration": 3600 - } - }, - "workspace": { - "id": "0" - } - } - -- Successful sample response - - .. code-block:: - - { - "ai_project": { - "id": "default-ai-project" - }, - "creation_timestamp": "1594887749962", - "description": "", - "flavor": "modelarts.bm.gpu.v100NV32", - "flavor_details": { - "name": "modelarts.bm.gpu.v100NV32", - "params": { - "CPU": 8, - "GPU": 1, - "gpu_type": "v100NV32", - "memory": "64GiB" - }, - "status": "onSale", - "type": "GPU" - }, - "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033", - "latest_update_timestamp": "1594887749962", - "name": "notebook-c6fd", - "profile": { - "de_type": "Notebook", - "description": "multi engine, gpu, python 3.6 for notebook", - "flavor_type": "GPU", - "id": "Multi-Engine 1.0 (python3)-gpu", - "name": "Multi-Engine 1.0 (python3)-gpu", - "provision": { - "annotations": { - "category": "Multi-Engine 1.0", - - "type": "system" - }, - "spec": { - "engine": "CCE", - "params": { - "image_name": "mul-kernel-gpu-cuda-cp36", - "image_tag": "2.0.5-B003", - "namespace": "atelier" - } - }, - "type": "Docker" - } - }, - "spec": { - "annotations": { - "target_domain": "https://xxx", - "url": "" - }, - "auto_stop": { - "duration": 3600, - "enable": true, - "prompt": true - }, - "extend_params": null, - "failed_reasons": null, - "repository": null, - "extend_storage": null, - "storage": { - "location": { - "path": "/home/ma-user/work", - "volume_size": 5, - "volume_unit": "GB" - }, - "type": "evs" - } - }, - "status": "CREATING", - "user": { - "id": "15dda26361214ca2a5953917d2f48ffb", - "name": "ops_dev_env" - }, - "workspace": { - "id": "0" - } - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The param path needs to end with /.", - "error_code": "ModelArts.6318" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/deleting_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/deleting_a_development_environment_instance.rst deleted file mode 100644 index fb331627..00000000 --- a/modelarts/api-ref/result/devenviron/deleting_a_development_environment_instance.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _modelarts_03_0114: - -Deleting a Development Environment Instance -=========================================== - -Function --------- - -This API is used to delete a development environment instance. - -URI ---- - -DELETE /v1/{project_id}/demanager/instances/{instance_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0114__en-us_topic_0136223953_table569625523811: - -.. table:: **Table 1** Parameter description - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0114__en-us_topic_0136223953_table14581542113111: - -.. table:: **Table 2** Parameter description - - =========== ====== =========== - Parameter Type Description - =========== ====== =========== - instance_id String Instance ID - =========== ====== =========== - -Samples -------- - -The following shows how to delete instance **6fa459ea-ee8a-3ca4-894e-db77e160355e**. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/demanager/instances/6fa459ea-ee8a-3ca4-894e-db77e160355e - -- Successful sample response - - .. code-block:: - - { - "instance_id": "6fa459ea-ee8a-3ca4-894e-db77e160355e" - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The instance does not exist.", - "error_code": "ModelArts.6309" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/index.rst b/modelarts/api-ref/result/devenviron/index.rst deleted file mode 100644 index 0071bf04..00000000 --- a/modelarts/api-ref/result/devenviron/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _modelarts_03_0108: - -========== -DevEnviron -========== - -.. toctree:: - :maxdepth: 1 - - querying_the_authentication_information_of_a_development_environment_instance - creating_a_development_environment_instance - querying_a_list_of_development_environment_instances - querying_the_details_about_a_development_environment_instance - modifying_the_description_of_a_development_environment_instance - deleting_a_development_environment_instance - managing_a_development_environment_instance - restarting_an_ml_studio_instance diff --git a/modelarts/api-ref/result/devenviron/managing_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/managing_a_development_environment_instance.rst deleted file mode 100644 index 2ff9ad01..00000000 --- a/modelarts/api-ref/result/devenviron/managing_a_development_environment_instance.rst +++ /dev/null @@ -1,98 +0,0 @@ -.. _modelarts_03_0115: - -Managing a Development Environment Instance -=========================================== - -Function --------- - -This API is used to startor stop a notebook instance. - -URI ---- - -POST /v1/{project_id}/demanager/instances/{instance_id}/action - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0115__en-us_topic_0136223954_table569625523811: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0115__en-us_topic_0136223954_table46411941555: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==============================================================================+ - | action | Yes | String | Operation on a development environment instance. The options are as follows: | - | | | | | - | | | | - **start** | - | | | | - **stop** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0115__en-us_topic_0136223954_table14581542113111: - -.. table:: **Table 3** Parameters - - ============== ====== ============================== - Parameter Type Description - ============== ====== ============================== - current_status String Current status of an instance - previous_state String Previous status of an instance - ============== ====== ============================== - -Samples -------- - -The following shows how to start instance **6fa459ea-ee8a-3ca4-894e-db77e160355e**. - -- Sample request - - .. code-block:: - - { - "action": "start" - } - -- Successful sample response - - .. code-block:: - - { - "current_status": "STARTING", - "previous_state": "STOPPED" - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The instance does not exist.", - "error_code": "ModelArts.6309" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/modifying_the_description_of_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/modifying_the_description_of_a_development_environment_instance.rst deleted file mode 100644 index 9981023f..00000000 --- a/modelarts/api-ref/result/devenviron/modifying_the_description_of_a_development_environment_instance.rst +++ /dev/null @@ -1,528 +0,0 @@ -.. _modelarts_03_0113: - -Modifying the Description of a Development Environment Instance -=============================================================== - -Function --------- - -This API is used to modify the description of a development environment instance or information about the auto stop function. - -URI ---- - -PUT /v1/{project_id}/demanager/instances/{instance_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0113__en-us_topic_0136223952_table569625523811: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0113__en-us_topic_0136223952_table534718186518: - -.. table:: **Table 2** Parameters - - +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+========================================================================================================================================+ - | description | No | String | Configuration description. The value contains a maximum of 512 characters and cannot contain the following special characters: &<>"'/. | - +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - | spec | No | Object | Instance definition. For details, see :ref:`Table 3 `. | - +-------------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0113__en-us_topic_0136223952_table3175143201714: - -.. table:: **Table 3** **spec** parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=====================================================================================================================+ - | auto_stop | No | Object | Auto stop parameter. For details, see :ref:`Table 4 `. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0113__en-us_topic_0136223952_table756291982911: - -.. table:: **Table 4** **auto_stop** parameters - - +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+=============================================================================================================================================================================================================================================================================================================================+ - | enable | No | Boolean | Whether to enable the auto stop function. The value **true** indicates that the function is enabled and the instance will automatically stop when the running duration is reached. The value **false** indicates that the function is disabled. The default value is **false**. | - +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | No | Integer | Running duration, in seconds. The value ranges from 3,600 to 86,400. After this parameter is set, it is valid for each startup. This parameter is mandatory when **enable** is set to **true**. If the current instance status is **Running**, the modifications of this parameter take effect only after the next startup. | - +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | prompt | No | Boolean | Whether to display a prompt again. This parameter is provided for the console to determine whether to display a prompt again. The default value is **true**. | - +-----------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 5 ` describes the response parameters. - -.. _modelarts_03_0113__en-us_topic_0136223952_table1282791914324: - -.. table:: **Table 5** Parameters - - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+========+===================================================================================================================================================================================================================+ - | id | String | Instance ID | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Instance description | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | creation_timestamp | String | Time when an instance is created | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | latest_update_timestamp | String | Time when an instance is modified | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | profile | Object | Configuration information. For details, see :ref:`Table 12 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | For details about the flavor, see :ref:`Table 16 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool | Object | For details about the dedicated resource pool, see :ref:`Table 17 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Instance definition For details about parameters of a notebook instance, see :ref:`Table 19 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace | Object | Workspace. For details, see :ref:`Table 24 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | Object | AI project. For details, see :ref:`Table 25 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. For details, see :ref:`Error Codes `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | queuing_info | Object | Queuing information. For details, see :ref:`Table 26 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | Object | User information. For details, see :ref:`Table 27 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 28 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** **profile** parameters - - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+========================================================================================================================+ - | id | String | Configuration ID | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Configuration name | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Configuration description | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. Only **Notebook** is supported. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | provision | Object | Deployment information. For details, see :ref:`Table 4 `. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | labels | Map | Label information | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | flavor_type | String | Hardware, which can be **CPU**, **GPU**, or **Ascend**. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 7** **provision** parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================================+ - | type | String | Deployment type. Only **Docker** is supported. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Deployment details. For details, see :ref:`Table 8 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0113__en-us_topic_0136223952_table368911231548: - -.. table:: **Table 8** **spec** parameters - - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================================================================+ - | engine | String | Deployment engine. Only **CCE** is supported. | - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Deployment parameters. Only **Docker** is supported. For details, see :ref:`Table 9 `. | - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0113__en-us_topic_0136223952_table932452015018: - -.. table:: **Table 9** Docker deployment parameters - - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+=====================================================================================+ - | namespace | String | SWR organization name, which is globally unique | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_name | String | Image name | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_tag | String | Image tag | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | annotations | Map | Label information, which can be extended. By default, this parameter is left blank. | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - -.. table:: **Table 10** **flavor_details** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | name | String | Flavor name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | status | String | Flavor sale status The options are as follows: | - | | | | - | | | - **onSale** | - | | | - **soldOut** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queuing_num | Integer | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queue_left_time | Integer | Left queuing time, in seconds | - | | | | - | | | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | storage_list | Array | Supported storage type. The options are as follows: | - | | | | - | | | - **obs** | - | | | - **evs** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | is_permitted | Boolean | Whether the current user has the permission to use this flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | type | String | Flavor status. The options are as follows: | - | | | | - | | | - **GPU** | - | | | - **CPU** | - | | | - **ASCEND** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | params | Dict | Parameters that describing flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | promo_type | String | Promotion type. The options are as follows: | - | | | | - | | | - Free | - | | | - NoDiscount | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | instance_num | Integer | Number of instances of this flavor the current created | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | duration | Integer | Auto stop time after startup, in seconds | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | store_time | Integer | Maximum retention period of an inactive instance of this flavor in the database, in hours | - | | | | - | | | The default value is **-1**, indicating that the instance can be permanently saved. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_flavor | String | Billing specifications. If this field is left blank, the specifications name is used for billing. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_params | Integer | Billing ratio This parameter is mandatory when **billing_flavor** is specified. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 11** **pool** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+========================================================================================================================================================================+ - | id | String | ID of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a resource pool. **USER_DEFINED** indicates a dedicated resource pool. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | Object | This parameter is mandatory when **type** is set to **USER_DEFINED**. For details, see :ref:`Table 13 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 12** **AIProject** parameters - - ========= ====== ============== - Parameter Type Description - ========= ====== ============== - id String AI project ID. - ========= ====== ============== - -.. _modelarts_03_0113__en-us_topic_0136223952_table1532233153818: - -.. table:: **Table 13** **owner** parameters - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID - ========== ========= ====== =========== - -.. table:: **Table 14** **notebook** parameters - - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===================================================================================================================================================================================================================+ - | log_path | String | Path for storing custom image logs | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_script_path | String | Path for storing custom initialization scripts used when a notebook instance is started | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | storage | Object | Storage path. For details, see :ref:`Table 20 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | AK and SK for accessing OBS. For details, see :ref:`Table 30 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 28 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_reserved_timestamp | Integer | Time when the resource is reserved | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_stop | Object | Auto stop parameter. For details, see :ref:`Table 23 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_reasons | Object | Cause for a creation or startup failure. For details, see :ref:`Table 22 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotations | Map | Annotations | - | | | | - | | | The generated URL cannot be directly accessed. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_params | Map | Extended parameter | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 15** **storage** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+============================================================================================================================================================================================================+ - | type | String | Storage type. Only **obs** and **evs** are supported. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | location | Object | Storage location. If **type** is set to **obs**, this parameter is mandatory. See :ref:`Table 16 `. By default, this parameter is left blank. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0113__en-us_topic_0136223952_table212131963416: - -.. table:: **Table 16** **location** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================================================+ - | path | No | String | Storage path | - | | | | | - | | | | - If **type** is set to **obs**, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 17** **auto_stop** parameters - - +----------------+---------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=======================================================================================+ - | enable | Boolean | Whether to enable the auto stop function | - +----------------+---------+---------------------------------------------------------------------------------------+ - | duration | Integer | Running duration, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - | prompt | Boolean | Whether to display a prompt again. This parameter is provided for the console to use. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | stop_timestamp | Integer | Time when the instance stops. The value is a 13-digit timestamp. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | remain_time | Integer | Remaining time before actual stop, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - -.. table:: **Table 18** **failed_reasons** parameters - - ========= ================== ============= - Parameter Type Description - ========= ================== ============= - code String Error code - message String Error message - detail Map Error details - ========= ================== ============= - -.. table:: **Table 19** **workspace** parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+================================================================================================================================+ - | id | String | Workspace ID If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 20** **queuing_info** parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================+ - | id | String | Instance ID | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. By default, all types are returned. | - | | | | - | | | Only **Notebook** is supported. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor. By default, all types are returned. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details, which display the flavor information and whether the flavor is sold out For details, see :ref:`Table 16 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. By default, all statuses are returned, including: | - | | | | - | | | - **CREATE_QUEUING** | - | | | - **START_QUEUING** | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_timestamp | Integer | Time when an instance starts queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remain_time | Integer | Left queuing time, in seconds | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_timestamp | Integer | Time when an instance completes queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rank | Integer | Ranking of an instance in a queue | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 21** **user** parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String User ID - name String Username - ========= ====== =========== - -.. table:: **Table 22** **repository** parameters - - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================================================================+ - | id | String | Repository ID | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | branch | String | Repository branch | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | Repository username | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_email | String | Repository user mailbox | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Repository type. The options are **CodeClub** and **GitHub**. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | connection_info | Object | Repository link information. For details, see :ref:`Table 29 `. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 23** **connection_info** parameters - - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+==========================================================================================================================+ - | protocol | String | Repository link protocol. The options are **ssh** and **https**. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | url | String | Repository link address | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | Certificate information. For details, see :ref:`Table 30 `. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 24** **credential** parameters - - =============== ====== ======================= - Parameter Type Description - =============== ====== ======================= - ssh_private_key String SSH private certificate - access_token String OAuth token of GitHub - =============== ====== ======================= - -Samples -------- - -The following shows how to modify the details about instance **6fa459ea-ee8a-3ca4-894e-db77e160355e**. - -- Sample request - - .. code-block:: - - {"description":"This is for test."} - -- Successful sample response - - .. code-block:: - - { - "ai_project": { - "id": "default-ai-project" - }, - "creation_timestamp": "1594887749962", - "description": "update notebook", - "flavor": "modelarts.bm.gpu.v100NV32", - "flavor_details": { - "name": "modelarts.bm.gpu.v100NV32", - "params": { - "CPU": 8, - "GPU": 1, - "gpu_type": "v100NV32", - "memory": "64GiB" - }, - "status": "onSale", - "type": "GPU" - }, - "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033", - "latest_update_timestamp": "1594888143062", - "name": "notebook-c6fd", - "profile": { - "de_type": "Notebook", - "description": "multi engine, gpu, python 3.6 for notebook", - "flavor_type": "GPU", - "id": "Python3-gpu", - "name": "Python3", - "provision": { - "annotations": { - "category": "Multi-Engine (Recommend)", - "flavor": "modelarts.vm.gpu.p100", - "type": "system" - }, - "spec": { - "engine": "CCE", - "params": { - "annotations": null, - "image_name": "mul-kernel-gpu-cuda-cp36", - "image_tag": "2.0.5-B003", - "namespace": "atelier" - } - }, - "type": "Docker" - } - }, - "spec": { - "annotations": { - "target_domain": "https://xxx", - "url": "https://xxx/modelarts/hubv100/notebook/user/DE-7d558ef8-c73d-11ea-964c-0255ac100033" - }, - "auto_stop": { - "duration": 3600, - "enable": true, - "prompt": true, - "remain_time": 3266, - "stop_timestamp": 1594891408723 - }, - "extend_params": null, - "failed_reasons": null, - "repository": null, - "storage": { - "location": { - "path": "/home/ma-user/work", - "volume_size": 5, - "volume_unit": "GB" - }, - "type": "evs" - } - }, - "status": "RUNNING", - "user": { - "id": "15dda26361214ca2a5953917d2f48ffb", - "name": "ops_dev_env" - }, - "workspace": { - "id": "0" - } - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The instance does not exist.", - "error_code": "ModelArts.6309" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/querying_a_list_of_development_environment_instances.rst b/modelarts/api-ref/result/devenviron/querying_a_list_of_development_environment_instances.rst deleted file mode 100644 index 88a0c200..00000000 --- a/modelarts/api-ref/result/devenviron/querying_a_list_of_development_environment_instances.rst +++ /dev/null @@ -1,619 +0,0 @@ -.. _modelarts_03_0111: - -Querying a List of Development Environment Instances -==================================================== - -Function --------- - -This API is used to query the development environment instances that meet the search criteria. - -URI ---- - -GET /v1/{project_id}/demanager/instances?de_type={de_type}&provision_type={provision_type}&status={status}&sortby={sortby}&order={order}&offset={offset}&limit={limit} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0111__en-us_topic_0136223950_table569625523811: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0111__en-us_topic_0136223950_table92801116194411: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==========================================================================================================================================+ - | de_type | Yes | String | Development environment type. Only **Notebook** is supported. The first letter must be capitalized. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | provision_type | No | String | Deployment type. Only **Docker** is supported. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Instance status. By default, all statuses are returned. The options are as follows: | - | | | | | - | | | | - **CREATING**: The instance is being created. | - | | | | - **CREATE_FAILED**: The instance fails to be created. | - | | | | - **STARTING**: The instance is being started. | - | | | | - **RESTARTING**: The instance is being restarted. | - | | | | - **START_FAILED**: The instance fails to be started. | - | | | | - **RUNNING**: The instance is running. | - | | | | - **STOPPING**: The instance is being stopped. | - | | | | - **STOPPED**: The instance has been stopped. | - | | | | - **UNAVAILABLE**: The instance is unavailable. | - | | | | - **DELETED**: The instance has been deleted. | - | | | | - **RESIZING**: The instance specifications are being changed. | - | | | | - **RESIZE_FAILED**: The instance specifications fail to be changed. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | sortby | No | String | Classification standard. The value can be **name** or **creation_timestamp**. The default value is **name**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting mode. The value can be **asc** or **desc**. The default value is **asc**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start index. The default value is **0**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Number of returned result records. The value range is (0, ∞). The default value is **0**, which indicates that all results are returned. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | show_self | No | String | Only the user is displayed. The default value is **true**. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | No | String | AI project ID | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | No | String | ID of a dedicated resource pool. This parameter can be used to query information about all instances in a dedicated resource pool. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0111__en-us_topic_0136223950_table1282791914324: - -.. table:: **Table 3** Parameters - - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+======================================================================================================================+ - | total_count | Integer | Total number of development environments. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - | instances | Array | Configuration list. For details, see :ref:`Table 4 `. | - +-------------+---------+----------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table12784181511314: - -.. table:: **Table 4** **instances** parameters - - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+========+===================================================================================================================================================================================================================+ - | id | String | Instance ID | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Instance description | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | creation_timestamp | String | Time when an instance is created | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | profile | Object | Configuration information. For details, see :ref:`Table 5 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Instance definition. For details about parameters of a notebook instance, see :ref:`Table 13 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace | Object | Workspace. For details, see :ref:`Table 17 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | latest_update_timestamp | String | Time when an instance is modified | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details. For details, see :ref:`Table 9 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool | Object | Dedicated resource pool. For details, see :ref:`Table 10 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | Object | AI project. For details, see :ref:`Table 11 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. For details, see :ref:`Error Codes `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | queuing_info | Object | Queuing information. For details, see :ref:`Table 18 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | Object | User information. For details, see :ref:`Table 19 `. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 20 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-------------------------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table8786115121319: - -.. table:: **Table 5** **profile** parameters - - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+==========================================================================================================================+ - | id | String | Configuration ID | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | name | String | Configuration name | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | description | String | Configuration description | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. Only **Notebook** is supported. | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | provision | Object | Deployment information. For details, see :ref:`Table 6 `. | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | labels | Map | Label information, which can be extended | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - | flavor_type | String | Hardware, which can be **CPU**, **GPU**, or **Ascend**. | - +-------------+--------------------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table17787181516134: - -.. table:: **Table 6** **provision** parameters - - +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+======================================================================================================================+ - | type | String | Deployment type. Only **Docker** is supported. | - +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Deployment details. For details, see :ref:`Table 7 `. | - +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------+ - | annotations | Map | Label information, which can be extended. By default, this parameter is left blank. | - +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table12789111541310: - -.. table:: **Table 7** **spec** parameters - - +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================================================================+ - | engine | String | Deployment engine. Only **CCE** is supported. | - +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Deployment parameters. Only **Docker** is supported. For details, see :ref:`Table 8 `. | - +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table77908157134: - -.. table:: **Table 8** Docker deployment parameters - - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+=====================================================================================+ - | namespace | String | SWR organization name, which is globally unique | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_name | String | Image name | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_tag | String | Image tag | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | annotations | Map | Label information, which can be extended. By default, this parameter is left blank. | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table15315195310273: - -.. table:: **Table 9** **flavor_details** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | name | String | Flavor name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | status | String | Flavor sale status The options are as follows: | - | | | | - | | | - **onSale** | - | | | - **soldOut** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queuing_num | Integer | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queue_left_time | Integer | Left queuing time, in seconds | - | | | | - | | | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | storage_list | Array | Supported storage type. The options are **obs**, **evs**, and **efs**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | is_permitted | Boolean | Whether the current user has the permission to use this flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | type | String | Flavor status. The options are as follows: | - | | | | - | | | - **GPU** | - | | | - **CPU** | - | | | - **ASCEND** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | params | Dict | Parameters that describing flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | promo_type | String | Promotion type. The options are as follows: | - | | | | - | | | - **Free** | - | | | - **NoDiscount** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | instance_num | Integer | Number of instances of this flavor the current created | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | duration | Integer | Auto stop time after startup, in seconds | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | store_time | Integer | Maximum retention period of an inactive instance of this flavor in the database, in hours | - | | | | - | | | The default value is **-1**, indicating that the instance can be permanently saved. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_flavor | String | Billing specifications. If this field is left blank, the specifications name is used for billing. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_params | Integer | Billing ratio This parameter is mandatory when **billing_flavor** is specified. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table1757552712913: - -.. table:: **Table 10** **pool** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+========================================================================================================================================================================+ - | id | String | ID of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a resource pool. **USER_DEFINED** indicates a dedicated resource pool. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | Object | This parameter is mandatory when **type** is set to **USER_DEFINED**. For details, see :ref:`Table 12 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table4598102745311: - -.. table:: **Table 11** **AIProject** parameters - - ========= ====== ============= - Parameter Type Description - ========= ====== ============= - id String AI project ID - ========= ====== ============= - -.. _modelarts_03_0111__en-us_topic_0136223950_table1532233153818: - -.. table:: **Table 12** **owner** parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - project_id String Project ID - ========== ====== =========== - -.. _modelarts_03_0111__en-us_topic_0136223950_table8449155512217: - -.. table:: **Table 13** **notebook** parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================================+ - | auto_stop | Object | Auto stop parameter. For details, see :ref:`Table 16 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | annotations | Map | Annotations | - | | | | - | | | The generated URL cannot be directly accessed. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | failed_reasons | Object | Cause for a creation or startup failure. See :ref:`Table 15 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | extend_params | Map | Extended parameter | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 14** **location** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================================================================================================================+ - | path | No | String | Storage path. | - | | | | | - | | | | - If **type** is set to **obs**, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_size | No | Integer | If **type** is set to **obs**, this parameter does not need to be set. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table72771614152013: - -.. table:: **Table 15** **failed_reasons** parameters - - ========= ================== ============= - Parameter Type Description - ========= ================== ============= - code String Error code - message String Error message - detail Map Error details - ========= ================== ============= - -.. _modelarts_03_0111__en-us_topic_0136223950_table14279174582613: - -.. table:: **Table 16** **auto_stop** parameters - - +----------------+---------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=======================================================================================+ - | enable | Boolean | Whether to enable the auto stop function | - +----------------+---------+---------------------------------------------------------------------------------------+ - | duration | Integer | Running duration, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - | prompt | Boolean | Whether to display a prompt again. This parameter is provided for the console to use. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | stop_timestamp | Integer | Time when the instance stops. The value is a 13-digit timestamp. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | remain_time | Integer | Remaining time before actual stop, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table82085111012: - -.. table:: **Table 17** **workspace** parameters - - ========= ====== ============ - Parameter Type Description - ========= ====== ============ - id String Workspace ID - ========= ====== ============ - -.. _modelarts_03_0111__en-us_topic_0136223950_table1535133818408: - -.. table:: **Table 18** **queuing_info** parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | id | String | Instance ID | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. By default, all types are returned. | - | | | | - | | | Only **Notebook** is supported. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor. By default, all types are returned. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details, which display the flavor information and whether the flavor is sold out For details, see :ref:`Table 9 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. By default, all statuses are returned, including: | - | | | | - | | | - **CREATE_QUEUING** | - | | | - **START_QUEUING** | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_timestamp | Integer | Time when an instance starts queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remain_time | Integer | Left queuing time, in seconds | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_timestamp | Integer | Time when an instance completes queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rank | Integer | Ranking of an instance in a queue | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table478950164319: - -.. table:: **Table 19** **user** parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String User ID - name String Username - ========= ====== =========== - -.. _modelarts_03_0111__en-us_topic_0136223950_table63971252184512: - -.. table:: **Table 20** **repository** parameters - - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================================================================+ - | id | String | Repository ID | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | branch | String | Repository branch | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | Repository username | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_email | String | Repository user mailbox | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Repository type. The options are **CodeClub** and **GitHub**. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | connection_info | Object | Repository link information. For details, see :ref:`Table 21 `. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table13487192116490: - -.. table:: **Table 21** **connection_info** parameters - - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+==========================================================================================================================+ - | protocol | String | Repository link protocol. The options are **ssh** and **https**. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | url | String | Repository link address | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | Certificate information. For details, see :ref:`Table 22 `. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0111__en-us_topic_0136223950_table970685216555: - -.. table:: **Table 22** **credential** parameters - - =============== ====== ======================= - Parameter Type Description - =============== ====== ======================= - ssh_private_key String SSH private certificate - access_token String OAuth token of GitHub - =============== ====== ======================= - -Samples -------- - -The following shows how to query the list of Notebook development environments. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/demanager/instances?de_type=Notebook - -- Successful sample response - - .. code-block:: - - { - "instances": [ - { - "ai_project": { - "id": "default-ai-project" - }, - "creation_timestamp": "1594887749962", - "description": "", - "flavor": "modelarts.bm.gpu.v100NV32", - "flavor_details": { - "name": "modelarts.bm.gpu.v100NV32", - "params": { - "CPU": 8, - "GPU": 1, - "gpu_type": "v100NV32", - "memory": "64GiB" - }, - "status": "onSale", - "type": "GPU" - }, - "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033", - "latest_update_timestamp": "1594887749962", - "name": "notebook-c6fd", - "profile": { - "de_type": "Notebook", - "description": "multi engine, gpu, python 3.6 for notebook", - "flavor_type": "GPU", - "id": "Multi-Engine 1.0 (python3)-gpu", - "name": "Multi-Engine 1.0 (python3)-gpu", - "provision": { - "annotations": { - "category": "Multi-Engine 1.0 (python3)", - "type": "system" - }, - "spec": { - "engine": "CCE", - "params": { - "annotations": null, - "image_name": "mul-kernel-gpu-cuda-cp36", - "image_tag": "2.0.5-B003", - "namespace": "atelier" - } - }, - "type": "Docker" - } - }, - "spec": { - "annotations": { - "target_domain": "https://xxx", - "url": "https://xxx:32000/modelartshubv100/notebook/user/DE-7d558ef8-c73d-11ea-964c-0255ac100033" - }, - "auto_stop": { - "duration": 3600, - "enable": true, - "prompt": true, - "remain_time": 3450, - "stop_timestamp": 1594891408723 - }, - "extend_params": null, - "failed_reasons": null, - "repository": null, - "extend_storage": null, - "storage": { - "location": { - "path": "/home/ma-user/work", - "volume_size": 5, - "volume_unit": "GB" - }, - "type": "evs" - } - }, - "status": "RUNNING", - "user": { - "id": "15dda26361214ca2a5953917d2f48ffb", - "name": "ops_dev_env" - }, - "workspace": { - "id": "0" - } - }, - { - "ai_project": { - "id": "default-ai-project" - }, - "creation_timestamp": "1594883877728", - "description": "", - "flavor": "modelarts.vm.cpu.2u", - "flavor_details": { - "name": "modelarts.vm.cpu.2u", - "params": { - "CPU": 2, - "GPU": 0, - "memory": "8GiB" - }, - "status": "onSale", - "type": "CPU" - }, - "id": "DE-7936a360-c734-11ea-a72b-0255ac100033", - "latest_update_timestamp": "1594883877728", - "name": "notebook-b1b8", - "profile": { - "de_type": "Notebook", - "description": "multi engine, cpu, python 3.6 for notebook", - "flavor_type": "CPU", - "id": "Multi-Engine 1.0 (python3)-cpu", - "name": "Multi-Engine 1.0 (python3)-cpu", - "provision": { - "annotations": { - "category": "Multi-Engine 1.0 (Python3, Recommended)", - "type": "system" - }, - "spec": { - "engine": "CCE", - "params": { - "annotations": null, - "image_name": "mul-kernel-cpu-cp36", - "image_tag": "2.0.5-B003", - "namespace": "atelier" - } - }, - "type": "Docker" - } - }, - "spec": { - "annotations": { - "target_domain": "https://xxx", - "url": "" - }, - "auto_stop": { - "duration": 3600, - "enable": true, - "prompt": true - }, - "extend_params": null, - "failed_reasons": null, - "repository": null, - "storage": { - "location": { - "path": "/home/ma-user/work", - "volume_size": 5, - "volume_unit": "GB" - }, - "type": "evs" - } - }, - "status": "STOPPED", - "user": { - "id": "15dda26361214ca2a5953917d2f48ffb", - "name": "ops_dev_env" - }, - "workspace": { - "id": "0" - } - }], - "total_count": 2 - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/querying_the_authentication_information_of_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/querying_the_authentication_information_of_a_development_environment_instance.rst deleted file mode 100644 index 92c4a750..00000000 --- a/modelarts/api-ref/result/devenviron/querying_the_authentication_information_of_a_development_environment_instance.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _modelarts_03_0109: - -Querying the Authentication Information of a Development Environment Instance -============================================================================= - -Function --------- - -This API is used to query the authentication information of a development environment instance, which is used to open the development environment instance. - -URI ---- - -GET /v1/{project_id}/demanager/instances/{instance_id}/token - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0109__en-us_topic_0136223948_table569625523811: - -.. table:: **Table 1** Parameter description - - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+===============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | project_id | Yes | String | Project ID | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID It is the ID of the development environment instance you create. The instance ID is contained in the response code after the instance has been created. For details, see :ref:`Creating a Development Environment Instance `. If the development environment instance is created on the ModelArts management console, you can view the ID of the instance on the ModelArts management console. | - +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0109__en-us_topic_0136223948_table973120224596: - -.. table:: **Table 2** Parameter description - - ========= ====== ==================== - Parameter Type Description - ========= ====== ==================== - token String Authentication token - ========= ====== ==================== - -Samples -------- - -The following shows how to obtain the authentication token of instance **6fa459ea-ee8a-3ca4-894e-db77e160355e**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/demanager/instances/6fa459ea-ee8a-3ca4-894e-db77e160355e/token - -- Successful sample response - - .. code-block:: - - { - "token": "7211546f57cd432790643bb6612da19d" - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The instance does not exist.", - "error_code": "ModelArts.6309" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/querying_the_details_about_a_development_environment_instance.rst b/modelarts/api-ref/result/devenviron/querying_the_details_about_a_development_environment_instance.rst deleted file mode 100644 index e4388b14..00000000 --- a/modelarts/api-ref/result/devenviron/querying_the_details_about_a_development_environment_instance.rst +++ /dev/null @@ -1,507 +0,0 @@ -.. _modelarts_03_0112: - -Querying the Details About a Development Environment Instance -============================================================= - -Function --------- - -This API is used to query the details about a development environment instance. - -URI ---- - -GET /v1/{project_id}/demanager/instances/{instance_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0112__en-us_topic_0136223951_table569625523811: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0112__en-us_topic_0136223951_table1282791914324: - -.. table:: **Table 2** Parameters - - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+========+==================================================================================================================================================+ - | id | String | Instance ID | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Instance description | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | creation_timestamp | String | Time when an instance is created | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | profile | Object | Configuration information. For details, see :ref:`Table 3 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Instance specifications of the notebook type. For details, see :ref:`Table 11 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace | Object | Workspace. For details, see :ref:`Table 16 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | latest_update_timestamp | String | Time when an instance is modified | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details. See :ref:`Table 7 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool | Object | Dedicated resource pool. See :ref:`Table 8 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | ai_project | Object | AI project. For details, see :ref:`Table 9 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code. For details, see :ref:`Error Codes `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | queuing_info | Object | Queuing information. For details, see :ref:`Table 17 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | Object | User information. For details, see :ref:`Table 18 `. | - +-------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table91791695387: - -.. table:: **Table 3** **profile** parameters - - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+========================================================================================================================+ - | id | String | Configuration ID | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | name | String | Configuration name | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | description | String | Configuration description | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. Only **Notebook** is supported. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | provision | Object | Deployment information. For details, see :ref:`Table 4 `. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | labels | Map | Label information | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - | flavor_type | String | Hardware, which can be **CPU**, **GPU**, or **Ascend**. | - +-------------+--------------------+------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table108415111491: - -.. table:: **Table 4** **provision** parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+====================================================================================================================+ - | type | String | Deployment type. Only **Docker** is supported. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | spec | Object | Deployment details. For details, see :ref:`Table 5 `. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table368911231548: - -.. table:: **Table 5** **spec** parameters - - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+=====================================================================================================================================================+ - | engine | String | Deployment engine. Only **CCE** is supported. | - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | params | Object | Deployment parameters. Only **Docker** is supported. For details, see :ref:`Table 6 `. | - +-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table932452015018: - -.. table:: **Table 6** Docker deployment parameters - - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+====================+=====================================================================================+ - | namespace | String | SWR organization name, which is globally unique | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_name | String | Image name | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | image_tag | String | Image tag | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - | annotations | Map | Label information, which can be extended. By default, this parameter is left blank. | - +-------------+--------------------+-------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table15315195310273: - -.. table:: **Table 7** **flavor_details** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================+ - | name | String | Flavor name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | status | String | Flavor sale status The options are as follows: | - | | | | - | | | - **onSale** | - | | | - **soldOut** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queuing_num | Integer | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | queue_left_time | Integer | Left queuing time, in seconds | - | | | | - | | | This parameter is mandatory when **promo_type** is set to **Free** and **status** is set to **soldOut**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | storage_list | Array | Supported storage type. The options are **obs**, **evs**, and **efs**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | is_permitted | Boolean | Whether the current user has the permission to use this flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | type | String | Flavor status. The options are as follows: | - | | | | - | | | - **GPU** | - | | | - **CPU** | - | | | - **ASCEND** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | params | Dict | Parameters that describing flavor | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | promo_type | String | Promotion type. The options are as follows: | - | | | | - | | | - **Free** | - | | | - **NoDiscount** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | instance_num | Integer | Number of instances of this flavor the current created | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | duration | Integer | Auto stop time after startup, in seconds | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | store_time | Integer | Maximum retention period of an inactive instance of this flavor in the database, in hours | - | | | | - | | | The default value is **-1**, indicating that the instance can be permanently saved. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_flavor | String | Billing specifications. If this field is left blank, the specifications name is used for billing. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - | billing_params | Integer | Billing ratio This parameter is mandatory when **billing_flavor** is specified. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table1757552712913: - -.. table:: **Table 8** **pool** parameters - - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+========================================================================================================================================================================+ - | id | String | ID of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Name of a resource pool | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Type of a resource pool. **USER_DEFINED** indicates a dedicated resource pool. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | Object | This parameter is mandatory when **type** is set to **USER_DEFINED**. For details, see :ref:`Table 10 `. | - +-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_response_aiproject: - -.. table:: **Table 9** **AIProject** parameters - - ========= ====== ============= - Parameter Type Description - ========= ====== ============= - id String AI project ID - ========= ====== ============= - -.. _modelarts_03_0112__en-us_topic_0136223951_table1532233153818: - -.. table:: **Table 10** **owner** parameters - - ========== ====== =========== - Parameter Type Description - ========== ====== =========== - project_id String Project ID - ========== ====== =========== - -.. _modelarts_03_0112__en-us_topic_0136223951_table115411254165418: - -.. table:: **Table 11** **notebook** parameters - - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===================================================================================================================================================================================================================+ - | log_path | String | Path for storing custom image logs | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_script_path | String | Path for storing custom initialization scripts used when a notebook instance is started | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | storage | Object | Storage path. For details, see :ref:`Table 20 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | AK and SK for accessing OBS. For details, see :ref:`Table 30 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | repository | Object | Git repository information. For details, see :ref:`Table 28 `. This parameter cannot be used. It is automatically returned when the API is called. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_reserved_timestamp | Integer | Time when the resource is reserved | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auto_stop | Object | Auto stop parameter. For details, see :ref:`Table 23 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_reasons | Object | Cause for a creation or startup failure. For details, see :ref:`Table 22 `. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotations | Map | Annotations | - | | | | - | | | The generated URL cannot be directly accessed. | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_params | Map | Extended parameter | - +-----------------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 12** **storage** parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================================================================================================+ - | type | String | Storage type. | - | | | | - | | | Only **obs** and **evs** are supported. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | location | Object | Storage location. If **type** is set to **obs**, this parameter is mandatory. See :ref:`Table 21 `. By default, this parameter is left blank. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 13** **location** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================================================================================================================================+ - | path | String | Storage path | - | | | | - | | | - If **type** is set to **obs**, this parameter is mandatory. The value must be a valid OBS bucket path and end with a slash (/). The value must be a specific directory in an OBS bucket rather than the root directory of an OBS bucket. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volume_size | Integer | If **type** is set to **obs**, this parameter does not need to be set. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 14** **auto_stop** parameters - - +----------------+---------+---------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+=======================================================================================+ - | enable | Boolean | Whether to enable the auto stop function | - +----------------+---------+---------------------------------------------------------------------------------------+ - | duration | Integer | Running duration, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - | prompt | Boolean | Whether to display a prompt again. This parameter is provided for the console to use. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | stop_timestamp | Integer | Time when the instance stops. The value is a 13-digit timestamp. | - +----------------+---------+---------------------------------------------------------------------------------------+ - | remain_time | Integer | Remaining time before actual stop, in seconds | - +----------------+---------+---------------------------------------------------------------------------------------+ - -.. table:: **Table 15** **failed_reasons** parameters - - ========= ================== ============= - Parameter Type Description - ========= ================== ============= - code String Error code - message String Error message - detail Map Error details - ========= ================== ============= - -.. _modelarts_03_0112__en-us_topic_0136223951_table82085111012: - -.. table:: **Table 16** **workspace** parameters - - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+================================================================================================================================+ - | id | String | Workspace ID If no workspace is created, the default value is **0**. If a workspace is created and used, use the actual value. | - +-----------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table1535133818408: - -.. table:: **Table 17** **queuing_info** parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================================================================================================================+ - | id | String | Instance ID | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Instance name | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | de_type | String | Development environment type. By default, all types are returned. | - | | | | - | | | Only **Notebook** is supported. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | String | Instance flavor. By default, all types are returned. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor_details | Object | Flavor details, which display the flavor information and whether the flavor is sold out For details, see :ref:`Table 16 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Instance status. By default, all statuses are returned, including: | - | | | | - | | | - **CREATE_QUEUING** | - | | | - **START_QUEUING** | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | begin_timestamp | Integer | Time when an instance starts queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | remain_time | Integer | Left queuing time, in seconds | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | end_timestamp | Integer | Time when an instance completes queuing. The value is a 13-digit timestamp. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | rank | Integer | Ranking of an instance in a queue | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0112__en-us_topic_0136223951_table478950164319: - -.. table:: **Table 18** **user** parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - id String User ID - name String Username - ========= ====== =========== - -.. table:: **Table 19** **repository** parameters - - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================================================================+ - | id | String | Repository ID | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | branch | String | Repository branch | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | Repository username | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | user_email | String | Repository user mailbox | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | type | String | Repository type. The options are **CodeClub** and **GitHub**. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - | connection_info | Object | Repository link information. For details, see :ref:`Table 29 `. | - +-----------------+--------+--------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 20** **connection_info** parameters - - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+==========================================================================================================================+ - | protocol | String | Repository link protocol. The options are **ssh** and **https**. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | url | String | Repository link address | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | credential | Object | Certificate information. For details, see :ref:`Table 30 `. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 21** **credential** parameters - - =============== ====== ======================= - Parameter Type Description - =============== ====== ======================= - ssh_private_key String SSH private certificate - access_token String OAuth token of GitHub - =============== ====== ======================= - -Samples -------- - -The following shows how to obtain the details about instance **6fa459ea-ee8a-3ca4-894e-db77e160355e**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/demanager/instances/6fa459ea-ee8a-3ca4-894e-db77e160355e - -- Successful sample response - - .. code-block:: - - { - "ai_project": { - "id": "default-ai-project" - }, - "creation_timestamp": "1594887749962", - "description": "", - "flavor": "modelarts.bm.gpu.v100NV32", - "flavor_details": { - "name": "modelarts.bm.gpu.v100NV32", - "params": { - "CPU": 8, - "GPU": 1, - "gpu_type": "v100NV32", - "memory": "64GiB" - }, - "status": "onSale", - "type": "GPU" - }, - "id": "DE-7d558ef8-c73d-11ea-964c-0255ac100033", - "latest_update_timestamp": "1594888070775", - "name": "notebook-c6fd", - "profile": { - "de_type": "Notebook", - "description": "multi engine, gpu, python 3.6 for notebook", - "flavor_type": "GPU", - "id": "Multi-Engine 1.0 (python3)-gpu", - "name": "Multi-Engine 1.0 (python3)-gpu", - "provision": { - "annotations": { - "category": "Multi-Engine 1.0 (python3)", - "type": "system" - }, - "spec": { - "engine": "CCE", - "params": { - "annotations": null, - "image_name": "mul-kernel-gpu-cuda-cp36", - "image_tag": "2.0.5-B003", - "namespace": "atelier" - } - }, - "type": "Docker" - } - }, - "spec": { - "annotations": { - "target_domain": "https://xxx", - "url": "https://xxx:32000/modelarts/hubv100/notebook/user/DE-7d558ef8-c73d-11ea-964c-0255ac100033" - }, - "auto_stop": { - "duration": 3600, - "enable": true, - "prompt": true, - "remain_time": 3336, - "stop_timestamp": 1594891408723 - }, - "extend_params": null, - "failed_reasons": null, - "repository": null, - "extend_storage": null, - "storage": { - "location": { - "path": "/home/ma-user/work", - "volume_size": 5, - "volume_unit": "GB" - }, - "type": "evs" - } - }, - "status": "RUNNING", - "user": { - "id": "15dda26361214ca2a5953917d2f48ffb", - "name": "ops_dev_env" - }, - "workspace": { - "id": "0" - } - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "The instance does not exist.", - "error_code": "ModelArts.6309" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/devenviron/restarting_an_ml_studio_instance.rst b/modelarts/api-ref/result/devenviron/restarting_an_ml_studio_instance.rst deleted file mode 100644 index c4a139d4..00000000 --- a/modelarts/api-ref/result/devenviron/restarting_an_ml_studio_instance.rst +++ /dev/null @@ -1,86 +0,0 @@ -.. _modelarts_03_0152: - -Restarting an ML Studio Instance -================================ - -Function --------- - -This API is used to restart an ML Studio development environment instance. - -URI ---- - -POST /v1/{project_id}/demanager/instances/{instance_id}/action - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0152__en-us_topic_0181453353_table569625523811: - -.. table:: **Table 1** Parameter description - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_id | Yes | String | Instance ID | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0152__en-us_topic_0181453353_table46411941555: - -.. table:: **Table 2** Parameter description - - +-----------+-----------+--------+--------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+================================================================================+ - | action | Yes | String | Operation on a development environment instance. The value can be **restart**. | - +-----------+-----------+--------+--------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0152__en-us_topic_0181453353_table1399617427385: - -.. table:: **Table 3** Parameter description - - ============== ====== ============================== - Parameter Type Description - ============== ====== ============================== - current_status String Current status of an instance - previous_state String Previous status of an instance - ============== ====== ============================== - -Samples -------- - -The following shows how to restart the ML Studio instance whose ID is **47cf4ff3-0c59-44fe-9821-2840a34c02a9**. - -- Sample request - - .. code-block:: - - { - "action": "restart" - } - -- Sample response - - .. code-block:: - - { - "current_status": "REBOOTING", - "previous_state": "ACTIVE" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/index.rst b/modelarts/api-ref/result/index.rst deleted file mode 100644 index d6470aca..00000000 --- a/modelarts/api-ref/result/index.rst +++ /dev/null @@ -1,20 +0,0 @@ -========== -Main Index -========== - -.. toctree:: - :maxdepth: 1 - - before_you_start/index - api_overview - calling_apis/index - devenviron/index - data_management/index - training_management/index - model_management/index - service_management/index - authorization_management/index - workspace_management/index - application_cases/index - common_parameters/index - change_history diff --git a/modelarts/api-ref/result/model_management/index.rst b/modelarts/api-ref/result/model_management/index.rst deleted file mode 100644 index 40f62f48..00000000 --- a/modelarts/api-ref/result/model_management/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_03_0075: - -================ -Model Management -================ - -.. toctree:: - :maxdepth: 1 - - models/index diff --git a/modelarts/api-ref/result/model_management/models/deleting_a_model.rst b/modelarts/api-ref/result/model_management/models/deleting_a_model.rst deleted file mode 100644 index c03c8278..00000000 --- a/modelarts/api-ref/result/model_management/models/deleting_a_model.rst +++ /dev/null @@ -1,100 +0,0 @@ -.. _modelarts_03_0079: - -Deleting a Model -================ - -Function --------- - -This API is used to delete a model based on the model ID. When **cascade** is set to **true**, the model specified by the model ID and models of different versions with the same name as the specified model are deleted. By default, only the model with the specified model ID is deleted. - -URI ---- - -DELETE /v1/{project_id}/models/{model_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0079__en-us_topic_0130168819_table16518993181628: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | model_id | Yes | String | ID of the model to be deleted | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameter description - - +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+================================================================================================================================================================================================================================================================================================================================================+ - | cascade | No | Boolean | The default value is **false**, indicating that only the model with the specified model ID is deleted. The value **true** indicates that not only the model with the specified model ID but also all models with the same name but different versions as the specified model will be deleted. A maximum of 20 models can be deleted at a time. | - +-----------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0079__en-us_topic_0130168819_table1954662185412: - -.. table:: **Table 3** Parameter description - - +---------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+=================================+=========================================================================================================================================+ - | delete_success_list | String array | ID list of models successfully deleted | - +---------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | delete_failed_list | **DeleteModelFailResult** array | List of models that fail to be deleted. For details, see :ref:`Table 4 `. | - +---------------------+---------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0079__en-us_topic_0130168819_table1198992710540: - -.. table:: **Table 4** **DeleteModelFailResult** parameters - - ============= ====== ====================================== - Parameter Type Description - ============= ====== ====================================== - model_id String ID of a model that fails to be deleted - error_code String Error code of the deletion failure - error_message String Error message of the deletion failure - ============= ====== ====================================== - -Samples -------- - -The following shows how to delete the model whose ID is **023e90be-7e2a-4169-bab4-1bc34ff0ca45** and all models of the same name but different versions. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/models/023e90be-7e2a-4169-bab4-1bc34ff0ca45?cascade=true - -- Sample response - - .. code-block:: - - { - "delete_success_list": ["fc9e88a1-0005-40b3-867e-7aee61449aeb", "f3f3ba0e-f073-454e-9e3f-14b7d786f45e"], - "delete_failed_list": [ - { - "model_id": "759645d9-3672-4db1-bb6d-49ed58b84e10", - "error_code": "ModelArts.3009", - "error_message": "Failed to delete model, model (759645d9-3672-4db1-bb6d-49ed58b84e10) already deploy service." - }] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/model_management/models/importing_a_model.rst b/modelarts/api-ref/result/model_management/models/importing_a_model.rst deleted file mode 100644 index 451bb469..00000000 --- a/modelarts/api-ref/result/model_management/models/importing_a_model.rst +++ /dev/null @@ -1,331 +0,0 @@ -.. _modelarts_03_0076: - -Importing a Model -================= - -Function --------- - -You can use the API to import a model. - -Ensure that the execution code and model have been uploaded to OBS. By default, the models generated by a training job are stored in OBS. - -URI ---- - -POST /v1/{project_id}/models - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0076__en-us_topic_0130147365_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0076__en-us_topic_0130147365_table24514577587: - -.. table:: **Table 2** Parameters - - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+===========+======================+=================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | model_name | Yes | String | Model name. Enter 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | Yes | String | Model version in the format of *Digit.Digit.Digit*. The value range of the digits is [1, 99]. Note that no part of the version number can start with 0. For example, **01.01.01** is not allowed. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_location | Yes | String | OBS path where the model is located or the SWR image location | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_job_id | No | String | ID of the source training job. If the model is generated from a training job, input this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_job_version | No | String | Version of the source training job. If the model is generated from a training job, input this parameter for source tracing. If the model is imported from a third-party meta model, leave this parameter blank. By default, this parameter is left blank. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | No | String | Model source type. The value can only be **auto**, which indicates ExeML models (model download is not supported). If a model is deployed through a training job, this parameter is left blank by default. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_type | Yes | String | Model type. The value can be **TensorFlow**, **MXNet**, **Caffe**, **Spark_MLlib**, **Scikit_Learn**, **XGBoost**, **Image**, **PyTorch**, or **Template**, which is read from the configuration file. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | runtime | No | String | For details about **runtime** options, see **Model Management** > **Importing a Model** > **Importing a Meta Model from OBS** in *ModelArts User Guide*. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Model remarks. The value contains a maximum of 100 characters and cannot contain the following special characters and more: &!'\"<>= | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_algorithm | No | String | Model algorithm. If the algorithm is read from the configuration file, this parameter can be left blank. For example, the value can be **predict_analysis**, **object_detection**, or **image_classification**. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters (&!'\"<>=) are not allowed. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | execution_code | No | String | OBS path for storing the execution code. By default, this parameter is left blank. The name of the execution code file is fixed to **customize_service.py**. The inference code file must be stored in the **model** directory. If this parameter is left blank, the system can automatically identify the inference code in the **model** directory. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | input_params | No | **params** array | Collection of input parameters of a model. By default, this parameter is left blank. For details, see :ref:`Table 3 `. If the collection of input parameters is read from **apis** in the configuration file, you only need to provide the **initial_config** field and do not need to set **input_params**. **input_params** is optional when the **initial_config** field exists. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_params | No | **params** array | Collection of output parameters of a model. By default, this parameter is left blank. For details, see :ref:`Table 3 `. If the collection of output parameters is read from **apis** in the configuration file, you only need to provide the **initial_config** field and do not need to set **output_params**. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dependencies | No | **dependency** array | Package required for inference code and model. By default, this parameter is left blank. If the package is read from the configuration file, this parameter can be left blank. :ref:`Table 4 ` shows the dependency structure. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_metrics | No | String | Model precision, which is read from the configuration file | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | apis | No | **apis** array | All **apis** input and output parameters of the model. If the parameters are read from the configuration file, this parameter can be left blank. For details, see :ref:`Table 10 `. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | initial_config | No | String | Character string converted from the final model configuration file. It is recommended that the **initial_config** file be used to provide information about the fields such as **apis**, **dependencies**, **input_params**, and **output_params**. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | ID of the workspace to which a service belongs. The default value is **0**, indicating the default workspace. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_docs | No | **doc** array | List of model description documents. A maximum of three documents are supported. For details, see :ref:`Table 7 `. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | install_type | No | String array | Deployment type. Only lowercase letters are supported. The value can be **real-time**, or **batch**. Default value: [**real-time**, **batch**] | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template | No | Template object | Template configuration items. This parameter is mandatory when **model_type** is set to **Template**. For details, see :ref:`Table 8 `. | - +--------------------+-----------+----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table01082501075: - -.. table:: **Table 3** **params** parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+========================================================================================================================================================+ - | url | Yes | String | API URL | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | method | Yes | String | Request method. Possible values are **post** and **get**. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | Yes | String | Request protocol | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_name | Yes | String | Parameter name. It is recommended that the parameter name contain a maximum of 64 characters. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_type | Yes | String | Parameter type. The value can be **int**, **string**, **float**, **timestamp**, **date**, or **file**. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | min | No | Number | This parameter is optional when **param_type** is set to **int** or **float**. By default, this parameter is left blank. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | max | No | Number | This parameter is optional when **param_type** is set to **int** or **float**. By default, this parameter is left blank. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | param_desc | No | String | Parameter description. It is recommended that the parameter description contain a maximum of 100 characters. By default, this parameter is left blank. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table649013511785: - -.. table:: **Table 4** **dependency** parameters - - +-----------+-----------+-------------------+-----------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+===================+===============================================+ - | installer | Yes | String | Installation mode. Only **pip** is supported. | - +-----------+-----------+-------------------+-----------------------------------------------+ - | packages | Yes | **package** array | Collection of dependency packages | - +-----------+-----------+-------------------+-----------------------------------------------+ - -.. table:: **Table 5** **package** parameters - - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+====================================================================================================================================================================================+ - | package_name | Yes | String | Name of a dependency package. Ensure that the package name is correct and exists. Chinese characters and special characters (&!'"<>=) are not allowed. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | package_version | No | String | Version of a dependency package. If this parameter is left blank, the latest version is installed by default. Chinese characters and special characters (&!'"<>=) are not allowed. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | restraint | No | String | Version restriction. The value can be **EXACT**, **ATLEAST**, or **ATMOST**. This parameter is mandatory only when **package_version** exists. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** **metric** parameters - - ========= ========= ====== =========== - Parameter Mandatory Type Description - ========= ========= ====== =========== - f1 No Double F1 score - recall No Double Recall - precision No Double Precision - accuracy No Double Accuracy - ========= ========= ====== =========== - -.. _modelarts_03_0076__en-us_topic_0130147365_table9739172671118: - -.. table:: **Table 7** **doc** parameters - - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==============================================================================================================================================+ - | doc_name | Yes | String | Document name, which must start with a letter. Enter 1 to 48 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | doc_url | Yes | String | HTTP(S) link of the document | - +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table89901124131016: - -.. table:: **Table 8** **Template** parameters - - +-----------------+-----------+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+=================================+====================================================================================================================================================================================+ - | infer_format | No | String | Input and output mode. When this parameter is used, the input and output mode built in the template does not take effect. | - +-----------------+-----------+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template_id | Yes | String | ID of the used template. The template has a built-in input and output mode. | - +-----------------+-----------+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | template_inputs | Yes | Array of TemplateInputs objects | Template input configuration, specifying the source path for configuring a model. For details, see :ref:`Table 9 `. | - +-----------------+-----------+---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table12364181131310: - -.. table:: **Table 9** **template_inputs** parameters - - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=========================================================================================================================================================================================================================================================================================================================================+ - | input | Yes | String | Template input path, which can be an OBS file path or OBS directory path. When you use a template with multiple input items to create a model, if the target paths **input_properties** specified in the template are the same, the OBS directory or OBS file name entered here must be unique to prevent files from being overwritten. | - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | input_id | Yes | String | Input item ID, which is obtained from the template details. | - +-----------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table53974919117: - -.. table:: **Table 10** **apis** parameters - - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===============+===========+============================+=================================================================================================================================================================+ - | input_params | No | **InputParams** structure | Input parameters in **apis**, described in JSON Schema format. For details, see :ref:`Table 11 `. | - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | method | No | String | Request method. The options are **POST** and **GET**. | - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_params | No | **OutputParams** structure | Output parameters in **apis**, described in JSON Schema format. For details, see :ref:`Table 12 `. | - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Request protocol. | - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | url | No | String | Inference request URL. | - +---------------+-----------+----------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table116145629: - -.. table:: **Table 11** **InputParams** parameters - - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+====================+===================================================================================================================================+ - | properties | No | Map | Properties of an object element in JSON Schema. You can set parameters, including the parameter name and type, in **properties**. | - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Type in JSON Schema, which can be **object**. | - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0076__en-us_topic_0130147365_table890117461320: - -.. table:: **Table 12** **OutputParams** parameters - - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+====================+===================================================================================================================================+ - | properties | No | Map | Properties of an object element in JSON Schema. You can set parameters, including the parameter name and type, in **properties**. | - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Type in JSON Schema, which can be **object**. | - +------------+-----------+--------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 13 ` describes the response parameters. - -.. _modelarts_03_0076__en-us_topic_0130147365_table88391251102419: - -.. table:: **Table 13** Parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - model_id String Model ID - ========= ====== =========== - -Samples -------- - -The following shows how to import a model whose name is **mnist**, version is **1.0.0**, and type is **TensorFlow**. The model file comes from an OBS bucket. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/models - { - "model_name": "mnist", - "model_version": "1.0.0", - "source_location": "https://models.obs.xxxx.com/mnist", - "source_job_id": "55", - "source_job_version": "V100", - "model_type": "TensorFlow", - "runtime": "python2.7", - "description": "mnist model", - "execution_code": "https://testmodel.obs.xxxx.com/customize_service.py", - "input_params": [ - { - "url": "/v1/xxx/image", - "protocol": "http", - "method": "post", - "param_name": "image_url", - "param_type": "string", - "min": 0, - "max": 9, - "param_desc": "http://test/test.jpeg" - } - ], - "output_params": [ - { - "url": "/v1/xxx/image", - "protocol": "http", - "method": "post", - "param_name": "face_location", - "param_type": "box", - "param_desc": "face_location param value description" - } - ], - "dependencies": [ - { - "installer": "pip", - "packages": [ - { - "package_name": "numpy", - "package_version": "1.5.0", - "restraint": "ATLEAST" - } - ] - } - ], - "model_algorithm": "object_detection", - "model_metrics":"{\"f1\":0.52381,\"recall\":0.666667,\"precision\":0.466667,\"accuracy\":0.625}", - "apis": [ - { - "url": "/v1/xxx/image", - "protocol": "http", - "method": "post", - "input_params": { - "type": "object", - "properties": { - "image_url": { - "type": "string" - } - } - }, - "output_params": { - "type": "object", - "properties": { - "face_location": { - "type": "box" - } - } - } - } - ] - } - -- Sample response - - .. code-block:: - - { - "model_id": "10eb0091-887f-4839-9929-cbc884f1e20e" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/model_management/models/index.rst b/modelarts/api-ref/result/model_management/models/index.rst deleted file mode 100644 index aff6236d..00000000 --- a/modelarts/api-ref/result/model_management/models/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_03_0153: - -====== -Models -====== - -.. toctree:: - :maxdepth: 1 - - importing_a_model - querying_a_model_list - querying_the_details_about_a_model - deleting_a_model diff --git a/modelarts/api-ref/result/model_management/models/querying_a_model_list.rst b/modelarts/api-ref/result/model_management/models/querying_a_model_list.rst deleted file mode 100644 index 9aecbb07..00000000 --- a/modelarts/api-ref/result/model_management/models/querying_a_model_list.rst +++ /dev/null @@ -1,204 +0,0 @@ -.. _modelarts_03_0077: - -Querying a Model List -===================== - -Function --------- - -This API is used to query the models that meet the search criteria. - -URI ---- - -GET /v1/{project_id}/models - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0077__en-us_topic_0130168816_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Search parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================================================================================================================================================+ - | model_name | No | String | Model name. Fuzzy match is supported. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | If a model name contains an underscore (_), add the **exact_match** parameter to the request and set the parameter value to **true** because the underscore needs to be escaped. This ensures that the query operation can be performed properly. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | No | String | Model version | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_status | No | String | Model status. You can query models based on the model status. Options: | - | | | | | - | | | | - **Publishing** | - | | | | - **Published** | - | | | | - **Failed** | - | | | | - **Building** | - | | | | - **Building_failed** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_type | No | String | Model type. The models of this type are queried. **model_type** and **not_model_type** are mutually exclusive and cannot co-exist. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | not_model_type | No | String | Model type. A list of models of types except for this type are queried. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Description. Fuzzy match is supported. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Index of the page to be queried. Default value: **0** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The default value is **100**. The recommended value ranges from 10 to 50. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode. The value can be **create_at**, **model_version**, or **model_size**. Default value: **create_at** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. The value can be **asc** or **desc**, indicating ascending or descending order. Default value: **desc** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | ID of the workspace to which a service belongs. The default value is **0**, indicating the default workspace. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0077__en-us_topic_0130168816_table1954662185412: - -.. table:: **Table 3** Parameters - - +-------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=================+=================================================================================================================+ - | total_count | Integer | Total number of models that meet the search criteria when no paging is implemented | - +-------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of models | - +-------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - | models | **model** array | Model metadata. For details, see :ref:`Table 4 `. | - +-------------+-----------------+-----------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0077__en-us_topic_0130168816_table1198992710540: - -.. table:: **Table 4** **model** parameters - - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================+=============================================================================================================================================================================================================================================+ - | model_id | String | Model ID | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_status | String | Model status | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_type | String | Model type. The value can be **TensorFlow**, **MXNet**, **Caffe**, **Spark_MLlib**, **Scikit_Learn**, **XGBoost**, **MindSpore**, **Image**, or **PyTorch**. | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_size | Long | Model size, in bytes | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant | String | Tenant to which a model belongs | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project | String | Project to which a model belongs | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | User to which a model belongs | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_at | Long | Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Model description | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | String | Model source type. This parameter is valid only when a model is deployed through ExeML. The value is **auto**. You do not need to set this parameter for a model deployed through a training job. By default, this parameter is left blank. | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_source | String | Model source. Options: | - | | | | - | | | - **algos**: built-in algorithm | - | | | - **custom**: custom model | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tunable | Boolean | Whether a model can be tuned. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | market_flag | Boolean | Whether a model is subscribed from the marketplace. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publishable_flag | Boolean | Whether a model can be published to the marketplace. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | install_type | String array | Model deployment type, determining which service a model can be deployed as. The example value is **real-time** (real-time service). | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subscription_id | String | Model subscription ID. | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extra | String | Extended field. | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Specification structure | Minimum deployment specifications. For details, see :ref:`Table 5 `. | - +-----------------------+-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0077__en-us_topic_0130168816_table1669514411217: - -.. table:: **Table 5** **Specification** parameters - - ========== ====== ============================= - Parameter Type Description - ========== ====== ============================= - min_cpu String Minimal CPU specifications - min_gpu String Minimal GPU specifications - min_memory String Minimum memory capacity - min_ascend String Minimal Ascend specifications - ========== ====== ============================= - -Samples -------- - -The following shows how to query models. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/models - -- Sample response - - .. code-block:: - - { - "total_count": 1, - "count": 1, - "models": [ - { - "model_name": "mnist", - "model_version": "1.0.0", - "model_id": "10eb0091-887f-4839-9929-cbc884f1e20e", - "model_type": "tensorflow", - "model_size": 5012312, - "tenant": "6d28e85aa78b4e1a9b4bd83501bcd4a1", - "project": "d04c10db1f264cfeb1966deff1a3527c", - "owner": "6d28e85aa78b4e1a9b4bd83501bcd4a1", - "create_at": 1533041553000, - "description": "mnist model", - "workspace_id": "0", - "specification":{} - } - ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/model_management/models/querying_the_details_about_a_model.rst b/modelarts/api-ref/result/model_management/models/querying_the_details_about_a_model.rst deleted file mode 100644 index 344e4359..00000000 --- a/modelarts/api-ref/result/model_management/models/querying_the_details_about_a_model.rst +++ /dev/null @@ -1,299 +0,0 @@ -.. _modelarts_03_0078: - -Querying the Details About a Model -================================== - -Function --------- - -This API is used to query details about a model based on the model ID. - -URI ---- - -GET /v1/{project_id}/models/{model_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0078__en-us_topic_0130168817_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | model_id | Yes | String | Model ID | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0078__en-us_topic_0130168817_table4203102214310: - -.. table:: **Table 2** Parameters - - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=========================+===================================================================================================================================================================================+ - | model_id | String | Model ID | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_at | Long | Time when a model is created, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant | String | Tenant to which a model belongs | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project | String | Project to which a model belongs | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | User to which a model belongs | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_location | String | OBS path where the model is located or the SWR image location | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_job_id | String | ID of the source training job | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_job_version | String | Version of the source training job | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | String | Model source type. If a model is deployed through ExeML, the value is **auto**. If a model is deployed through a training job or an OBS model file, this parameter is left blank. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_type | String | Model type. The value can be **TensorFlow**, **MXNet**, **Spark_MLlib**, **Scikit_Learn**, **XGBoost**, **MindSpore**, **Image**, or **PyTorch**. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_size | Long | Model size, in bytes | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_status | String | Model status | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | runtime | String | Model runtime environment | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Model description | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | execution_code | String | OBS path for storing the execution code. The name of the execution code file is fixed to **customize_service.py**. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schema_doc | String | Download address of the model schema file | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | image_address | String | image path generated after model packaging | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | input_params | **params** array | Collection of input parameters of a model. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_params | **params** array | Collection of output parameters of a model. For details, see :ref:`Table 3 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dependencies | **dependency** array | Package required for running the inference code and model. For details, see :ref:`Table 4 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_metrics | String | Model precision | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | apis | String | All input and output **apis** parameter information of a model, which is obtained from the model preview | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_source | String | Model source. Options: | - | | | | - | | | - **algos**: built-in algorithm | - | | | - **custom**: custom model | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tunable | Boolean | Whether a model can be tuned. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | market_flag | Boolean | Whether a model is subscribed from the marketplace. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publishable_flag | Boolean | Whether a model can be published to the marketplace. Options: | - | | | | - | | | - **true**: yes | - | | | - **false**: no | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_docs | **GuideDoc** array | List of template documents. For details, see :ref:`Table 7 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | health | Health structure | Model health check interface information. For details, see :ref:`Table 8 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_algorithm | String | Model algorithm type. The value can be **predict_analysis**, **object_detection**, or **image_classification**. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_labels | String array | Model label array. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | labels_map | Map | Model label map. The key is fixed to **labels**, and the value is the model label array. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | ID of the workspace to which a service belongs. The default value is **0**, indicating the default workspace. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | install_type | String array | Supported service type for deployment. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Specification structure | Minimum model deployment specifications. For details, see :ref:`Table 9 `. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config | String | Model configurations. | - +-----------------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0078__en-us_topic_0130168817_table194602271747: - -.. table:: **Table 3** **params** parameters - - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+==========================================================================================================================+ - | url | String | API URL | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | method | String | Request method, for example, **post** | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | protocol | String | Request protocol, for example, **HTTP** | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | param_name | String | Parameter name, which contains a maximum of 64 characters | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | param_type | String | Parameter type. The value can be **int**, **string**, **float**, **timestamp**, **date**, or **file**. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | min | Number | This parameter is optional when **param_type** is set to **int** or **float**. By default, this parameter is left blank. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | max | Number | This parameter is optional when **param_type** is set to **int** or **float**. By default, this parameter is left blank. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - | param_desc | String | Parameter description, which contains a maximum of 100 characters. By default, this parameter is left blank. | - +------------+--------+--------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0078__en-us_topic_0130168817_table133086211152: - -.. table:: **Table 4** **dependency** parameters - - +-----------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+===================+===================================================================================================================================+ - | installer | String | Installer | - +-----------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - | packages | **package** array | Collection of dependency packages. For details, see :ref:`Table 5 `. | - +-----------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0078__en-us_topic_0130168817_table129439454518: - -.. table:: **Table 5** **package** parameters - - +-----------------+--------+------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+==============================================================================+ - | package_name | String | Name of a dependency package | - +-----------------+--------+------------------------------------------------------------------------------+ - | package_version | String | Version of a dependency package | - +-----------------+--------+------------------------------------------------------------------------------+ - | restraint | String | Version restriction. The value can be **EXACT**, **ATLEAST**, or **ATMOST**. | - +-----------------+--------+------------------------------------------------------------------------------+ - -.. table:: **Table 6** **metric** parameters - - ========= ====== =========== - Parameter Type Description - ========= ====== =========== - f1 Double F1 score - recall Double Recall - precision Double Precision - accuracy Double Accuracy - ========= ====== =========== - -.. _modelarts_03_0078__en-us_topic_0130168817_table97301318317: - -.. table:: **Table 7** **GuideDoc** parameters - - ========= ====== ============================ - Parameter Type Description - ========= ====== ============================ - doc_name String Document name - doc_url String HTTP(S) link of the document - ========= ====== ============================ - -.. _modelarts_03_0078__en-us_topic_0130168817_table6442179484: - -.. table:: **Table 8** **Health** parameters - - +-----------------------+--------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+========+============================================================================================================+ - | url | String | URL of the health check interface | - +-----------------------+--------+------------------------------------------------------------------------------------------------------------+ - | protocol | String | Request protocol of the health check interface. Only HTTP is supported. | - +-----------------------+--------+------------------------------------------------------------------------------------------------------------+ - | initial_delay_seconds | String | After an instance is started, a health check starts after seconds configured in **initial_delay_seconds**. | - +-----------------------+--------+------------------------------------------------------------------------------------------------------------+ - | timeout_seconds | String | Health check timeout | - +-----------------------+--------+------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0078__en-us_topic_0130168817_table1669514411217: - -.. table:: **Table 9** **Specification** parameters - - ========== ====== ======================= - Parameter Type Description - ========== ====== ======================= - min_cpu String Minimum CPU - min_gpu String Minimum GPU - min_memory String Minimum memory capacity - min_ascend String Minimum Ascend - ========== ====== ======================= - -Samples -------- - -The following shows how to query details about a model based on the model ID. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/models/{model_id} - -- Sample response - - .. code-block:: - - { - "model_id": "10eb0091-887f-4839-9929-cbc884f1e20e", - "model_name": "mnist", - "model_version": "1.0.0", - "runtime": "python2.7", - "tenant": "6d28e85aa78b4e1a9b4bd83501bcd4a1", - "project": "d04c10db1f264cfeb1966deff1a3527c", - "owner": "6d28e85aa78b4e1a9b4bd83501bcd4a1", - "source_location": "https://models.obs.xxxx.com/mnist", - "model_type": "TensorFlow", - "model_size": 5633481, - "model_status": "published", - "execution_code": "https://testmodel.obs.xxxx.com/customize_service.py", - "image_address": "100.125.5.235:20202/models/10eb0091-887f-4839-9929-cbc884f1e20e:1.0.0", - "input_params": [{ - "url": "/", - "method": "post", - "protocol": "http", - "param_name": "data", - "param_type": "object", - "param_desc": "{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}" }], - "output_params": [{ - "url": "/", - "method": "post", - "protocol": "http", - "param_name": "data", - "param_type": "object", - "param_desc": "{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}" }], - "dependencies": [{ - "installer": "pip", - "packages": [{ - "package_name": "pkg1", - "package_version": "1.0.1", - "restraint": "ATLEAST" - }] - }], - "model_metrics":"{\"f1\":0.52381,\"recall\":0.666667,\"precision\":0.466667,\"accuracy\":0.625}", - "apis": "[{\"protocol\":\"http\",\"method\":\"post\",\"url\":\"/\",\"input_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"req_data\":{\"items\":[{\"type\":\"object\",\"properties\":{}}],\"type\":\"array\"}}}}},\"output_params\":{\"type\":\"object\",\"properties\":{\"data\":{\"type\":\"object\",\"properties\":{\"resp_data\":{\"type\":\"array\",\"items\":[{\"type\":\"object\",\"properties\":{}}]}}}}}}]", - "model_labels":[], - "labels_map":{"labels":[]}, - "workspace_id": "0", - "install_type": ["realtime", "batch"], - "specification":{}, - "config":"{\"model_algorithm\": \"image_classification\", \"model_source\": \"auto\", \"tunable\": false, \"downloadable_flag\": true, \"algorithm\": \"resnet_v2_50,mobilenet_v1\", \"metrics\": {\"f1\": 0.912078373015873, \"recall\": 0.9125, \"precision\": 0.9340277777777778, \"accuracy\": 0.263250724969475}, \"model_type\": \"TensorFlow\", \"runtime\": \"tf1.13-python3.6-cpu\", \"apis\": [{\"protocol\": \"https\", \"url\": \"/\", \"method\": \"post\", \"request\": {\"data\": {\"type\": \"object\", \"properties\": {\"images\": {\"type\": \"file\"}}}, \"Content-type\": \"multipart/form-data\"}, \"response\": {\"data\": {\"type\": \"object\", \"required\": [\"predicted_label\", \"scores\"], \"properties\": {\"predicted_label\": {\"type\": \"string\"}, \"scores\": {\"type\": \"array\", \"items\": {\"type\": \"array\", \"minItems\": 2, \"maxItems\": 2, \"items\": [{\"type\": \"string\"}, {\"type\": \"number\"}]}}}}, \"Content-type\": \"multipart/form-data\"}}], \"dependencies\": [{\"installer\": \"pip\", \"packages\": [{\"package_name\": \"numpy\", \"package_version\": \"1.17.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"h5py\", \"package_version\": \"2.8.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"Pillow\", \"package_version\": \"5.2.0\", \"restraint\": \"EXACT\"}, {\"package_name\": \"scipy\", \"package_version\": \"1.2.1\", \"restraint\": \"EXACT\"}, {\"package_name\": \"resampy\", \"package_version\": \"0.2.1\", \"restraint\": \"EXACT\"}, {\"package_name\": \"scikit-learn\", \"package_version\": \"0.19.1\", \"restraint\": \"EXACT\"}]}]}" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/deleting_a_service.rst b/modelarts/api-ref/result/service_management/deleting_a_service.rst deleted file mode 100644 index 565ee935..00000000 --- a/modelarts/api-ref/result/service_management/deleting_a_service.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. _modelarts_03_0089: - -Deleting a Service -================== - -Function --------- - -This API is used to delete a model service. You can delete your own services only. - -URI ---- - -.. code-block:: - - DELETE /v1/{project_id}/services/{service_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0089__en-us_topic_0130234312_table10624434011: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID. If you want to delete multiple services in batches, use commas (,) to separate multiple **service_id** values. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -None - -Samples -------- - -The following shows how to delete the model service whose ID is **xxxxxx**. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/services/xxxxxx - -- Sample response - - .. code-block:: - - {} - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/deploying_a_model_as_a_service.rst b/modelarts/api-ref/result/service_management/deploying_a_model_as_a_service.rst deleted file mode 100644 index 1d8689db..00000000 --- a/modelarts/api-ref/result/service_management/deploying_a_model_as_a_service.rst +++ /dev/null @@ -1,309 +0,0 @@ -.. _modelarts_03_0082: - -Deploying a Model as a Service -============================== - -Function --------- - -This API is used to deploy a model as a service. - -URI ---- - -POST /v1/{project_id}/services - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0082__en-us_topic_0129882788_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0082__en-us_topic_0129882788_table37462542238: - -.. table:: **Table 2** Parameters - - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===================+=================+==================================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | service_name | Yes | String | Service name. Enter 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Service description, which contains a maximum of 100 characters. By default, this parameter is left blank. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_type | Yes | String | Inference mode. The value can be **real-time** or **batch**. | - | | | | | - | | | | - **real-time**: real-time service, which can be stopped as scheduled. | - | | | | - **batch**: batch service, which can be configured as tasks to run in batches. When the tasks are completed, the service stops automatically. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | ID of the workspace to which a service belongs. The default value is **0**, indicating the default workspace. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | No | String | ID of the VPC to which a real-time service instance is deployed. By default, this parameter is left blank. | - | | | | | - | | | | - In this case, ModelArts allocates a dedicated VPC to each user so that users are isolated from each other. If you need to access other service components in a VPC of a service instance, set this parameter to the ID of the corresponding VPC. | - | | | | - Once a VPC is configured, it cannot be modified. If both **vpc_id** and **cluster_id** are configured, only the dedicated resource pool takes effect. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_network_id | No | String | ID of a subnet. By default, this parameter is left blank. | - | | | | | - | | | | This parameter is mandatory when **vpc_id** is configured. Enter the network ID displayed in the subnet details on the VPC console. A subnet provides dedicated network resources that are isolated from other networks. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | No | String | Security group. By default, this parameter is left blank. This parameter is mandatory when **vpc_id** is configured. | - | | | | | - | | | | A security group is a virtual firewall that provides secure network access control policies for service instances. A security group must contain at least one inbound rule to permit the requests whose protocol is TCP, source address is **0.0.0.0/0**, and port number is **8080**. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | No | String | ID of a dedicated resource pool. This parameter is left blank by default, indicating that no dedicated resource pool is used. When using a dedicated resource pool to deploy services, ensure that the resource pool is running properly. After this parameter is set, the network configuration of the cluster is used, and the **vpc_id** parameter does not take effect. If this parameter is configured together with **cluster_id** in **real-time config**, **cluster_id** in **real-time config** is used preferentially. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config | Yes | **config** array corresponding to **infer_type** | Model running configuration. If **infer_type** is **batch**, you can configure only one model. If **infer_type** is **real-time**, you can configure multiple models and assign weights based on service requirements. However, the versions of these models cannot be the same. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schedule | No | **schedule** array | Service scheduling configuration, which can be configured only for real-time services. By default, this parameter is not used. Services run for a long time. For details, see :ref:`Table 5 `. | - +-------------------+-----------------+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **config** parameters of **real-time** - - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+==================================================================================================================================================================================+ - | model_id | Yes | String | Model ID | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | Yes | Integer | Traffic weight allocated to a model. This parameter is mandatory only when **infer_type** is set to **real-time**. The sum of the weights must be 100. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Yes | String | Resource specifications. Select specifications based on service requirements. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_spec | No | **custom_spec** structure | Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see :ref:`Table 6 `. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Yes | Integer | Number of instances deployed in a model. The value must be greater than 0. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | envs | No | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. | - | | | | | - | | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | No | string | ID of a dedicated resource pool. By default, this parameter is left blank, indicating that no dedicated resource pool is used. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **config** parameters of **batch** - - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=====================+===========================================================================================================================================================================================================================================================================================================================================+ - | model_id | Yes | String | Model ID | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Yes | String | Resource flavor. Available options: **modelarts.vm.cpu.2u** and **modelarts.vm.gpu.p4** | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Yes | Integer | Number of instances deployed in a model. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | envs | No | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. | - | | | | | - | | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_type | No | String | Data source type. This parameter can be set to **ManifestFile**. By default, this parameter is left blank, indicating that only files in the **src_path** directory are read. If this parameter is set to **ManifestFile**, **src_path** must be a specific Manifest file path. You can specify multiple data paths in the Manifest file. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_path | Yes | String | OBS path of the input data of a batch job | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_path | Yes | String | OBS path of the output data of a batch job | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | req_uri | Yes | String | Inference API called in a batch task, which is a REST API in the model image. Select an API URI from the model **config.json** file for inference. If a ModelArts built-in inference image is used, the value of this parameter is **/**. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mapping_type | Yes | String | Mapping type of the input data. The value can be **file** or **csv**. | - | | | | | - | | | | - If you select **file**, each inference request corresponds to a file in the input data path. When this mode is used, **req_uri** of this model can have only one input parameter and the type of this parameter is **file**. | - | | | | - If you select **csv**, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and **mapping_rule** needs to be configured to map the index of each parameter in the inference request body to the CSV file. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mapping_rule | No | Map | Mapping between input parameters and CSV data. This parameter is mandatory only when **mapping_type** is set to **csv**. | - | | | | | - | | | | Mapping rule: The mapping rule comes from the input parameter (**input_params**) in the model configuration file **config.json**. When **type** is set to **string**, **number**, **integer**, or **boolean**, you need to configure the index parameter. For details, see . | - | | | | | - | | | | The index must be a positive integer starting from 0. If the value of index does not comply with the rule, this parameter is ignored in the request. After the mapping rule is configured, the corresponding CSV data must be separated by commas (,). | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0082__en-us_topic_0129882788_table1892915349285: - -.. table:: **Table 5** **schedule** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================+ - | type | Yes | String | Scheduling type. Only the value **stop** is supported. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | time_unit | Yes | String | Scheduling time unit. Options: | - | | | | | - | | | | - **DAYS** | - | | | | - **HOURS** | - | | | | - **MINUTES** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Yes | Integer | Value that maps to the time unit. For example, if the task stops after two hours, set **time_unit** to **HOURS** and **duration** to **2**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0082__en-us_topic_0129882788_table134334512416: - -.. table:: **Table 6** **custom_spec** parameters - - +-------------+-----------+---------+------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+=========+================================================================================================+ - | cpu | Yes | Float | Number of required CPUs | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------+ - | memory | Yes | Integer | Required memory capacity, in MB | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------+ - | gpu_p4 | No | Float | Number of GPUs, which can be decimals. This parameter is optional. By default, it is not used. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------+ - | ascend_a310 | No | Integer | Number of NPUs, which can be decimals. This parameter is optional. By default, it is not used. | - +-------------+-----------+---------+------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 7 ` describes the response parameters. - -.. _modelarts_03_0082__en-us_topic_0129882788_table95112832610: - -.. table:: **Table 7** Parameters - - +--------------+------------------+----------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+==================+======================================================================+ - | service_id | String | Service ID | - +--------------+------------------+----------------------------------------------------------------------+ - | resource_ids | Array of strings | Resource ID array for the resource IDs generated by the target model | - +--------------+------------------+----------------------------------------------------------------------+ - -Samples -------- - -The following shows how to deploy different types of services. - -- Sample request: Creating a real-time service - - .. code-block:: - - POST https://endpoint/v1/{project_id}/services - { - "service_name": "mnist", - "description": "mnist service", - "infer_type": "real-time", - "config": [ - { - "model_id": "xxxmodel-idxxx", - "weight": "100", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1 - } - ] - } - -- Sample request: Creating a real-time service and configuring multi-version traffic distribution - - .. code-block:: - - { - "service_name": "mnist", - "description": "mnist service", - "infer_type": "real-time", - "config": [ - { - "model_id": "xxxmodel-idxxx", - "weight": "70", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1, - "envs": - { - "model_name": "mxnet-model-1", - "load_epoch": "0" - } - }, - { - "model_id": "xxxxxx", - "weight": "30", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1 - } - ] - } - -- Sample request: Creating a real-time service in a dedicated resource pool with custom specifications - - .. code-block:: - - { - "service_name": "realtime-demo", - "description": "", - "infer_type": "real-time", - "cluster_id": "8abf68a969c3cb3a0169c4acb24b0000", - "config": [{ - "model_id": "eb6a4a8c-5713-4a27-b8ed-c7e694499af5", - "weight": "100", - "cluster_id": "8abf68a969c3cb3a0169c4acb24b0000", - "specification": "custom", - "custom_spec": { - "cpu": 1.5, - "memory": 7500, - "gpu_p4": 0, - "ascend_a310": 0 - }, - "instance_count": 1 - }] - } - -- Sample request: Creating a real-time service and setting it to automatically stop - - .. code-block:: - - { - "service_name": "service-demo", - "description": "demo", - "infer_type": "real-time", - "config": [{ - "model_id": "xxxmodel-idxxx", - "weight": "100", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1 - }], - "schedule": [{ - "type": "stop", - "time_unit": "HOURS", - "duration": 1 - }] - } - -- Sample request: Creating a batch service and setting **mapping_type** to **file** - - .. code-block:: - - { - "service_name": "batchservicetest", - "description": "", - "infer_type": "batch", - "cluster_id": "8abf68a969c3cb3a0169c4acb24b****", - "config": [{ - "model_id": "598b913a-af3e-41ba-a1b5-bf065320f1e2", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1, - "src_path": "https://infers-data.obs.xxxx.com/xgboosterdata/", - "dest_path": "https://infers-data.obs.dxxxx.com/output/", - "req_uri": "/", - "mapping_type": "file" - }] - } - -- Sample response - - .. code-block:: - - { - "service_id": "10eb0091-887f-4839-9929-cbc884f1e20e", - "resource_ids": [ "INF-f878991839647358@1598319442708" ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/index.rst b/modelarts/api-ref/result/service_management/index.rst deleted file mode 100644 index ee640f71..00000000 --- a/modelarts/api-ref/result/service_management/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _modelarts_03_0081: - -================== -Service Management -================== - -.. toctree:: - :maxdepth: 1 - - deploying_a_model_as_a_service - querying_a_service_list - querying_the_details_about_a_service - updating_service_configurations - querying_service_monitoring_information - querying_service_update_logs - querying_service_event_logs - deleting_a_service - querying_supported_service_deployment_specifications diff --git a/modelarts/api-ref/result/service_management/querying_a_service_list.rst b/modelarts/api-ref/result/service_management/querying_a_service_list.rst deleted file mode 100644 index ea3f50ae..00000000 --- a/modelarts/api-ref/result/service_management/querying_a_service_list.rst +++ /dev/null @@ -1,244 +0,0 @@ -.. _modelarts_03_0083: - -Querying a Service List -======================= - -Function --------- - -This API is used to obtain model services. - -URI ---- - -GET /v1/{project_id}/services - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0083__en-us_topic_0129882800_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameters - - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+=============================================================================================================================================================================================================================+ - | service_id | No | String | Service ID | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_name | No | String | Service name | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | No | String | Model ID | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | No | String | Dedicated resource pool ID, which is left blank by default | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace ID. Default value: **0** | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_type | No | String | Inference mode. The value can be **real-time** or **batch**. By default, this parameter is left blank. | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Service status. By default, the service status is not filtered. You can query information by service status. The possible values are **running**, **deploying**, **concerning**, **failed**, **stopped**, and **finished**. | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. Default value: **0** | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. The default value is **1000**. The recommended value ranges from 10 to 50. | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode. The value can be **publish_at** or **service_name**. Default value: **publish_at** | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. The value can be **asc** or **desc**, indicating ascending or descending order. Default value: **desc** | - +--------------+-----------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0083__en-us_topic_0129882800_table6357123816292: - -.. table:: **Table 3** Parameters - - +-------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+===================+============================================================================================================================================+ - | total_count | Integer | Total number of services that meet the search criteria when no paging is implemented | - +-------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of services in the query result. If **offset** and **limit** are not set, the values of **count** and **total_count** are the same. | - +-------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | services | **service** array | Collection of the queried services. For details, see :ref:`Table 4 `. | - +-------------+-------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0083__en-us_topic_0129882800_table799523318302: - -.. table:: **Table 4** **service** parameters - - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============================+=======================+===================================================================================================================================================================================================================================+ - | service_id | String | Service ID | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_name | String | Service name | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Service description | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant | String | Tenant to which a service belongs | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project | String | Project to which a service belongs | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | User to which a service belongs | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publish_at | Long | Latest service release time, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_type | String | Inference mode. The value can be **real-time** or **batch**. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID. Default value: **0** | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Service status. The value can be **running**, **deploying**, **concerning**, **failed**, **stopped**, or **finished**. | - | | | | - | | | - **running**: The service is running properly. | - | | | - **deploying**: The service is being deployed or scheduling resources are being deployed. | - | | | - **concerning**: The backend instances are abnormal. For example, if there are multiple instances and some instances are abnormal, the normal instances will consume resources. In this case, the service status is concerning. | - | | | - **failed**: The service fails to be deployed. For details about the failure cause, see the event and log tab pages. | - | | | - **stopped**: The service has been stopped. | - | | | - **finished**: This state is displayed only for the batch service, indicating that the service running is complete. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Number | Batch service start time, in milliseconds calculated from 1970.1.1 0:0:0 UTC. This parameter is returned only when the service is a batch service. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_time | Number | Batch service end time, in milliseconds calculated from 1970.1.1 0:0:0 UTC. This parameter is returned only when the service is a batch service. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | integer | Deployment progress. This parameter is returned when the status is **deploying**. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | invocation_times | Long | Total number of service calls | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_times | Long | Number of failed service calls | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_shared | Boolean | Whether a service is subscribed | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared_count | Number | Number of subscribed services | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schedule | **schedule** array | Service scheduling. For details, see :ref:`Table 5 `. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | due_time | number | Time when a real-time service automatically stops, in milliseconds calculated from 1970.1.1 0:0:0 UTC. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | operation_time | number | Operation time of a request | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_opened_sample_collection | String | Whether to enable data collection. The default value is **false**. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | transition_at | number | Time when the service status changes | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_free | Boolean | Whether a service uses the free-of-charge flavor | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | additional_properties | Map | Additional service attribute. If this parameter is not set, no value is returned. | - +-----------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0083__en-us_topic_0129882800_table1892915349285: - -.. table:: **Table 5** **schedule** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=============================================================================================================================================+ - | type | Yes | String | Scheduling type. Only the value **stop** is supported. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | time_unit | Yes | String | Scheduling time unit. Options: | - | | | | | - | | | | - **DAYS** | - | | | | - **HOURS** | - | | | | - **MINUTES** | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Yes | Integer | Value that maps to the time unit. For example, if the task stops after two hours, set **time_unit** to **HOURS** and **duration** to **2**. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query model services. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services - -- Sample response - - .. code-block:: - - { - "count": 2, - "total_count": 2, - "services": [ - { - "service_id": "8da30673-908d-45a7-90a4-65f98e69fc34", - "service_name": "service-demo", - "tenant": "xxx", - "project": "xxx", - "owner": "xxx", - "publish_at": 1584622900171, - "infer_type": "real-time", - "status": "stopped", - "progress": 100, - "invocation_times": 0, - "failed_times": 0, - "is_shared": false, - "shared_count": 0, - "workspace_id": "0", - "schedule": [ - { - "type": "stop", - "duration": 1, - "time_unit": "HOURS" - } - ], - "due_time": 1584626633902, - "operation_time": 1586250354961, - "is_opened_sample_collection": false, - "additional_properties": {}, - "is_free": false, - "transition_at": 1584623163721 - }, - { - "service_id": "912f1a4a-5962-455c-b11c-5fdf06045cb3", - "service_name": "service-demo2", - "tenant": "xxx", - "project": "xxx", - "owner": "xxx", - "publish_at": 1584618274410, - "infer_type": "real-time", - "status": "stopped", - "progress": 100, - "invocation_times": 0, - "failed_times": 0, - "is_shared": false, - "shared_count": 0, - "workspace_id": "0", - "schedule": [ - { - "type": "stop", - "duration": 1, - "time_unit": "HOURS" - } - ], - "due_time": 1584622027673, - "operation_time": 1586250354961, - "is_opened_sample_collection": false, - "additional_properties": {}, - "is_free": false, - "transition_at": 1584618498528 - } - ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/querying_service_event_logs.rst b/modelarts/api-ref/result/service_management/querying_service_event_logs.rst deleted file mode 100644 index 38b161a3..00000000 --- a/modelarts/api-ref/result/service_management/querying_service_event_logs.rst +++ /dev/null @@ -1,170 +0,0 @@ -.. _modelarts_03_0155: - -Querying Service Event Logs -=========================== - -Function --------- - -This API is used to query service event logs, including service operation records, key actions during deployment, and deployment failure causes. - -URI ---- - -GET /v1/{project_id}/services/{service_id}/events - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0155__en-us_topic_0192973542_table10624434011: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================================+ - | event_type | No | String | Type of the event to be filtered. By default, the event type is not filtered. Options: | - | | | | | - | | | | - **normal**: normal events | - | | | | - **abnormal**: abnormal events | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | start_time | No | Number | Start time of the event to be filtered. The value is milliseconds between the current time and '1970.1.1 0:0:0 UTC'. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | end_time | No | Number | End time of the event to be filtered. The value is milliseconds between the current time and '1970.1.1 0:0:0 UTC'. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | offset | No | Integer | Start page of the paging list. Default value: **0** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. Default value: **1000** | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Specified sorting field. The default value is **occur_time**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting mode. The default value is **desc**. Options: | - | | | | | - | | | | - **asc**: ascending order | - | | | | - **desc**: descending order | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0155__en-us_topic_0192973542_table413209485: - -.. table:: **Table 3** Parameters - - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+=================+============================================================================================================+ - | service_id | String | Service ID | - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - | service_name | String | Service name | - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - | events | **event** array | Event logs. For details, see :ref:`Table 4 `. | - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - | total_count | Integer | Total number of events that meet the search criteria when no paging is implemented | - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - | count | Integer | Number of events in the query result | - +--------------+-----------------+------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0155__en-us_topic_0192973542_table974014115493: - -.. table:: **Table 4** **event** structure - - +------------+--------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +============+========+========================================================================================================================+ - | occur_time | Number | Time when an event occurs. The value is milliseconds between the current time and '1970.1.1 0:0:0 UTC'. | - +------------+--------+------------------------------------------------------------------------------------------------------------------------+ - | event_type | String | Event type. Possible values are **normal** and **abnormal**, indicating whether the event is normal or abnormal. | - +------------+--------+------------------------------------------------------------------------------------------------------------------------+ - | event_info | String | Event information,' including service operation records, key actions during deployment, and deployment failure causes. | - +------------+--------+------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following example queries event information of the service whose ID is **35de3ca9-1bca-4ae7-9cb0-914f30fa7d3e**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services/{service_id}/events - -- Sample response - - .. code-block:: - - { - "service_id": "35de3ca9-1bca-4ae7-9cb0-914f30fa7d3e", - "service_name": "zcjtest-07085", - "count": 9, - "total_count": 9, - "events": [ - { - "occur_time": 1562597251764, - "event_type": "normal", - "event_info": "start to deploy service" - }, - { - "occur_time": 1562597251788, - "event_type": "normal", - "event_info": "building image for model [zcjtestTF 3.0.0]" - }, - { - "occur_time": 1562597251805, - "event_type": "normal", - "event_info": "model (zcjtestTF 3.0.0) build image success" - }, - { - "occur_time": 1562597255744, - "event_type": "normal", - "event_info": "preparing environment" - }, - { - "occur_time": 1562597275915, - "event_type": "normal", - "event_info": "[zcjtestTF 3.0.0] prepare environment success" - }, - { - "occur_time": 1562597275921, - "event_type": "normal", - "event_info": "[zcjtestTF 3.0.0] schedule resource success" - }, - { - "occur_time": 1562597275928, - "event_type": "normal", - "event_info": "[zcjtestTF 3.0.0] pulling model image" - }, - { - "occur_time": 1562597332570, - "event_type": "normal", - "event_info": "[zcjtestTF 3.0.0] pull image success" - }, - { - "occur_time": 1562597332582, - "event_type": "normal", - "event_info": "[zcjtestTF 3.0.0] starting model" - } - ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/querying_service_monitoring_information.rst b/modelarts/api-ref/result/service_management/querying_service_monitoring_information.rst deleted file mode 100644 index 0ccd40f1..00000000 --- a/modelarts/api-ref/result/service_management/querying_service_monitoring_information.rst +++ /dev/null @@ -1,117 +0,0 @@ -.. _modelarts_03_0087: - -Querying Service Monitoring Information -======================================= - -Function --------- - -This API is used to query service monitoring information. - -URI ---- - -GET /v1/{project_id}/services/{service_id}/monitor - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0087__en-us_topic_0130048742_table10624434011: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameters - - +-----------+-----------+--------+------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==================================================================+ - | node_id | No | String | ID of the node to be queried. By default, all nodes are queried. | - +-----------+-----------+--------+------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0087__en-us_topic_0130048742_table413209485: - -.. table:: **Table 3** Parameters - - +--------------+----------------------------------------------------------------+--------------------+ - | Parameter | Type | Description | - +==============+================================================================+====================+ - | service_id | String | Service ID | - +--------------+----------------------------------------------------------------+--------------------+ - | service_name | String | Service name | - +--------------+----------------------------------------------------------------+--------------------+ - | monitors | **monitor** array corresponding to **infer_type** of a service | Monitoring details | - +--------------+----------------------------------------------------------------+--------------------+ - -.. table:: **Table 4** **monitor** parameters of **real-time** - - ================ ======= ===================================== - Parameter Type Description - ================ ======= ===================================== - model_id String Model ID - model_name String Model name - model_version String Model version - invocation_times Long Total number of model instance calls - failed_times Long Number of failed model instance calls - cpu_core_usage Float Number of used CPUs - cpu_core_total Float Total number of CPUs - cpu_memory_usage Integer Used memory, in MB - cpu_memory_total Integer Total memory, in MB - gpu_usage Float Number used GPUs - gpu_total Float Total number of GPUs - ================ ======= ===================================== - -Samples -------- - -The following shows how to query the monitoring information about a real-time service. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services/{service_id}/monitor - -- Sample response - - .. code-block:: - - { - "service_id": "xxx", - "service_name": "mnist", - "monitors": - [{ - "model_id": "xxxx", - "model_name": "minst", - "model_version": "1.0.0", - "invocation_times": 50, - "failed_times": 1, - "cpu_core_usage": "2.4", - "cpu_core_total": "4", - "cpu_memory_usage": "2011", - "cpu_memory_total": "8192", - "gpu_usage": "0.6", - "gpu_total": "1" - } ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/querying_service_update_logs.rst b/modelarts/api-ref/result/service_management/querying_service_update_logs.rst deleted file mode 100644 index 980add5f..00000000 --- a/modelarts/api-ref/result/service_management/querying_service_update_logs.rst +++ /dev/null @@ -1,176 +0,0 @@ -.. _modelarts_03_0088: - -Querying Service Update Logs -============================ - -Function --------- - -This API is used to query the update logs of a real-time service. - -URI ---- - -GET /v1/{project_id}/services/{service_id}/logs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0088__en-us_topic_0130234308_table10624434011: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+===============================================================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID | - +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | No | Number | Update time for filtering. This parameter can be used to obtain the update logs of a real-time service. By default, the filtering by update time is disabled. | - +-------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0088__en-us_topic_0130234308_table1869020408516: - -.. table:: **Table 2** Parameters - - +--------------+---------------+----------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+===============+======================================================================================================================+ - | service_id | String | Service ID | - +--------------+---------------+----------------------------------------------------------------------------------------------------------------------+ - | service_name | String | Service name | - +--------------+---------------+----------------------------------------------------------------------------------------------------------------------+ - | logs | **log** array | Service update logs. For details, see :ref:`Table 3 `. | - +--------------+---------------+----------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0088__en-us_topic_0130234308_table0745828125216: - -.. table:: **Table 3** **log** parameters - - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+==================+============================================================================================================================================================================================+ - | update_time | Number | Time when a service is updated, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result | String | Update result. The value can be **SUCCESS**, **FAIL**, or **RUNNING**. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config | **config** array | Updated service configurations. For details, see :ref:`Table 4 `. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | success_num | Number | Number of nodes that are successfully operated. This parameter is returned when **infer_type** is set to **edge**. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_num | Number | Number of nodes that fail to be operated. This parameter is returned when **infer_type** is set to **edge**. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | result_detail | **result** array | Operation result details. This parameter is returned when **infer_type** is set to **edge**. For details, see :ref:`Table 5 `. | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | String | ID of a dedicated resource pool | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_config | List | Personalized configuration | - +---------------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0088__en-us_topic_0130234308_table1355535185314: - -.. table:: **Table 4** **config** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================================+ - | model_id | String | Model ID | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | weight | Integer | Traffic weight allocated to a model. This parameter is returned when **infer_type** is set to **real-time**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | specification | String | Resource flavor. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | custom_spec | Float | Custom specifications. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | instance_count | Integer | Number of instances deployed in a model. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | envs | Map | Environment variable key-value pair required for running a model | - | | | | - | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - | cluster_id | String | ID of a dedicated resource pool | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0088__en-us_topic_0130234308_table44853072416: - -.. table:: **Table 5** **result** parameters - - +-----------+---------+----------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=========+====================================================================================================+ - | node_id | String | Node ID | - +-----------+---------+----------------------------------------------------------------------------------------------------+ - | node_name | String | Node name | - +-----------+---------+----------------------------------------------------------------------------------------------------+ - | operation | String | Operation type. The value can be **deploy** or **delete**. | - +-----------+---------+----------------------------------------------------------------------------------------------------+ - | result | Boolean | Operation result. **true** indicates operation success, and **false** indicates operation failure. | - +-----------+---------+----------------------------------------------------------------------------------------------------+ - -.. table:: **Table 6** **custom_spec** parameters - - =========== ======= ====================== - Parameter Type Description - =========== ======= ====================== - cpu Float Number of CPUs - memory Integer Memory capacity in MB - gpu_p4 Float Number of GPUs - ascend_a310 Integer Number of Ascend chips - =========== ======= ====================== - -Samples -------- - -The following shows how to query the update logs of the real-time service whose ID is **xxxxxx** and name is **mnist**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services/xxxxxx/logs - -- Sample response - - .. code-block:: - - { - "service_id": "e2122bbd-f7c8-4bf8-bacc-59616276194b", - "service_name": "service-demo", - "logs": [{ - "config": [{ - "model_id": "f565ac47-6239-4e8c-b2dc-0665dc52e302", - "model_name": "model-demo", - "model_version": "0.0.1", - "specification": "modelarts.vm.cpu.2u", - "custom_spec": {}, - "weight": 100, - "instance_count": 1, - "scaling": false, - "envs": {}, - "cluster_id": "2c9080f86d37da64016d381fe5940002" - }], - "extend_config": [], - "update_time": 1586250930708, - "result": "RUNNING", - "cluster_id": "2c9080f86d37da64016d381fe5940002" - }] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/querying_supported_service_deployment_specifications.rst b/modelarts/api-ref/result/service_management/querying_supported_service_deployment_specifications.rst deleted file mode 100644 index d16ea4b2..00000000 --- a/modelarts/api-ref/result/service_management/querying_supported_service_deployment_specifications.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _modelarts_03_0200: - -Querying Supported Service Deployment Specifications -==================================================== - -Function --------- - -This API is used to query supported service deployment specifications. - -URI - -GET /v1/{project_id}/services/specifications - -.. table:: **Table 1** Parameters - - +---------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=====================+===========+=========+==============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +---------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------+ - | is_personal_cluster | No | Boolean | Whether to query the service deployment specifications supported by dedicated resource pool. The default value is **false**. | - +---------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------+ - | infer_type | No | String | Inference mode. The default value is **real-time**. The value can be **real-time** or **batch**. | - +---------------------+-----------+---------+------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -.. table:: **Table 2** Parameters - - +----------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========================+===============================================================================================================================================+ - | specifications | **specification** array | Supported service deployment specifications. For details, see :ref:`Table 3 `. | - +----------------+-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0200__en-us_topic_0210524455_table16128205111319: - -.. table:: **Table 3** **specification** parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==================================================================================================================================================================================+ - | specification | String | Unique specifications ID | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | billing_spec | String | Unique ID of the billing specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_status | String | Specifications status | - | | | | - | | | - **normal**: The specifications are normal. | - | | | - **sellout**: The specifications cannot be used to deploy services because they are sold out. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_open | Boolean | Whether to enable the specifications. The default value is **true**. If this parameter is set to **false**, you need to submit a service ticket to apply for the specifications. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | String | Type of the model to which the specifications apply. | - | | | | - | | | - Empty: indicates a model generated by the user. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_free | Boolean | Whether the flavor is free of charge. The value **true** indicates that the flavor is free of charge. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | over_quota | Boolean | Whether the quota exceeds the upper limit. The value **true** indicates that the quota exceeds the upper limit. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | extend_params | Integer | Billing item | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | display_en | String | Specifications description in English | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | display_cn | String | Specifications description in Chinese | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services/specifications - -- Sample response - - .. code-block:: - - { - "specifications": [ - { - "specification": "modelarts.vm.gpu.p4", - "billing_spec": "modelarts.vm.gpu.p4", - "is_open": true, - "spec_status": "normal", - "is_free": false, - "over_quota": false, - "extend_params": 1 - }, - ] - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/querying_the_details_about_a_service.rst b/modelarts/api-ref/result/service_management/querying_the_details_about_a_service.rst deleted file mode 100644 index c411e3c1..00000000 --- a/modelarts/api-ref/result/service_management/querying_the_details_about_a_service.rst +++ /dev/null @@ -1,323 +0,0 @@ -.. _modelarts_03_0084: - -Querying the Details About a Service -==================================== - -Function --------- - -This API is used to query the details about a model service based on the service ID. - -URI ---- - -GET /v1/{project_id}/services/{service_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0084__en-us_topic_0130035938_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0084__en-us_topic_0130035938_table41514501418: - -.. table:: **Table 2** Parameters - - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+==================================================+============================================================================================================================================================================================+ - | service_id | String | Service ID | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | service_name | String | Service name | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Service description | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | tenant | String | Tenant to which a service belongs | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | project | String | Project to which a service belongs | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | User to which a service belongs | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | publish_at | Number | Latest service release time, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | infer_type | String | Inference type, which can be **real-time**, **edge**, | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | String | Workspace ID | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | String | ID of the dedicated resource pool used by the real-time or batch service. This parameter is available only when a dedicated resource pool is used. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | vpc_id | String | ID of the VPC to which the real-time service instance belongs. This parameter is available when the network configuration is customized. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | subnet_network_id | String | ID of the subnet to which the real-time service instance belongs. This parameter is available when the network configuration is customized. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | security_group_id | String | Security group to which the real-time service instance belongs. This parameter is available when the network configuration is customized. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Service status, which can be **running**, **deploying**, **concerning**, **failed**, **stopped**, or **finished** | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | progress | Integer | Deployment progress. This parameter is available when the status is **deploying**. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_msg | String | Error message. When **status** is **failed**, an error message carrying the failure cause is returned. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config | **config** array corresponding to **infer_type** | Service configuration (If a service is shared, only **model_id**, **model_name**, and **model_version** are returned.) | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | access_address | String | Access address of an inference request. This parameter is available when **infer_type** is set to **real-time**. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | bind_access_address | String | Request address of a custom domain name. This parameter is available after a domain name is bound. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | invocation_times | Number | Total number of service calls | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | failed_times | Number | Number of failed service calls | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_shared | Boolean | Whether a service is subscribed | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | shared_count | Number | Number of subscribed services | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schedule | **schedule** array | Service scheduling configuration. If this parameter is not set, no value will be returned. For details, see :ref:`Table 6 `. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Time when the configuration used by a service is updated, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | debug_url | String | Online debugging address of a real-time service. This parameter is available only when the model supports online debugging and there is only one instance. | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | due_time | number | Time when a real-time service automatically stops, in milliseconds calculated from 1970.1.1 0:0:0 UTC | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | operation_time | number | Operation time of a request | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | transition_at | number | Time when the service status changes | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | is_free | Boolean | Whether a free-of-charge flavor is used | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | additional_properties | Map | Additional service attribute | - +-----------------------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **config** parameters of **real-time** - - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+===========================================================================================================================================+ - | model_id | String | Model ID | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | source_type | String | Model source. This parameter is returned when a model is created through ExeML. The value is **auto**. | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Model status. Options: | - | | | | - | | | - **ready**: ready (All instances have been started.) | - | | | - **concerning**: partially ready (Some instances are started and some are not.) | - | | | - **notReady**: not ready (All instances are not started.) | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | Integer | Traffic weight allocated to a model | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | String | Resource flavor. Options: **modelarts.vm.cpu.2u**, **modelarts.vm.gpu.p4**, and **modelarts.vm.ai1.a310** | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_spec | **custom_spec** structure | Custom | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | envs | Map | (Optional) Environment variable key-value pair required for running a model | - | | | | - | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Integer | Number of instances deployed in a model | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | scaling | Boolean | Whether auto scaling is enabled | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | String | ID of a dedicated resource pool used by a service instance. This parameter is returned only when a dedicated resource pool is configured. | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | support_debug | Boolean | Whether a model supports online debugging | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - | additional_properties | Map | Additional model deployment attribute | - +-----------------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **config** parameters of **batch** - - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+===========================+=============================================================================================================================+ - | model_id | String | Model ID | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | model_version | String | Model version | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | specification | String | Resource flavor. Options: **modelarts.vm.cpu.2u**, **modelarts.vm.gpu.p4**, and **modelarts.vm.ai1.a310** | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | custom_spec | **custom_spec** structure | Custom | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | envs | Map | (Optional) Environment variable key-value pair required for running a model | - | | | | - | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Integer | Number of instances deployed in a model | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | src_type | String | Data source type. This parameter is returned only when **ManifestFile** is specified. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | src_path | String | OBS path of the input data of a batch job | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | dest_path | String | OBS path of the output data of a batch job | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | req_uri | String | Inference path of a batch job | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | mapping_type | String | Mapping type of the input data. The value can be **file** or **csv**. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | mapping_rule | Map | Mapping between input parameters and CSV data. This parameter is mandatory only when **mapping_type** is set to **csv**. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | start_time | Number | Task start time, in milliseconds calculated from 1970.1.1 0:0:0 UTC. This parameter is not returned until the task starts. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | finished_time | Number | Task finished time, in milliseconds calculated from 1970.1.1 0:0:0 UTC. This parameter is not returned until the task ends. | - +-----------------------+---------------------------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 5** **node** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================+ - | id | String | Node ID | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | name | String | Node name | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | instance_status | String | Status of a model instance on a node. The value can be **running**, **stopped**, **notReady**, or **failed**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | predict_url | String | Inference URL of a node | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | node_label | String | Node label | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | description | String | Description | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | host_name | String | Host name of a node | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | os_name | String | OS name | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | os_type | String | OS type | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | os_version | String | OS version | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | arch | String | Node architecture | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | cpu | Integer | Number of CPUs | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | memory | Integer | Memory size, in MB | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | gpu_num | Integer | Number of GPUs | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | enable_gpu | String | Whether to enable the GPU | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | host_ips | String array | Host IP of a node | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | deployment_num | Integer | Number of application instances deployed on a node | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | state | String | Host status. Options: | - | | | | - | | | - **RUNNING**: running | - | | | - **FAIL**: faulty | - | | | - **UNCONNECTED**: disconnected | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | created_at | String | Creation time, in the format of *YYYY-MM-DDThh:mm:ss* (UTC) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - | updated_at | String | Update time, in the format of *YYYY-MM-DDThh:mm:ss* (UTC) | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0084__en-us_topic_0130035938_table1892915349285: - -.. table:: **Table 6** **schedule** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=============================================================================================================================================+ - | type | String | Scheduling type. Only the value **stop** is supported. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | time_unit | String | Scheduling time unit. Options: | - | | | | - | | | - DAYS | - | | | - HOURS | - | | | - MINUTES | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Integer | Value that maps to the time unit. For example, if the task stops after two hours, set **time_unit** to **HOURS** and **duration** to **2**. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 7** **custom_spec** parameters - - =========== ======= ====================== - Parameter Type Description - =========== ======= ====================== - cpu Float Number of CPUs - memory Integer Memory capacity in MB - gpu_p4 Float Number of GPUs - ascend_a310 Integer Number of Ascend chips - =========== ======= ====================== - -Samples -------- - -The following shows how to query the details about a real-time service based on the service ID. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/services/{service_id} - -- Sample response - - .. code-block:: - - { - "service_id": "f76f20ba-78f5-44e8-893a-37c8c600c02f", - "service_name": "service-demo", - "tenant": "xxxxx", - "project": "xxxxx", - "owner": "xxxxx", - "publish_at": 1585809231902, - "update_time": 1585809358259, - "infer_type": "real-time", - "status": "running", - "progress": 100, - "access_address": "https://xxxxx.apigw.xxxxx/v1/infers/088458d9-5755-4110-97d8-1d21065ea10b/f76f20ba-78f5-44e8-893a-37c8c600c02f", - "cluster_id": "088458d9-5755-4110-97d8-1d21065ea10b", - "workspace_id": "0", - "additional_properties": {}, - "is_shared": false, - "invocation_times": 0, - "failed_times": 0, - "shared_count": 0, - "operation_time": 1586249085447, - "config": [{ - "model_id": "044ebf3d-8bf4-48df-bf40-bad0e664c1e2", - "model_name": "jar-model", - "model_version": "1.0.1", - "specification": "custom", - "custom_spec": {}, - "status": "notReady", - "weight": 100, - "instance_count": 1, - "scaling": false, - "envs": {}, - "additional_properties": {}, - "support_debug": false - }], - "transition_at": 1585809231902, - "is_free": false - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/service_management/updating_service_configurations.rst b/modelarts/api-ref/result/service_management/updating_service_configurations.rst deleted file mode 100644 index d621fcd7..00000000 --- a/modelarts/api-ref/result/service_management/updating_service_configurations.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. _modelarts_03_0086: - -Updating Service Configurations -=============================== - -Function --------- - -This API is used to update configurations of a model service. It can also be used to start or stop a service. - -URI ---- - -PUT /v1/{project_id}/services/{service_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0086__en-us_topic_0130045990_table10624434011: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | service_id | Yes | String | Service ID | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0086__en-us_topic_0130045990_table188019141442: - -.. table:: **Table 2** Parameters - - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+==================================================+==============================================================================================================================================================================================================================================================+ - | description | No | String | Service description, which contains a maximum of 100 characters. If this parameter is not set, the service description is not updated. | - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Service status. The value can be **running** or **stopped**. If this parameter is not set, the service status is not changed. **status** and **config** cannot be modified at the same time. If both parameters exist, modify only the **status** parameter. | - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config | No | **config** array corresponding to **infer_type** | Service configuration. If this parameter is not set, the service is not updated. The model service is modified and the **update_time** parameter is returned only for requests with **config** updated. | - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | schedule | No | **schedule** array | Service scheduling configuration, which can be configured only for real-time services. By default, this parameter is not used. Services run for a long time. For details, see :ref:`Table 5 `. | - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | additional_properties | No | Map | Additional service attribute, which facilitates service management | - +-----------------------+-----------+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **config** parameters of **real-time** - - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+===========================+==================================================================================================================================================================================+ - | model_id | Yes | String | Model ID | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | weight | Yes | Integer | Traffic weight allocated to a model. This parameter is mandatory only when **infer_type** is set to **real-time**. The sum of the weights must be 100. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Yes | String | Resource specifications. Select specifications based on service requirements. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | custom_spec | No | **custom_spec** structure | Custom specifications. Set this parameter when you use a dedicated resource pool. For details, see :ref:`Table 6 `. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Yes | Integer | Number of instances deployed in a model. The value must be greater than 0. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | envs | No | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. | - | | | | | - | | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cluster_id | No | string | ID of a dedicated resource pool. By default, this parameter is left blank, indicating that no dedicated resource pool is used. | - +-----------------+-----------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **config** parameters of **batch** - - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=====================+===========================================================================================================================================================================================================================================================================================================================================+ - | model_id | Yes | String | Model ID | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | specification | Yes | String | Resource flavor. Available options: **modelarts.vm.cpu.2u** and **modelarts.vm.gpu.p4** | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | instance_count | Yes | Integer | Number of instances deployed in a model. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | envs | No | Map | (Optional) Environment variable key-value pair required for running a model. By default, this parameter is left blank. | - | | | | | - | | | | To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_type | No | String | Data source type. This parameter can be set to **ManifestFile**. By default, this parameter is left blank, indicating that only files in the **src_path** directory are read. If this parameter is set to **ManifestFile**, **src_path** must be a specific Manifest file path. You can specify multiple data paths in the Manifest file. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | src_path | Yes | String | OBS path of the input data of a batch job | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dest_path | Yes | String | OBS path of the output data of a batch job | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | req_uri | Yes | String | Inference API called in a batch task, which is a REST API in the model image. Select an API URI from the model **config.json** file for inference. If a ModelArts built-in inference image is used, the value of this parameter is **/**. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mapping_type | Yes | String | Mapping type of the input data. The value can be **file** or **csv**. | - | | | | | - | | | | - If you select **file**, each inference request corresponds to a file in the input data path. When this mode is used, **req_uri** of this model can have only one input parameter and the type of this parameter is **file**. | - | | | | - If you select **csv**, each inference request corresponds to a row of data in the CSV file. When this mode is used, the files in the input data path can only be in CSV format and **mapping_rule** needs to be configured to map the index of each parameter in the inference request body to the CSV file. | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mapping_rule | No | Map | Mapping between input parameters and CSV data. This parameter is mandatory only when **mapping_type** is set to **csv**. | - | | | | | - | | | | Mapping rule: The mapping rule comes from the input parameter (**input_params**) in the model configuration file **config.json**. When **type** is set to **string**, **number**, **integer**, or **boolean**, you need to configure the index parameter. For details, see . | - | | | | | - | | | | The index must be a positive integer starting from 0. If the value of index does not comply with the rule, this parameter is ignored in the request. After the mapping rule is configured, the corresponding CSV data must be separated by commas (,). | - +-----------------+-----------------+---------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0086__en-us_topic_0130045990_table1892915349285: - -.. table:: **Table 5** **schedule** parameters - - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+=============================================================================================================================================+ - | type | Yes | String | Scheduling type. Only the value **stop** is supported. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | time_unit | Yes | String | Scheduling time unit. Possible values are **DAYS**, **HOURS**, and **MINUTES**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Yes | Integer | Value that maps to the time unit. For example, if the task stops after two hours, set **time_unit** to **HOURS** and **duration** to **2**. | - +-----------+-----------+---------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -None - -Samples -------- - -The following shows how to update a real-time service. - -- Sample request - - .. code-block:: - - PUT https://endpoint/v1/{project_id}/services/{service_id} - { - "description": "", - "status": "running", - "config": [{ - "model_id": "xxxx", - "weight": "100", - "specification": "modelarts.vm.cpu.2u", - "instance_count": 1 - }] - } - -- Sample response - - .. code-block:: - - {} - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/index.rst b/modelarts/api-ref/result/training_management/index.rst deleted file mode 100644 index 9a470459..00000000 --- a/modelarts/api-ref/result/training_management/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_03_0043: - -=================== -Training Management -=================== - -.. toctree:: - :maxdepth: 1 - - training_jobs/index - training_job_parameter_configuration/index - visualization_jobs/index - resource_and_engine_specifications/index - job_statuses diff --git a/modelarts/api-ref/result/training_management/job_statuses.rst b/modelarts/api-ref/result/training_management/job_statuses.rst deleted file mode 100644 index fe70a7bc..00000000 --- a/modelarts/api-ref/result/training_management/job_statuses.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. _modelarts_03_0074: - -Job Statuses -============ - -:ref:`Table 1 ` describes the job statuses. - -.. _modelarts_03_0074__en-us_topic_0131326476_en-us_topic_0105159288_table21749790153351: - -.. table:: **Table 1** Job statuses - - +--------------+-----------------------------------------------------------------+ - | Status Value | Description | - +==============+=================================================================+ - | 0 | JOBSTAT_UNKNOWN: Unknown status. | - +--------------+-----------------------------------------------------------------+ - | 1 | JOBSTAT_INIT: The job is being initialized. | - +--------------+-----------------------------------------------------------------+ - | 2 | JOBSTAT_IMAGE_CREATING: The job image is being created. | - +--------------+-----------------------------------------------------------------+ - | 3 | JOBSTAT_IMAGE_FAILED: Failed to create the job image. | - +--------------+-----------------------------------------------------------------+ - | 4 | JOBSTAT_SUBMIT_TRYING: The job is being submitted. | - +--------------+-----------------------------------------------------------------+ - | 5 | JOBSTAT_SUBMIT_FAILED: Failed to submit the job. | - +--------------+-----------------------------------------------------------------+ - | 6 | JOBSTAT_DELETE_FAILED: Failed to delete the job. | - +--------------+-----------------------------------------------------------------+ - | 7 | JOBSTAT_WAITING: The job is queuing. | - +--------------+-----------------------------------------------------------------+ - | 8 | JOBSTAT_RUNNING: The job is running. | - +--------------+-----------------------------------------------------------------+ - | 9 | JOBSTAT_KILLING: The job is being canceled. | - +--------------+-----------------------------------------------------------------+ - | 10 | JOBSTAT_COMPLETED: The job has been completed. | - +--------------+-----------------------------------------------------------------+ - | 11 | JOBSTAT_FAILED: Failed to run the job. | - +--------------+-----------------------------------------------------------------+ - | 12 | JOBSTAT_KILLED: Job canceled successfully. | - +--------------+-----------------------------------------------------------------+ - | 13 | JOBSTAT_CANCELED: Job canceled. | - +--------------+-----------------------------------------------------------------+ - | 14 | JOBSTAT_LOST: Job lost. | - +--------------+-----------------------------------------------------------------+ - | 15 | JOBSTAT_SCALING: The job is being scaled. | - +--------------+-----------------------------------------------------------------+ - | 16 | JOBSTAT_SUBMIT_MODEL_FAILED: Failed to submit the model. | - +--------------+-----------------------------------------------------------------+ - | 17 | JOBSTAT_DEPLOY_SERVICE_FAILED: Failed to deploy the service. | - +--------------+-----------------------------------------------------------------+ - | 18 | JOBSTAT_CHECK_INIT: The job review is being initialized. | - +--------------+-----------------------------------------------------------------+ - | 19 | JOBSTAT_CHECK_RUNNING: The job is being reviewed. | - +--------------+-----------------------------------------------------------------+ - | 20 | JOBSTAT_CHECK_RUNNING_COMPLETED: The approval job is completed. | - +--------------+-----------------------------------------------------------------+ - | 21 | JOBSTAT_CHECK_FAILED: Failed to review the job. | - +--------------+-----------------------------------------------------------------+ diff --git a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/index.rst b/modelarts/api-ref/result/training_management/resource_and_engine_specifications/index.rst deleted file mode 100644 index d00a6f51..00000000 --- a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_03_0071: - -================================== -Resource and Engine Specifications -================================== - -.. toctree:: - :maxdepth: 1 - - querying_job_resource_specifications - querying_job_engine_specifications diff --git a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_engine_specifications.rst b/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_engine_specifications.rst deleted file mode 100644 index 227a7922..00000000 --- a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_engine_specifications.rst +++ /dev/null @@ -1,132 +0,0 @@ -.. _modelarts_03_0073: - -Querying Job Engine Specifications -================================== - -Function --------- - -This API is used to query the engine type and version of a specified job. - -You must specify the engine specifications when creating a training job or an inference job. - -URI ---- - -GET /v1/{project_id}/job/ai-engines - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0073__en-us_topic_0131307648_table6017292495443: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameters - - +-----------+-----------+--------+--------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+========================================================+ - | job_type | No | String | Job type. The value can be **train** or **inference**. | - +-----------+-----------+--------+--------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0073__en-us_topic_0131307648_table41713500151328: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - | engines | **engines** array | List of engine specifications attributes. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0073__en-us_topic_0131307648_table21589744151355: - -.. table:: **Table 4** **engines** parameters - - +-----------------------+-----------------------+---------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===================================================+ - | engine_type | Integer | Engine type of a training job | - | | | | - | | | - 1: TensorFlow | - | | | - 5: Spark_MLlib | - | | | - 6: Scikit Learn | - | | | - 9: XGBoost-Sklearn | - | | | - 10: PyTorch | - | | | - 13: Ascend-Powered-Engine | - | | | - 17: MindSpore-GPU | - +-----------------------+-----------------------+---------------------------------------------------+ - | engine_id | Long | ID of the engine selected for a training job | - +-----------------------+-----------------------+---------------------------------------------------+ - | engine_name | String | Name of the engine selected for a training job | - +-----------------------+-----------------------+---------------------------------------------------+ - | engine_version | String | Version of the engine selected for a training job | - +-----------------------+-----------------------+---------------------------------------------------+ - -Samples -------- - -The following shows how to query the engine specifications of a training job. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/job/ai-engines?job_type=train - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "engines": [ - { - "engine_type": 1, - "engine_name": "TensorFlow", - "engine_id": 1, - "engine_version": "TF-1.4.0-python2.7" - } - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_resource_specifications.rst b/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_resource_specifications.rst deleted file mode 100644 index 78d9338a..00000000 --- a/modelarts/api-ref/result/training_management/resource_and_engine_specifications/querying_job_resource_specifications.rst +++ /dev/null @@ -1,166 +0,0 @@ -.. _modelarts_03_0072: - -Querying Job Resource Specifications -==================================== - -Function --------- - -This API is used to query the resource specifications of a specified job. - -You must specify the resource specifications when creating a training job or an inference job. - -URI ---- - -GET /v1/{project_id}/job/resource-specs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0072__en-us_topic_0131307647_table5822680595335: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Parameters - - +--------------+-----------+---------+--------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+=========+========================================================+ - | job_type | No | String | Job type. The value can be **train** or **inference**. | - +--------------+-----------+---------+--------------------------------------------------------+ - | engine_id | No | Long | Engine ID of a job. Default value: **0** | - +--------------+-----------+---------+--------------------------------------------------------+ - | project_type | No | Integer | Project type. Default value: **0** | - +--------------+-----------+---------+--------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0072__en-us_topic_0131307647_table1817887315129: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==============================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_total_count | Integer | Total number of job resource specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - | specs | **specs** array | List of resource specifications attributes. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0072__en-us_topic_0131307647_table20408880151239: - -.. table:: **Table 4** **specs** parameters - - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+====================================================================================================================+ - | spec_id | Long | ID of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | core | String | Number of cores of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | cpu | String | CPU memory of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | gpu_num | Integer | Number of GPUs of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | gpu_type | String | GPU type of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | spec_code | String | Type of the resource specifications | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | max_num | Integer | Maximum number of nodes that can be selected | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | unit_num | Integer | Number of pricing units | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | storage | String | SSD size of a resource flavor | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | interface_type | Integer | Interface type | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - | no_resource | Boolean | Whether the resources of the selected specifications are sufficient. True indicates that no resource is available. | - +----------------+---------+--------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the resource specifications of a training job. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/job/resource-specs?job_type=train - -- Successful sample response - - .. code-block:: - - { - "specs": [ - - { - "spec_id": 2, - "core": "2", - "cpu": "8", - "gpu_num": 0, - "gpu_type": "", - "spec_code": "modelarts.vm.cpu.2u", - "unit_num": 1, - "max_num": 2, - "storage": "", - "interface_type": 1, - "no_resource": false - }, - { - "spec_id": 4, - "core": "8", - "cpu": "64", - "gpu_num": 1, - "gpu_type": "v100", - "spec_code":"modelarts.vm.gpu.v100", - "unit_num": 1, - "max_num": 4, - "storage": "", - "interface_type": 1, - "no_resource": false - } - ], - "is_success": true, - "spec_total_count": 2 - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/creating_a_training_job_configuration.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/creating_a_training_job_configuration.rst deleted file mode 100644 index 226aa393..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/creating_a_training_job_configuration.rst +++ /dev/null @@ -1,180 +0,0 @@ -.. _modelarts_03_0058: - -Creating a Training Job Configuration -===================================== - -Function --------- - -This API is used to create a training job configuration. - -URI ---- - -POST /v1/{project_id}/training-job-configs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0058__en-us_topic_0131292962_table20736351173356: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0058__en-us_topic_0131292962_table25599433145051: - -.. table:: **Table 2** Parameters - - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | config_name | Yes | String | Name of a training job configuration. The value is a string of 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-). | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_desc | No | String | Description of a training job configuration. The value is a string of 0 to 256 characters. By default, this parameter is left blank. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Yes | Integer | Number of workers in a training job. Obtain the maximum value from :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | Yes | String | Code directory of a training job, for example, **/usr/app/**. This parameter must be used together with **boot_file_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | Yes | String | Boot file of a training job, which needs to be stored in the code directory, for example, **/usr/app/boot.py**. This parameter must be used together with **app_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Yes | Long | Model ID of a training job. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | No | Array | Running parameters of a training job. It is a collection of label-value pairs. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 4 `. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Yes | Long | ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS URL of the dataset required by a training job, for example, **/usr/data/**. | - | | | | | - | | | | This parameter cannot be used together with **data_source** or **dataset_id** and **dataset_version_id**. However, one of the parameters must exist. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | Yes | JSON Array | Dataset of a training job. This parameter cannot be used together with **data_url** or **dataset_id** and **dataset_version_id**. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Yes | Long | ID of the engine selected for a training job. The default value is **1**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. Obtain the ID by calling the API described in :ref:`Querying Job Engine Specifications `. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | No | String | OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | No | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | No | String | SWR URL of a custom image used by a training job. Example value: **100.125.5.235:20202/jobmng/custom-cpu-base:1.0** | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | No | String | Boot command used to start the container of a custom image of a training job. The format is **bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}**. The **run_train.sh** script needs to be invoked to initialize variables, such as the AK/SK. The **run_train.sh** script is followed by **python** to ensure that the Python files can be executed in the initialized variable environment. **run_train.sh** is used to start Python. | - +--------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **data_source** parameters - - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+================================================================================================================================================+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Yes | String | Dataset type. The value can be **obs** or **dataset**. obs and dataset cannot be used at the same time. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS bucket path. This parameter cannot be used together with **dataset_id** or **dataset_version**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0058__en-us_topic_0131292962_table1267642234716: - -.. table:: **Table 4** **parameter** parameters - - ========= ========= ====== ================ - Parameter Mandatory Type Description - ========= ========= ====== ================ - label No String Parameter name. - value No String Parameter value. - ========= ========= ====== ================ - -Response Body -------------- - -:ref:`Table 5 ` describes the response parameters. - -.. _modelarts_03_0058__en-us_topic_0131292962_table66235177145332: - -.. table:: **Table 5** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -#. The following shows how to create a training job configuration whose name is **testConfig** and description is **This is config**. - - - Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-job-configs - { - "config_name": "testConfig", - "config_desc": "This is config", - "worker_server_num": 1, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "parameter": [ - { - "label": "learning_rate", - "value": "0.01" - }, - { - "label": "batch_size", - "value": "32" - } - ], - "spec_id": 1, - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "engine_id": 1, - "train_url": "/usr/train/", - "log_url": "/usr/log/" - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/deleting_a_training_job_configuration.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/deleting_a_training_job_configuration.rst deleted file mode 100644 index 6178bfa4..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/deleting_a_training_job_configuration.rst +++ /dev/null @@ -1,88 +0,0 @@ -.. _modelarts_03_0061: - -Deleting a Training Job Configuration -===================================== - -Function --------- - -This API is used to delete a training job configuration. - -URI ---- - -DELETE /v1/{project_id}/training-job-configs/{config_name} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0061__en-us_topic_0131292965_table486226859532: - -.. table:: **Table 1** Parameter description - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | config_name | Yes | String | Name of a training job configuration | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0061__en-us_topic_0131292965_table5371703815645: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to delete the job configuration named **test-trainconfig**. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/training-job-configs/test-trainconfig - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/index.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/index.rst deleted file mode 100644 index 7174b658..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_03_0057: - -==================================== -Training Job Parameter Configuration -==================================== - -.. toctree:: - :maxdepth: 1 - - creating_a_training_job_configuration - querying_a_list_of_training_job_configurations - modifying_a_training_job_configuration - deleting_a_training_job_configuration - querying_the_details_about_a_training_job_configuration diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/modifying_a_training_job_configuration.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/modifying_a_training_job_configuration.rst deleted file mode 100644 index 62f88e5b..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/modifying_a_training_job_configuration.rst +++ /dev/null @@ -1,176 +0,0 @@ -.. _modelarts_03_0060: - -Modifying a Training Job Configuration -====================================== - -Function --------- - -This API is used to modify a training job configuration. - -URI ---- - -PUT /v1/{project_id}/training-job-configs/{config_name} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0060__en-us_topic_0131292964_table5935107791848: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | config_name | Yes | String | Name of a training job configuration | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0060__en-us_topic_0131292964_table5503766015447: - -.. table:: **Table 2** Parameters - - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+================================================================================================================================================================================================================================================================================+ - | config_desc | No | String | Description of a training job configuration. The value is a string of 0 to 256 characters. By default, this parameter is left blank. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Yes | Integer | Number of workers in a training job. Obtain the maximum value from :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | Yes | String | Code directory of a training job, for example, **/usr/app/**. This parameter must be used together with **boot_file_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | Yes | String | Boot file of a training job, which needs to be stored in the code directory, for example, **/usr/app/boot.py**. This parameter must be used together with **app_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Yes | Long | Model ID of a training job. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | No | Array | Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a training job uses a custom image. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Yes | Long | ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS URL of the dataset required by a training job, for example, **/usr/data/**. | - | | | | | - | | | | This parameter cannot be used together with **data_source** or **dataset_id** and **dataset_version_id**. However, one of the parameters must exist. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | Yes | JSON Array | Dataset of a training job. This parameter cannot be used together with **data_url** or **dataset_id** and **dataset_version_id**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Yes | Long | ID of the engine selected for a training job. The default value is **1**. Obtain the ID by calling the API described in :ref:`Querying Job Engine Specifications `. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | No | String | OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | No | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | No | String | SWR URL of a custom image used by a training job. Example value: **100.125.5.235:20202/jobmng/custom-cpu-base:1.0** | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | No | String | Boot command used to start the container of a custom image of a training job. The format is **bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}**. | - +--------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **data_source** parameters - - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+================================================================================================================================================+ - | dataset_id | No | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version | No | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | No | String | Dataset type. The value can be **obs** or **dataset**. obs and dataset cannot be used at the same time. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | No | String | OBS bucket path. This parameter cannot be used together with **dataset_id** or **dataset_version**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **parameter** parameters - - ========= ========= ====== ================ - Parameter Mandatory Type Description - ========= ========= ====== ================ - label No String Parameter name. - value No String Parameter value. - ========= ========= ====== ================ - -Response Body -------------- - -:ref:`Table 5 ` describes the response parameters. - -.. _modelarts_03_0060__en-us_topic_0131292964_table5371703815645: - -.. table:: **Table 5** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -#. The following shows how to modify the job parameter configuration named **config**. - - - Sample request - - .. code-block:: - - PUT https://endpoint/v1/{project_id}/training-job-configs/config - - { - "config_desc": "This is config", - "worker_server_num": 1, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "parameter": [ - { - "label": "learning_rate", - "value": 0.01 - }, - { - "key": "batch_size", - "value": 32 - } - ], - "spec_id": 1, - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "engine_id": 1, - "train_url": "/usr/train/", - "log_url": "/usr/log/" - } - - - Successful sample response - - .. code-block:: - - { - "is_success": true - } - - - Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_a_list_of_training_job_configurations.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_a_list_of_training_job_configurations.rst deleted file mode 100644 index 7a745657..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_a_list_of_training_job_configurations.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _modelarts_03_0059: - -Querying a List of Training Job Configurations -============================================== - -Function --------- - -This API is used to query the created training job configurations that meet the search criteria. - -URI ---- - -GET /v1/{project_id}/training-job-configs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0059__en-us_topic_0131292963_table3329924091755: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0059__en-us_topic_0131292963_table19858192884410: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================================================================================================================================+ - | per_page | No | Integer | Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: **10** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page | No | Integer | Index of the page to be queried. Default value: **1** | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sortBy | No | String | Sorting mode of the query. The value can be **config_name**, **config_desc**, or **create_time**. The default value is **config_name**. **create_time** is not supported for **sample** sorting. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. Options: | - | | | | | - | | | | - **asc**: ascending order | - | | | | - **desc**: descending order. The default value is **desc**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Search content, for example, a parameter name. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_type | No | String | Configuration type to be queried. Options: | - | | | | | - | | | | - **custom**: Query the custom configurations. | - | | | | - **sample**: Query the sample configurations. The default value is **custom**. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0059__en-us_topic_0131292963_table1356779515036: - -.. table:: **Table 3** Parameters - - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +====================+============+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. This parameter is not included when the API call succeeds. | - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_total_count | Integer | Total number of the queried training job configurations | - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | configs | JSON Array | **configs** parameters | - +--------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **configs** parameters - - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +================+=========+===================================================================================================================================================================================================+ - | config_name | String | Name of a training job configuration | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_desc | String | Description of a training job configuration | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a training job is created | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Integer | Engine type of a training job | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Name of the engine selected for a training job | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Long | ID of the engine selected for a training job | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_version | String | Version of the engine selected for a training job | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | String | SWR URL of a custom image used by a training job. Example value: **100.125.5.235:20202/jobmng/custom-cpu-base:1.0** | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | String | Boot command used to start the container of a custom image of a training job. The format is **bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}**. | - +----------------+---------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-job-configs?per_page=10&page=1&sortBy=create_time&order=asc&search_content=configname - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "config_total_count": 3, - "configs": [ - { - "config_name": "testConfig", - "config_desc": "This is config", - "create_time": 1524189990635, - "engine_type": 1, - "engine_name": "TensorFlow", - "engine_id": 1, - "engine_version": "TF-1.4.0-python2.7", - "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0", - "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data" - } - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_the_details_about_a_training_job_configuration.rst b/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_the_details_about_a_training_job_configuration.rst deleted file mode 100644 index 8a8934bd..00000000 --- a/modelarts/api-ref/result/training_management/training_job_parameter_configuration/querying_the_details_about_a_training_job_configuration.rst +++ /dev/null @@ -1,306 +0,0 @@ -.. _modelarts_03_0062: - -Querying the Details About a Training Job Configuration -======================================================= - -Function --------- - -This API is used to query the details about a specified training job configuration. - -URI ---- - -GET /v1/{project_id}/training-job-configs/{config_name} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0062__en-us_topic_0131292966_table20736351173356: - -.. table:: **Table 1** Parameters - - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | config_name | Yes | String | Name of a training job configuration | - +-------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0062__en-us_topic_0131292966_table19858192884410: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+==================================================================================+ - | config_type | No | String | Configuration type to be queried. Options: | - | | | | | - | | | | - **custom**: Query the custom configurations. | - | | | | - **sample**: Query the sample configurations. The default value is **custom**. | - +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0062__en-us_topic_0131292966_table40332958145532: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_name | String | Name of a training job configuration | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | config_desc | String | Description of a training job configuration | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Integer | Number of workers in a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | String | Code directory of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | String | Boot file of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Long | Model ID of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | JSON Array | Running parameters of a training job. It is a collection of label-value pairs. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 8 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Long | ID of the resource specifications selected for a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | String | Dataset of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | String | Dataset version ID of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | JSON Array | Datasets of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Integer | Engine type of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Name of the engine selected for a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Long | ID of the engine selected for a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_version | String | Version of the engine selected for a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | String | OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | String | SWR URL of a custom image used by a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | String | Boot command used to start the container of a custom image of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_code | String | Resource specifications selected for a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_type | String | GPU type of the resource specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a training job parameter configuration is created | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cpu | String | CPU memory of the resource specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_num | Integer | Number of GPUs of the resource specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | core | String | Number of cores of the resource specifications | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_name | String | Dataset of a training job | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of a resource pool | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_name | String | Name of a resource pool | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volumes | JSON Array | Storage volume that can be used by a training job. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_mount_path | String | Local mount path of SFS Turbo (NAS). Example value: **/home/work/nas** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_share_addr | String | Shared path of SFS Turbo (NAS). Example value: **192.168.8.150:/** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_type | String | Only NFS is supported. Example value: **nfs** | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **data_source** parameters - - +-----------------------+-----------------------+--------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================+ - | dataset_id | String | Dataset ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | dataset_version | String | Dataset version ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | type | String | Dataset type. Options: | - | | | | - | | | - **obs**: Data from OBS is used. | - | | | | - | | | - **dataset**: Data from a specified dataset is used. | - +-----------------------+-----------------------+--------------------------------------------------------+ - | data_url | String | OBS bucket path | - +-----------------------+-----------------------+--------------------------------------------------------+ - -.. _modelarts_03_0062__en-us_topic_0131292966_table6403153714711: - -.. table:: **Table 5** **volumes** parameters - - +-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======+================================================================================================================================================================================================================================================================================+ - | nfs | JSON | Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see :ref:`Table 6 `. | - +-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_path | JSON | Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see :ref:`Table 7 `. | - +-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0062__en-us_topic_0131292966_table19871043113315: - -.. table:: **Table 6** **nfs** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | ID of an SFS Turbo file system | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | src_path | String | Address of an SFS Turbo file system | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | dest_path | String | Local path of a training job | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | read_only | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | - | | | - **true**: read-only permission | - | | | - **false**: read/write permission. This is the default value. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -.. _modelarts_03_0062__en-us_topic_0131292966_table4873028185611: - -.. table:: **Table 7** **host_path** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | src_path | String | Local path of a host | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | dest_path | String | Local path of a training job | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | read_only | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | - | | | - **true**: read-only permission | - | | | - **false**: read/write permission. This is the default value. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -.. _modelarts_03_0062__en-us_topic_0131292966_table1267642234716: - -.. table:: **Table 8** **parameter** parameters - - ========= ====== =============== - Parameter Type Description - ========= ====== =============== - label String Parameter name - value String Parameter value - ========= ====== =============== - -Samples -------- - -The following shows how to query the details about the job configuration named **config123**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-job-configs/config123 - -- Successful sample response - - .. code-block:: - - { - "spec_code": "modelarts.vm.gpu.v100", - "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0", - "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data", - - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "engine_name": "TensorFlow", - "is_success": true, - "nas_mount_path": "/home/work/nas", - "worker_server_num": 1, - "nas_share_addr": "192.168.8.150:/", - "train_url": "/test/minst/train_out/out1/", - "nas_type": "nfs", - "spec_id": 4, - "parameter": [ - { - "label": "learning_rate", - "value": 0.01 - } - ], - "log_url": "/usr/log/", - "config_name": "config123", - "app_url": "/usr/app/", - "create_time": 1559045426000, - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "volumes": [ - { - "nfs": { - "id": "43b37236-9afa-4855-8174-32254b9562e7", - "src_path": "192.168.8.150:/", - "dest_path": "/home/work/nas", - "read_only": false - } - }, - { - "host_path": { - "src_path": "/root/work", - "dest_path": "/home/mind", - "read_only": false - } - } - ], - "cpu": "64", - "model_id": 4, - "boot_file_url": "/usr/app/boot.py", - "dataset_name": "dataset-test", - "pool_id": "pool9928813f", - "config_desc": "This is a config desc test", - "gpu_num": 1, - "data_source": [ - { - "type": "obs", - "data_url": "/test/minst/data/" - } - ], - "pool_name": "p100", - "dataset_version_name": "dataset-version-test", - "core": "8", - "engine_type": 1, - "engine_id": 3, - "engine_version": "TF-1.8.0-python2.7", - "data_url": "/test/minst/data/" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/creating_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/creating_a_training_job.rst deleted file mode 100644 index 688690a3..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/creating_a_training_job.rst +++ /dev/null @@ -1,349 +0,0 @@ -.. _modelarts_03_0045: - -Creating a Training Job -======================= - -Function --------- - -This API is used to create a training job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Training Job List ` and :ref:`Querying the Details About a Training Job Version `. - -URI ---- - -POST /v1/{project_id}/training-jobs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0045__en-us_topic_0131062889_table143351836151117: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0045__en-us_topic_0131062889_table6270801111211: - -.. table:: **Table 2** Parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+======================================================================================================================================+ - | job_name | Yes | String | Training job name. The value is a string of 1 to 64 characters consisting of only digits, letters, underscores (_), and hyphens (-). | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | job_desc | No | String | Description of a training job. The value is a string of 0 to 256 characters. By default, this parameter is left blank. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | config | Yes | JSON | Parameters for creating a training job | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace where a job resides. Default value: **0** | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **config** parameters - - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+=================+=================+===============================================================================================================================================================================================================================================================================================================================================================================================================+ - | worker_server_num | Yes | Integer | Number of workers in a training job. Obtain the maximum value from the **max_num** value returned by the API in :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | Yes | String | Code directory of a training job, for example, **/usr/app/**. This parameter must be used together with **boot_file_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | Yes | String | Boot file of a training job, which needs to be stored in the code directory. Example value: **/usr/app/boot.py** This parameter must be used together with **app_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | No | Array | Running parameters of a training job. It is a collection of label-value pairs. Values can be customized. **label** is a parameter name and **value** is the parameter value. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 8 `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS URL of the dataset required by a training job. By default, this parameter is left blank. For example, **/usr/data/**. This parameter cannot be used together with **data_source** or **dataset_id** and **dataset_version_id**. However, one of the parameters must exist. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | Yes | Array | Dataset of a training job. This parameter cannot be used together with **data_url** or **dataset_id** and **dataset_version_id**. For details, see :ref:`Table 4 `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Yes | Long | ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Yes | Long | ID of the engine selected for a training job. The default value is **1**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. Obtain the ID by calling the API described in :ref:`Querying Job Engine Specifications `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | No | String | OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | No | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/log/** | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | No | String | SWR URL of a custom image used by a training job. Example value: **100.125.5.235:20202/jobmng/custom-cpu-base:1.0** | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | No | String | Boot command used to start the container of a custom image of a training job. The format is **bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}**. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_version | No | Boolean | Whether a version is created when a training job is created | - | | | | | - | | | | - **true**: Default value. A version is created when a training job is created. | - | | | | - **false**: A version is not created when a training job is created. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volumes | No | JSON Array | Storage volume that can be used by a training job. For details, see :ref:`Table 5 `. | - +--------------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0045__en-us_topic_0131062889_table250595919011: - -.. table:: **Table 4** **data_source** parameters - - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+================================================================================================================================================+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Yes | String | Dataset type. The value can be **obs** or **dataset**. **obs** and **dataset** cannot be used at the same time. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS bucket path. This parameter cannot be used together with **dataset_id** or **dataset_version**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0045__en-us_topic_0131062889_table6403153714711: - -.. table:: **Table 5** **volumes** parameters - - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+======+================================================================================================================================================================================================================================================================================+ - | nfs | No | JSON | Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see :ref:`Table 6 `. | - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_path | No | JSON | Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see :ref:`Table 7 `. | - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0045__en-us_topic_0131062889_table19871043113315: - -.. table:: **Table 6** **nfs** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | id | Yes | String | ID of an SFS Turbo file system | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | src_path | Yes | String | Address of an SFS Turbo file system | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | dest_path | Yes | String | Local path of a training job | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | read_only | No | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | | - | | | | - **true**: read-only permission | - | | | | - **false**: read/write permission. This is the default value. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -.. _modelarts_03_0045__en-us_topic_0131062889_table4873028185611: - -.. table:: **Table 7** **host_path** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | src_path | Yes | String | Local path of a host | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | dest_path | Yes | String | Local path of a training job | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | read_only | No | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | | - | | | | - **true**: read-only permission | - | | | | - **false**: read/write permission. This is the default value. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -.. _modelarts_03_0045__en-us_topic_0131062889_table1267642234716: - -.. table:: **Table 8** **parameter** parameters - - ========= ========= ====== =============== - Parameter Mandatory Type Description - ========= ========= ====== =============== - label No String Parameter name - value No String Parameter value - ========= ========= ====== =============== - -Response Body -------------- - -:ref:`Table 9 ` describes the response parameters. - -.. _modelarts_03_0045__en-us_topic_0131062889_table84321612917: - -.. table:: **Table 9** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | status | Int | Status of a training job. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Timestamp when a training job is created | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | version_id | Long | Version ID of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Charged resource ID of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - | version_name | String | Version name of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -#. The following shows how to create training job **TestModelArtsJob** with **This is a ModelArts job** as its description. - - - Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-jobs - { - "job_name": "TestModelArtsJob", - "job_desc": "This is a ModelArts job", - "workspace_id": "af261af2218841ec960b01ab3cf1a5fa", - "config": { - "worker_server_num": 1, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "parameter": [ - { - "label": "learning_rate", - "value": "0.01" - }, - { - "label": "batch_size", - "value": "32" - } - ], - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "spec_id": 1, - "engine_id": 1, - "train_url": "/usr/train/", - "log_url": "/usr/log/" - } - } - -#. The following shows how to create training job **TestModelArtsJob2** with a custom image. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-jobs - { - "job_name": "TestModelArtsJob2", - "job_desc": "This is a ModelArts job", - "workspace_id": "af261af2218841ec960b01ab3cf1a5fa", - "config": { - "worker_server_num": 1, - "data_url": "/usr/data/", - "app_url": "/usr/app/", - "parameter": [ - { - "label": "CUSTOM_PARAM1", - "value": "1" - } - ], - "spec_id": 1, - "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data", - "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0", - "train_url": "/usr/train/", - "log_url": "/usr/log/" - } - } - -3. The following shows how to create training job **TestModelArtsJob3** using a storage volume. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-jobs - { - "job_name": "TestModelArtsJob3", - "job_desc": "This is a ModelArts job", - "workspace_id": "af261af2218841ec960b01ab3cf1a5fa", - "config": { - "worker_server_num": 1, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "parameter": [ - { - "label": "learning_rate", - "value": "0.01" - }, - { - "label": "batch_size", - "value": "32" - } - ], - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "spec_id": 1, - "engine_id": 1, - "train_url": "/usr/train/", - "log_url": "/usr/log/", - "volumes": [ - { - "nfs": { - "id": "43b37236-9afa-4855-8174-32254b9562e7", - "src_path": "192.168.8.150:/", - "dest_path": "/home/work/nas", - "read_only": false - } - }, - { - "host_path": { - "src_path": "/root/work", - "dest_path": "/home/mind", - "read_only": false - } - } - ] - } - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "job_id": "10", - "job_name": "TestModelArtsJob", - "status": "1", - "create_time": "1524189990635", - "version_id": "10", - "version_name": "V0001", - "resource_id": "jobafd08896" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Job name:TestModelArtsJob is existed", - "error_code": "ModelArts.0103" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/creating_a_version_of_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/creating_a_version_of_a_training_job.rst deleted file mode 100644 index 54015565..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/creating_a_version_of_a_training_job.rst +++ /dev/null @@ -1,210 +0,0 @@ -.. _modelarts_03_0050: - -Creating a Version of a Training Job -==================================== - -Function --------- - -This API is used to create a version of a training job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Training Job List ` and :ref:`Querying the Details About a Training Job Version `. - -URI ---- - -POST /v1/{project_id}/training-jobs/{job_id}/versions - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0050__en-us_topic_0131276316_table126693715562: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0050__en-us_topic_0131276316_table6270801111211: - -.. table:: **Table 2** Request parameters - - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+========================================================================================================================+ - | job_desc | No | String | Description of a training job. The value is a string of 0 to 256 characters. By default, this parameter is left blank. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------+ - | config | Yes | JSON | Parameters for creating a training job | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **config** parameters - - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +====================+===========+===============+=================================================================================================================================================================================================================================================================================================================+ - | worker_server_num | Yes | Integer | Number of workers in a training job. Obtain the maximum value from :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | Yes | String | Code directory of a training job, for example, **/usr/app/**. This parameter must be used together with **boot_file_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | Yes | String | Boot file of a training job, which needs to be stored in the code directory. Example value: **/usr/app/boot.py** This parameter must be used together with **app_url**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | No | Array | Running parameters of a training job. It is a collection of label-value pairs. For details, see the sample request. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 5 `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS URL of the dataset required by a training job. By default, this parameter is left blank. For example, **/usr/data/**. This parameter cannot be used together with **data_source** or **dataset_id** and **dataset_version_id**. However, one of the parameters must exist. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url** or **data_source**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | No | JSON Array | Dataset of a training job. This parameter cannot be used with **data_url**, **dataset_id**, or **dataset_version_id**. For details, see :ref:`Table 4 `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Yes | Long | ID of the resource specifications selected for a training job. Obtain the ID by calling the API described in :ref:`Querying Job Resource Specifications `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Yes | Long | ID of the engine selected for a training job. The default value is **1**. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. Obtain the ID by calling the API described in :ref:`Querying Job Engine Specifications `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Yes | Long | ID of the built-in model of a training job. After setting **model_id**, you do not need to set **app_url** or **boot_file_url**, and **engine_id**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | Yes | String | OBS URL of the output file of a training job. By default, this parameter is left blank. Example value: **/bucket/trainUrl/** | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | No | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pre_version_id | Yes | Long | ID of the previous version of a training job. You can obtain the value of **version_id** by calling the API described in :ref:`Querying a List of Training Job Versions `. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | No | String | SWR URL of a custom image used by a training job. Example value: **100.125.5.235:20202/jobmng/custom-cpu-base:1.0** | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | No | String | Boot command used to start the container of a custom image of a training job. The format is **bash /home/work/run_train.sh python /home/work/user-job-dir/app/train.py {python_file_parameter}**. | - +--------------------+-----------+---------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0050__en-us_topic_0131276316_table8406183645819: - -.. table:: **Table 4** **data_source** parameters - - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+===========+========+================================================================================================================================================+ - | dataset_id | Yes | String | Dataset ID of a training job. This parameter must be used together with **dataset_version_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version | Yes | String | Dataset version ID of a training job. This parameter must be used together with **dataset_id**, but cannot be used together with **data_url**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | type | Yes | String | Dataset type. The value can be **obs** or **dataset**. **obs** and **dataset** cannot be used at the same time. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | Yes | String | OBS bucket path. This parameter cannot be used together with **dataset_id** or **dataset_version**. | - +-----------------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0050__en-us_topic_0131276316_table1267642234716: - -.. table:: **Table 5** **parameter** parameters - - ========= ========= ====== =============== - Parameter Mandatory Type Description - ========= ========= ====== =============== - label No String Parameter name - value No String Parameter value - ========= ========= ====== =============== - -Response Body -------------- - -:ref:`Table 6 ` describes the response parameters. - -.. _modelarts_03_0050__en-us_topic_0131276316_table1221422915578: - -.. table:: **Table 6** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Int | Status of a training job. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Timestamp when a training job is created | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | Long | Version ID of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Version name of a training job | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -#. The following shows how to create a job whose **job_id** is **10** and **pre_version_id** is **20**. - - - Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-jobs/10/versions/ - { - "job_desc": "This is a ModelArts job", - "config": { - "worker_server_num": 1, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "parameter": [ - { - "label": "learning_rate", - "value": "0.01" - }, - { - "label": "batch_size", - "value": "32" - } - ], - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "spec_id": 1, - "engine_id": 1, - "train_url": "/usr/train/", - "log_url": "/usr/log/", - "pre_version_id": 20 - } - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "job_id": 10, - "job_name": "TestModelArtsJob", - "status": 1, - "create_time": 1524189990635, - "version_id": 10, - "version_name":""V0001" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/deleting_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/deleting_a_training_job.rst deleted file mode 100644 index 6d0bc0bf..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/deleting_a_training_job.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _modelarts_03_0053: - -Deleting a Training Job -======================= - -Function --------- - -This API is used to delete a training job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Training Job List ` and :ref:`Querying the Details About a Training Job Version `. - -URI ---- - -DELETE /v1/{project_id}/training-jobs/{job_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0053__en-us_topic_0131151012_table126693715562: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0053__en-us_topic_0131151012_table1221422915578: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to delete the job whose **job_id** is **10**. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/training-jobs/10 - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/deleting_a_version_of_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/deleting_a_version_of_a_training_job.rst deleted file mode 100644 index f7e1245a..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/deleting_a_version_of_a_training_job.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_03_0048: - -Deleting a Version of a Training Job -==================================== - -Function --------- - -This API is used to delete a version of a training job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Training Job List ` and :ref:`Querying the Details About a Training Job Version `. - -URI ---- - -DELETE /v1/{project_id}/training-jobs/{job_id}/versions/{version_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0048__en-us_topic_0131151009_table126693715562: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0048__en-us_topic_0131151009_table1221422915578: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/training-jobs/10/versions/10 - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/index.rst b/modelarts/api-ref/result/training_management/training_jobs/index.rst deleted file mode 100644 index c0b2d456..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_03_0044: - -============= -Training Jobs -============= - -.. toctree:: - :maxdepth: 1 - - creating_a_training_job - querying_a_training_job_list - querying_the_details_about_a_training_job_version - deleting_a_version_of_a_training_job - querying_a_list_of_training_job_versions - creating_a_version_of_a_training_job - stopping_a_training_job - modifying_the_description_of_a_training_job - deleting_a_training_job - obtaining_the_name_of_a_training_job_log_file - querying_a_built-in_algorithm - querying_training_job_logs - querying_monitoring_information_about_a_single_container_of_a_job - querying_monitoring_information_about_resource_pool_nodes - querying_the_statuses_and_gpu_quantity_of_all_job_versions diff --git a/modelarts/api-ref/result/training_management/training_jobs/modifying_the_description_of_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/modifying_the_description_of_a_training_job.rst deleted file mode 100644 index 7854129e..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/modifying_the_description_of_a_training_job.rst +++ /dev/null @@ -1,101 +0,0 @@ -.. _modelarts_03_0052: - -Modifying the Description of a Training Job -=========================================== - -Function --------- - -This API is used to modify the description of a training job. - -URI ---- - -PUT /v1/{project_id}/training-jobs/{job_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0052__en-us_topic_0131151011_table27718806153710: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0052__en-us_topic_0131151011_table54779414153816: - -.. table:: **Table 2** Parameters - - +-----------+-----------+--------+------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==============================================================================+ - | job_desc | Yes | String | Description of a training job. The value is a string of 0 to 256 characters. | - +-----------+-----------+--------+------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0052__en-us_topic_0131151011_table10292351155335: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to modify the description of the job whose **job_id** is **10**. - -- Sample request - - .. code-block:: - - PUT https://endpoint/v1/{project_id}/training-jobs/10 - { - "job_desc": "This is a ModelArts job" - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/obtaining_the_name_of_a_training_job_log_file.rst b/modelarts/api-ref/result/training_management/training_jobs/obtaining_the_name_of_a_training_job_log_file.rst deleted file mode 100644 index 7370045f..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/obtaining_the_name_of_a_training_job_log_file.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. _modelarts_03_0054: - -Obtaining the Name of a Training Job Log File -============================================= - -Function --------- - -This API is used to obtain the name of a training job log file. - -URI ---- - -GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/log/file-names - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0054__en-us_topic_0131304290_table4669394316232: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0054__en-us_topic_0131304290_table3969737616316: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_file_list | String | Log file name of a training job. A single-node job has only one log file, and a distributed job has multiple log files. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to obtain the log files of the job whose **job_id** is **10** and **version_id** is **10**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/10/versions/10/log/file-names - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "log_file_list": [ - "teseJob.0" - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_a_built-in_algorithm.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_a_built-in_algorithm.rst deleted file mode 100644 index 499c76d1..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_a_built-in_algorithm.rst +++ /dev/null @@ -1,194 +0,0 @@ -.. _modelarts_03_0056: - -Querying a Built-in Algorithm -============================= - -Function --------- - -This API is used to query the details about a built-in model. - -URI ---- - -GET /v1/{project_id}/built-in-algorithms - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0056__en-us_topic_0131380352_table37435132101942: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0056__en-us_topic_0131380352_table16279151181311: - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=================================================================================================================================================================================================================+ - | per_page | No | Integer | Number of job parameters displayed on each page. The value range is [1, 100]. Default value: **10** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page | No | Integer | Index of the page to be queried. Default value: **1** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sortBy | No | String | Sorting mode of the query. The value can be **engine**, **model_name**, **model_precision**, **model_usage**, **model_precision**, **model_size**, **create_time**, or **parameter**. Default value: **engine** | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order | - | | | | - **desc**: descending order. The default value is **desc**. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Search content, for example, a parameter name. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0056__en-us_topic_0131380352_table10251721151647: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+======================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_total_count | Integer | Number of models | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - | models | Array | Model parameter list. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0056__en-us_topic_0131380352_table29182771151827: - -.. table:: **Table 4** **models** structure data - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================================================================+ - | model_id | Integer | Model ID | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_name | String | Model name | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_usage | Integer | Model usage. The options are as follows: | - | | | | - | | | - 1: image classification | - | | | - 2: object class and location | - | | | - 3: image semantic segmentation | - | | | - 4: natural language processing | - | | | - 5: image embedding | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_precision | String | Model precision | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_size | Long | Model size, in bytes | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_train_dataset | String | Model training dataset | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_dataset_format | String | Dataset format required by a model | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_description_url | String | URL of the model description | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | String | Running parameters of a model. This parameter is a container environment variable when a training job uses a custom image. For details, see the sample request. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a model is created | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Long | Engine ID of a model | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Engine name of a model | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_version | String | Engine version of a model | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 5** **parameter** parameters - - ========= ======= ================================ - Parameter Type Description - ========= ======= ================================ - label String Parameter name - value String Parameter value - required Boolean Whether a parameter is mandatory - ========= ======= ================================ - -Samples -------- - -The following shows how to query the algorithm whose name contains **configname**. - -- Sample request - - .. code-block:: - - GET https://endpoint//v1/{project_id}/built-in-algorithms?per_page=10&page=1&sortBy=engine&order=asc&search_content=model - -- Successful sample response - - .. code-block:: - - { - "models": [ - { - "model_id": 4, - "model_name": "ResNet_v2_50", - "model_usage": 1, - "model_precision": "75.55%(top1), 92.6%(top5)", - "model_size": 102503801, - "model_train_dataset": "ImageNet, 1,000 classes for image classification", - "model_dataset_format": "shape: [H>=32, W>=32, C>=1]; type: int8", - "model_description_url": "https://github.com/apache/incubator-mxnet/blob/master/example/image-classification/symbols/resnet.py", - "parameter": "[{\"label\":\"batch_size\",\"value\":\"4\",\"placeholder_cn\":\"Total number of training images updated each time\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"lr\",\"value\":\"0.0001\",\"placeholder_cn\":\"Learning rate\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"save_frequency\",\"value\":\"1\",\"placeholder_cn\":\"Interval for saving the model, indicating that the model is saved every N epochs\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_classes\",\"value\":\"\",\"placeholder_cn\":\"Total number of image classes in training\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_epoch\",\"value\":\"10\",\"placeholder_cn\":\"Number of training epochs\",\"placeholder_en\":\"\",\"required\":true}]", - "create_time": 1522218780025, - "engine_id": 501, - "engine_name": "MXNet", - "engine_version": "MXNet-1.2.1-python2.7" - }, - { - "model_id": 5, - "model_name": "Faster_RCNN_ResNet_v2_101", - "model_usage": 2, - "model_precision": "80.05%(mAP)", - "model_size": 190936449, - "model_train_dataset": "PASCAL VOC2007, 20 classes for object detection", - "model_dataset_format": "shape: [H, W, C==3]; type: int8", - "model_description_url": "https://github.com/apache/incubator-mxnet/tree/master/example/rcnn", - "parameter": "[{\"label\":\"lr\",\"value\":\"0.0001\",\"placeholder_cn\":\"Learning rate\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"eval_frequence\",\"value\":\"1\",\"placeholder_cn\":\"Frequency for validating the model. By default, validation is performed every epoch.\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"mom\",\"value\":\"0.9\",\"placeholder_cn\":\"Momentum of the training network\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"wd\",\"value\":\"0.0005\",\"placeholder_cn\":\"Weight decay coefficient\",\"placeholder_en\":\"\",\"required\":true},{\"label\":\"num_classes\",\"value\":\"\",\"placeholder_cn\":\"Total number of image classes in training. The value must plus 1 because there is a background class.\",\"placeholder_en\":\"\",\"required\":true}]", - "create_time": 1525313224596, - "engine_id": 501, - "engine_name": "MXNet", - "engine_version": "MXNet-1.2.1-python2.7" - } - ], - "model_total_count": 41, - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_a_list_of_training_job_versions.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_a_list_of_training_job_versions.rst deleted file mode 100644 index ca5a101f..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_a_list_of_training_job_versions.rst +++ /dev/null @@ -1,432 +0,0 @@ -.. _modelarts_03_0049: - -Querying a List of Training Job Versions -======================================== - -Function --------- - -This API is used to query the version of a specified training job based on the job ID. - -URI ---- - -GET /v1/{project_id}/training-jobs/{job_id}/versions - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0049__en-us_topic_0131276315_table126693715562: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0049__en-us_topic_0131276315_table19858192884410: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+======================================================================================================+ - | per_page | No | Integer | Number of job parameters displayed on each page. The value range is [1, 1000]. Default value: **10** | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - | page | No | Integer | Index of the page to be queried | - | | | | | - | | | | - If paging is required, set **page** to **1**. | - | | | | - The default value of **page** is **0**, indicating that paging is not supported. | - +-----------------+-----------------+-----------------+------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0049__en-us_topic_0131276315_table2700823414458: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a training job | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | job_name | String | Name of a training job | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | job_desc | String | Description of a training job | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | version_count | Long | Number of versions of a training job | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | versions | JSON Array | Version parameters of a training job. For details, see the sample response. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **versions** parameters - - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +======================+============+====================================================================================================================================================================================================================================+ - | version_id | Long | Version ID of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Version name of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pre_version_id | Long | ID of the previous version of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Long | Engine type of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Name of the engine selected for a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Long | ID of the engine selected for a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_version | String | Version of the engine selected for a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Int | Status of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | String | Code directory of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | String | Boot file of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a training job is created | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | JSON Array | Running parameters of a training job. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 5 `. | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Long | Training job running duration, in milliseconds | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Long | ID of the resource specifications selected for a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | core | String | Number of cores of the resource specifications | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cpu | String | CPU memory of the resource specifications | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_num | Integer | Number of GPUs of the resource specifications | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_type | String | GPU type of the resource specifications | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Integer | Number of workers in a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | String | Dataset of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | String | OBS path of the training job output file | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/log/** | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | String | Dataset version ID of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | JSON Array | Datasets of a training job. For details, see :ref:`Table 6 `. | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Long | Model ID of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_metric_list | String | Model metrics of a training job. For details, see :ref:`Table 7 `. | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | system_metric_list | String | System monitoring metrics of a training job. For details, see :ref:`Table 8 `. | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | String | SWR URL of a custom image used by a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | String | Boot command used to start the container of a custom image of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Charged resource ID of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Long | Training start time | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volumes | JSON Array | Storage volume that can be used by a training job. For details, see :ref:`Table 13 `. | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_name | String | Dataset of a training job | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_name | String | Name of a resource pool | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of a resource pool | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_mount_path | String | Local mount path of SFS Turbo (NAS). Example value: **/home/work/nas** | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_share_addr | String | Shared path of SFS Turbo (NAS). Example value: **192.168.8.150:/** | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_type | String | Only NFS is supported. Example value: **nfs** | - +----------------------+------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table15296852152820: - -.. table:: **Table 5** **parameter** parameters - - ========= ====== =============== - Parameter Type Description - ========= ====== =============== - label String Parameter name - value String Parameter value - ========= ====== =============== - -.. _modelarts_03_0049__en-us_topic_0131276315_table250595919011: - -.. table:: **Table 6** **data_source** parameters - - +-----------------------+-----------------------+--------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================+ - | dataset_id | String | Dataset ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | dataset_version | String | Dataset version ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | type | String | Dataset type | - | | | | - | | | - **obs**: Data from OBS is used. | - | | | - **dataset**: Data from a specified dataset is used. | - +-----------------------+-----------------------+--------------------------------------------------------+ - | data_url | String | OBS bucket path | - +-----------------------+-----------------------+--------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table929111514598: - -.. table:: **Table 7** **model_metric_list** parameters - - +--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+============+==================================================================================================================================================+ - | metric | JSON Array | Validation metrics of a classification of a training job | - +--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_metric | JSON | Overall validation parameters of a training job. For details, see :ref:`Table 11 `. | - +--------------+------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table199981042536: - -.. table:: **Table 8** **system_metric_list** parameters - - ========= ===== ============================== - Parameter Type Description - ========= ===== ============================== - cpuUsage Array CPU usage of a training job - memUsage Array Memory usage of a training job - gpuUtil Array GPU usage of a training job - ========= ===== ============================== - -.. table:: **Table 9** **metric** parameters - - +---------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+======+===========================================================================================================================================================+ - | metric_values | JSON | Validation metrics of a classification of a training job. For details, see :ref:`Table 10 `. | - +---------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reserved_data | JSON | Reserved parameter | - +---------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metric_meta | JSON | Classification of a training job, including the classification ID and name | - +---------------+------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table162521255132: - -.. table:: **Table 10** **metric_values** parameters - - ========= ===== =============================================== - Parameter Type Description - ========= ===== =============================================== - recall Float Recall of a classification of a training job - precision Float Precision of a classification of a training job - accuracy Float Accuracy of a classification of a training job - ========= ===== =============================================== - -.. _modelarts_03_0049__en-us_topic_0131276315_table102963631010: - -.. table:: **Table 11** **total_metric** parameters - - +---------------------+------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+============+=================================================================================================================================================+ - | total_metric_meta | JSON Array | Reserved parameter | - +---------------------+------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_reserved_data | JSON Array | Reserved parameter | - +---------------------+------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_metric_values | JSON Array | Overall validation metrics of a training job. For details, see :ref:`Table 12 `. | - +---------------------+------------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table45171749171414: - -.. table:: **Table 12** **total_metric_values** parameters - - +-----------+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+=======+=============================================================================================================================================+ - | f1_score | Float | F1 score of a training job. This parameter is used only by some preset algorithms and is automatically generated. It is for reference only. | - +-----------+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | recall | Float | Total recall of a training job | - +-----------+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | precision | Float | Total precision of a training job | - +-----------+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ - | accuracy | Float | Total accuracy of a training job | - +-----------+-------+---------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table6403153714711: - -.. table:: **Table 13** **volumes** parameters - - +-----------+------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+======+=================================================================================================================================================================================================================================================================================+ - | nfs | JSON | Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see :ref:`Table 14 `. | - +-----------+------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_path | JSON | Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see :ref:`Table 15 `. | - +-----------+------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table19871043113315: - -.. table:: **Table 14** **nfs** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | id | String | ID of an SFS Turbo file system | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | src_path | String | Address of an SFS Turbo file system | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | dest_path | String | Local path of a training job | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | read_only | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | - | | | - **true**: read-only permission | - | | | - **false**: read/write permission. This is the default value. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -.. _modelarts_03_0049__en-us_topic_0131276315_table4873028185611: - -.. table:: **Table 15** **host_path** parameters - - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================+ - | src_path | String | Local path of a host | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | dest_path | String | Local path of a training job | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - | read_only | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | - | | | - **true**: read-only permission | - | | | - **false**: read/write permission. This is the default value. | - +-----------------------+-----------------------+---------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the job version details on the first page when **job_id** is set to **10** and five records are displayed on each page. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/10/versions?per_page=5&page=1 - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "job_id": 10, - "job_name": "testModelArtsJob", - "job_desc": "testModelArtsJob desc", - "version_count": 2, - "versions": [ - { - "version_id": 10, - "version_name": "V0004", - "pre_version_id": 5, - "engine_type": 1, - "engine_name": "TensorFlow", - "engine_id": 1, - "engine_version": "TF-1.4.0-python2.7", - "status": 10, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "create_time": 1524189990635, - "parameter": [ - { - "label": "learning_rate", - "value": 0.01 - } - ], - "duration": 532003, - "spec_id": 1, - "core": 2, - "cpu": 8, - "gpu_num": 2, - "gpu_type": "P100", - "worker_server_num": 1, - "data_url": "/usr/data/", - "train_url": "/usr/train/", - "log_url": "/usr/log/", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "data_source": [ - { - "type": "obs", - "data_url": "/qianjiajun-test/minst/data/" - } - ], - "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0", - "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data", - "model_id": 1, - "model_metric_list": "{\"metric\":[{\"metric_values\":{\"recall\":0.005833,\"precision\":0.000178,\"accuracy\":0.000937},\"reserved_data\":{},\"metric_meta\":{\"class_name\":0,\"class_id\":0}}],\"total_metric\":{\"total_metric_meta\":{},\"total_reserved_data\":{},\"total_metric_values\":{\"recall\":0.005833,\"id\":0,\"precision\":0.000178,\"accuracy\":0.000937}}}", - "system_metric_list": "{\"cpuUsage\":[\"0\",\"3.10\",\"5.76\",\"0\",\"0\",\"0\",\"0\"],\"memUsage\":[\"0\",\"0.77\",\"2.09\",\"0\",\"0\",\"0\",\"0\"],\"gpuUtil\":[\"0\",\"0.25\",\"0.88\",\"0\",\"0\",\"0\",\"0\"],\"gpuMemUsage\":[\"0\",\"0.65\",\"6.01\",\"0\",\"0\",\"0\",\"0\"],\"diskReadRate\":[\"0\",\"91811.07\",\"38846.63\",\"0\",\"0\",\"0\",\"0\"],\"diskWriteRate\":[\"0\",\"2.23\",\"0.94\",\"0\",\"0\",\"0\",\"0\"],\"recvBytesRate\":[\"0\",\"5770405.50\",\"2980077.75\",\"0\",\"0\",\"0\",\"0\"],\"sendBytesRate\":[\"0\",\"12607.17\",\"10487410.00\",\"0\",\"0\",\"0\",\"0\"],\"interval\":1}", - "dataset_name": "dataset-test", - "dataset_version_name": "dataset-version-test", - - "start_time": 1563172362000, - "volumes": [ - { - "nfs": { - "id": "43b37236-9afa-4855-8174-32254b9562e7", - "src_path": "192.168.8.150:/", - "dest_path": "/home/work/nas", - "read_only": false - } - }, - { - "host_path": { - "src_path": "/root/work", - "dest_path": "/home/mind", - "read_only": false - } - } - ], - "pool_id": "pool9928813f", - "pool_name": "p100", - "nas_mount_path": "/home/work/nas", - "nas_share_addr": "192.168.8.150:/", - "nas_type": "nfs" - } - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_a_training_job_list.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_a_training_job_list.rst deleted file mode 100644 index 2fc3e471..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_a_training_job_list.rst +++ /dev/null @@ -1,161 +0,0 @@ -.. _modelarts_03_0046: - -Querying a Training Job List -============================ - -Function --------- - -This API is used to query the created training jobs that meet the search criteria. - -URI ---- - -GET /v1/{project_id}/training-jobs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0046__en-us_topic_0131145861_table16518993181628: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0046__en-us_topic_0131145861_table125324323545: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================================================+ - | status | No | String | Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of **status** to **3**, **5**, **6**, or **13**. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | per_page | No | Integer | Number of jobs displayed on each page. The value range is [1, 1000]. Default value: **10** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page | No | Integer | Index of the page to be queried. Default value: **1** The value range is [1, 65535]. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sortBy | No | String | Sorting mode of the query. The value can be **job_name**, **job_desc**, **status**, **duration**, **version_count**, or **create_time**. Default value: **job_name** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. The options are as follows: | - | | | | | - | | | | - **asc**: ascending order. It is the default value. | - | | | | - **desc**: descending order | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Search content, for example, a training job name. The value is a string of 0 to 64 characters. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace where a job resides. Default value: **0** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0046__en-us_topic_0131145861_table31621671103510: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | job_total_count | Integer | Total number of created jobs | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | job_count_limit | Integer | Number of training jobs that can be created | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | jobs | **jobs** array | Attributes of a training job. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | quotas | Integer | Maximum number of training jobs | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0046__en-us_topic_0131145861_table3971109103614: - -.. table:: **Table 4** **jobs** parameters - - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+========+============================================================================================================+ - | job_id | Long | ID of a training job | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a training job | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | version_id | Long | Version ID of a training job | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | status | Int | Status of a training job. For details about the job statuses, see :ref:`Job Statuses `. | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Timestamp when a training job is created | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | duration | Long | Training job running duration, in milliseconds | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | job_desc | String | Description of a training job | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - | version_count | Long | Number of versions of a training job | - +---------------+--------+------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query training jobs whose status is **7** and whose name contains **job** on the first page. Each page displays 10 records sorted by **job_name** in ascending order. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs?status=7&per_page=10&page=1&sortBy=job_name&order=asc&search_content=job - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "quotas": 5, - "job_total_count": 1, - "job_count_limit": 3, - "jobs": [ - { - "job_id": 10, - "job_name": "testModelArtsJob", - "version_id": 10, - "status": 10, - "create_time": 1524189990635, - "duration": 532003, - "job_desc": "This is ModelArts job", - "version_count": 5 - } - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_a_single_container_of_a_job.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_a_single_container_of_a_job.rst deleted file mode 100644 index 1ff3e2bf..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_a_single_container_of_a_job.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. _modelarts_03_0150: - -Querying Monitoring Information About a Single Container of a Job -================================================================= - -Function --------- - -This API is used to query monitoring information about a single container of a job. - -URI ---- - -GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/pod/{pod_name}/metric-statistic - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0150__en-us_topic_0188079018_table4442765616454: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=================================================================================================================================================================================+ - | project_id | Yes | String | Project ID | - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pod_name | Yes | String | Container name, which is the same as the job log name. For details about how to obtain the value, see :ref:`Obtaining the Name of a Training Job Log File `. | - +------------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0150__en-us_topic_0188079018_table87520312215: - -.. table:: **Table 2** Parameter description - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================+ - | metrics | No | String | Metrics to be queried. Separate metrics by commas (,), for example, **CpuUsage,MemUsage**. If this parameter is left blank, all metrics are queried. | - | | | | | - | | | | Options: | - | | | | | - | | | | - CpuUsage | - | | | | - MemUsage | - | | | | - DiskReadRate | - | | | | - DiskWriteRate | - | | | | - RecvBytesRate | - | | | | - SendBytesRate | - | | | | - GpuUtil | - | | | | - GpuMemUsage | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | statistic_type | No | String | Metric statistics method, indicating whether to collect metric statistics based on a single GPU. This parameter applies only to GPU metric statistics. | - | | | | | - | | | | - **all**: Obtain the average value of the metric. | - | | | | - **each**: Obtain the metric monitoring information about each GPU. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0150__en-us_topic_0188079018_table1414514116749: - -.. table:: **Table 3** Parameter description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | error_message | String | Error message when the API call fails. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code when the API call fails. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | metrics | JSON Array | Metric monitoring details. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | interval | Integer | Query interval, in minutes. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0150__en-us_topic_0188079018_table8361164171810: - -.. table:: **Table 4** **metrics** data structure - - +-----------+------------+---------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+============+===========================================================================+ - | metric | String | Monitoring metrics | - +-----------+------------+---------------------------------------------------------------------------+ - | value | JSON Array | Sequence of the obtained metric value. The element is of the String type. | - +-----------+------------+---------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the logs contained in **log1.log** of the job whose **job_id** is **10** and **version_id** is **10**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/10/versions/10/pod/pod1/metric-statistic?metrics=gpuUtil - -- Successful sample response - - .. code-block:: - - { - "metrics": - [ - { - "metric":"gpuUtil", - "value":["1","22","33"] - } - ], - "interval" : 1 - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_resource_pool_nodes.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_resource_pool_nodes.rst deleted file mode 100644 index 28a0a4c0..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_monitoring_information_about_resource_pool_nodes.rst +++ /dev/null @@ -1,138 +0,0 @@ -.. _modelarts_03_0151: - -Querying Monitoring Information About Resource Pool Nodes -========================================================= - -Function --------- - -This API is used to query monitoring information about resource pool nodes. - -URI ---- - -GET /v1/{project_id}/pools/{pool_id}/nodes/{node_ip}/metric-statistic - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0151__en-us_topic_0188079989_table4442765616454: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=======================================================================================================+ - | project_id | Yes | String | Project ID | - +------------+-----------+--------+-------------------------------------------------------------------------------------------------------+ - | pool_id | Yes | String | ID of a dedicated resource pool | - +------------+-----------+--------+-------------------------------------------------------------------------------------------------------+ - | node_ip | Yes | String | IP address of a resource pool node, which is obtained from the response of the pool details query API | - +------------+-----------+--------+-------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0151__en-us_topic_0188079989_table87520312215: - -.. table:: **Table 2** Parameter description - - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+========================================================================================================================================================+ - | metrics | No | String | Metrics to be queried. Separate metrics by commas (,), for example, **CpuUsage,MemUsage**. If this parameter is left blank, all metrics are queried. | - | | | | | - | | | | Options: | - | | | | | - | | | | - **CpuUsage**: CPU usage | - | | | | - **MemUsage**: memory usage | - | | | | - **DiskReadRate**: disk read rate | - | | | | - **DiskWriteRate**: disk write rate | - | | | | - **RecvBytesRate**: network receiving rate | - | | | | - **SendBytesRate**: network sending rate | - | | | | - **GpuUtil**: GPU usage | - | | | | - **GpuMemUsage**: GPU memory usage | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | statistic_type | No | String | Metric statistics method, indicating whether to collect metric statistics based on a single GPU. This parameter applies only to GPU metric statistics. | - | | | | | - | | | | - **all**: Obtain the average value of the metric. | - | | | | - **each**: Obtain the metric monitoring information about each GPU. | - +-----------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0151__en-us_topic_0188079989_table1414514116749: - -.. table:: **Table 3** Parameter description - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=====================================================================================================================================================+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Indicates the error code when the API fails to be called. Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | metrics | Json Array | Metric monitoring details. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - | interval | Integer | Query interval, in minutes. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0151__en-us_topic_0188079989_table8361164171810: - -.. table:: **Table 4** metrics data structure - - +-----------+------------+---------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+============+===========================================================================+ - | metric | String | Monitoring metrics | - +-----------+------------+---------------------------------------------------------------------------+ - | value | Json Array | Sequence of the obtained metric value. The element is of the String type. | - +-----------+------------+---------------------------------------------------------------------------+ - -Samples -------- - -The following example queries monitoring information about node **192.168.1.1** in the dedicated resource pool **poolabcd**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/pools/poolabcd/nodes/192.168.1.1/metric-statistic - -- Successful sample response - - .. code-block:: - - { - "metrics": - [ - { - "metric":"gpuUtil", - "value":["1","22","33"] - } - ], - "interval" : 1 - } - -- Failed sample response - - .. code-block:: - - { - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_the_details_about_a_training_job_version.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_the_details_about_a_training_job_version.rst deleted file mode 100644 index de75f035..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_the_details_about_a_training_job_version.rst +++ /dev/null @@ -1,474 +0,0 @@ -.. _modelarts_03_0047: - -Querying the Details About a Training Job Version -================================================= - -Function --------- - -This API is used to query the details about a specified training job based on the job ID. - -URI ---- - -GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0047__en-us_topic_0131145862_table21765985143543: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0047__en-us_topic_0131145862_table2700823414458: - -.. table:: **Table 2** Parameters - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===================================================================================================================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_desc | String | Description of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_id | Long | Version ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | version_name | String | Version name of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pre_version_id | Long | Name of the previous version of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_type | Integer | Engine type of a training job. The mapping between **engine_type** and **engine_name** is as follows: **engine_type**: **13**, **engine_name**: **Ascend-Powered-Engine** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_name | String | Name of the engine selected for a training job. Currently, the following engines are supported: | - | | | | - | | | - Ascend-Powered-Engine | - | | | - PyTorch | - | | | - Spark_MLlib | - | | | - Scikit_Learn | - | | | - TensorFlow | - | | | - XGBoost-Sklearn | - | | | - MindSpore-GPU | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_id | Long | ID of the engine selected for a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | engine_version | String | Version of the engine selected for a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a training job. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_url | String | Code directory of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | boot_file_url | String | Boot file of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a training job is created | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | parameter | Array | Running parameters of a training job. This parameter is a container environment variable when a training job uses a custom image. For details, see :ref:`Table 3 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | duration | Long | Training job running duration, in milliseconds | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_id | Long | ID of the resource specifications selected for a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | core | String | Number of cores of the resource specifications | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | cpu | String | CPU memory of the resource specifications | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_num | Integer | Number of GPUs of the resource specifications | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | gpu_type | String | GPU type of the resource specifications | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | worker_server_num | Integer | Number of workers in a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_url | String | Dataset of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | String | OBS path of the training job output file | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_url | String | OBS URL of the logs of a training job. By default, this parameter is left blank. Example value: **/usr/train/** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_id | String | Dataset version ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_id | String | Dataset ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | data_source | Array | Datasets of a training job. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_id | Long | Model ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_metric_list | String | Model metrics of a training job. For details, see :ref:`Table 5 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | system_metric_list | JSON | System monitoring metrics of a training job. For details, see :ref:`Table 6 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_image_url | String | SWR URL of a custom image used by a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_command | String | Boot command used to start the container of a custom image of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Charged resource ID of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_name | String | Dataset of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | spec_code | String | Resource specifications selected for a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | start_time | Long | Training start time | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | volumes | Array | Storage volume that can be used by a training job. For details, see :ref:`Table 11 `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dataset_version_name | String | Dataset of a training job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_name | String | Name of a resource pool | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of a resource pool | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_mount_path | String | Local mount path of SFS Turbo (NAS). Example value: **/home/work/nas** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_share_addr | String | Shared path of SFS Turbo (NAS). Example value: **192.168.8.150:/** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | nas_type | String | Only NFS is supported. Example value: **nfs** | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0047__en-us_topic_0131145862_table1267642234716: - -.. table:: **Table 3** **parameter** parameters - - ========= ====== =============== - Parameter Type Description - ========= ====== =============== - label String Parameter name - value String Parameter value - ========= ====== =============== - -.. _modelarts_03_0047__en-us_topic_0131145862_table250595919011: - -.. table:: **Table 4** **data_source** parameters - - +-----------------------+-----------------------+--------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+========================================================+ - | dataset_id | String | Dataset ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | dataset_version | String | Dataset version ID of a training job | - +-----------------------+-----------------------+--------------------------------------------------------+ - | type | String | Dataset type | - | | | | - | | | - **obs**: Data from OBS is used. | - | | | - **dataset**: Data from a specified dataset is used. | - +-----------------------+-----------------------+--------------------------------------------------------+ - | data_url | String | OBS bucket path | - +-----------------------+-----------------------+--------------------------------------------------------+ - -.. _modelarts_03_0047__en-us_topic_0131145862_table254511106543: - -.. table:: **Table 5** **model_metric_list** parameters - - +--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+============+==========================================================================================================================================================+ - | metric | JSON Array | Validation metrics of a classification of a training job. For details, see :ref:`Table 7 `. | - +--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_metric | JSON | Overall validation parameters of a training job. For details, see :ref:`Table 9 `. | - +--------------+------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0047__en-us_topic_0131145862_table199981042536: - -.. table:: **Table 6** **system_metric_list** parameters - - ========= ===== ============================== - Parameter Type Description - ========= ===== ============================== - cpuUsage Array CPU usage of a training job - memUsage Array Memory usage of a training job - gpuUtil Array GPU usage of a training job - ========= ===== ============================== - -.. _modelarts_03_0047__en-us_topic_0131145862_table226072412518: - -.. table:: **Table 7** **metric** parameters - - +---------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===============+======+==========================================================================================================================================================+ - | metric_values | JSON | Validation metrics of a classification of a training job. For details, see :ref:`Table 8 `. | - +---------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | reserved_data | JSON | Reserved parameter | - +---------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metric_meta | JSON | Classification of a training job, including the classification ID and name | - +---------------+------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0047__en-us_topic_0131145862_table162521255132: - -.. table:: **Table 8** **metric_values** parameters - - ========= ===== =============================================== - Parameter Type Description - ========= ===== =============================================== - recall Float Recall of a classification of a training job - precision Float Precision of a classification of a training job - accuracy Float Accuracy of a classification of a training job - ========= ===== =============================================== - -.. _modelarts_03_0047__en-us_topic_0131145862_table102963631010: - -.. table:: **Table 9** **total_metric** parameters - - +---------------------+------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+======+=================================================================================================================================================+ - | total_metric_meta | JSON | Reserved parameter | - +---------------------+------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_reserved_data | JSON | Reserved parameter | - +---------------------+------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | total_metric_values | JSON | Overall validation metrics of a training job. For details, see :ref:`Table 10 `. | - +---------------------+------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0047__en-us_topic_0131145862_table45171749171414: - -.. table:: **Table 10** **total_metric_values** parameters - - ========= ===== ================================= - Parameter Type Description - ========= ===== ================================= - f1_score Float F1 score of a training job - recall Float Total recall of a training job - precision Float Total precision of a training job - accuracy Float Total accuracy of a training job - ========= ===== ================================= - -.. _modelarts_03_0047__en-us_topic_0131145862_table6403153714711: - -.. table:: **Table 11** **volumes** parameters - - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+======+================================================================================================================================================================================================================================================================================+ - | nfs | No | JSON | Storage volume of the shared file system type. Only the training jobs running in the resource pool with the shared file system network connected support such storage volume. For details, see :ref:`Table 6 `. | - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | host_path | No | JSON | Storage volume of the host file system type. Only training jobs running in the dedicated resource pool support such storage volume. For details, see :ref:`Table 7 `. | - +-----------+-----------+------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 12** **nfs** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | id | Yes | String | ID of an SFS Turbo file system | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | src_path | Yes | String | Address of an SFS Turbo file system | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | dest_path | Yes | String | Local path of a training job | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | read_only | No | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | | - | | | | - **true**: read-only permission | - | | | | - **false**: read/write permission. This is the default value. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -.. table:: **Table 13** **host_path** parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================+ - | src_path | Yes | String | Local path of a host | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | dest_path | Yes | String | Local path of a training job | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - | read_only | No | Boolean | Whether **dest_path** is read-only. The default value is **false**. | - | | | | | - | | | | - **true**: read-only permission | - | | | | - **false**: read/write permission. This is the default value. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the details about the job whose **job_id** is **10** and **version_id** is **10**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/10/versions/10 - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "job_id": 10, - "job_name": "TestModelArtsJob", - "job_desc": "TestModelArtsJob desc", - "version_id": 10, - "version_name": "jobVersion", - "pre_version_id": 5, - "engine_type": , - "engine_name": "TensorFlow", - "engine_id": 1, - "engine_version": "TF-1.4.0-python2.7", - "status": 10, - "app_url": "/usr/app/", - "boot_file_url": "/usr/app/boot.py", - "create_time": 1524189990635, - "parameter": [ - { - "label": "learning_rate", - "value": 0.01 - } - ], - "duration": 532003, - "spec_id": 1, - "core": 2, - "cpu": 8, - "gpu_num": 2, - "gpu_type": "P100", - "worker_server_num": 1, - "data_url": "/usr/data/", - "train_url": "/usr/train/", - "log_url": "/usr/log/", - "dataset_version_id": "2ff0d6ba-c480-45ae-be41-09a8369bfc90", - "dataset_id": "38277e62-9e59-48f4-8d89-c8cf41622c24", - "data_source": [ - { - "type": "obs", - "data_url": "/qianjiajun-test/minst/data/" - } - ], - "user_image_url": "100.125.5.235:20202/jobmng/custom-cpu-base:1.0", - "user_command": "bash -x /home/work/run_train.sh python /home/work/user-job-dir/app/mnist/mnist_softmax.py --data_url /home/work/user-job-dir/app/mnist_data", - "model_id": 1, - "model_metric_list": "{\"metric\":[{\"metric_values\":{\"recall\":0.005833,\"precision\":0.000178,\"accuracy\":0.000937},\"reserved_data\":{},\"metric_meta\":{\"class_name\":0,\"class_id\":0}}],\"total_metric\":{\"total_metric_meta\":{},\"total_reserved_data\":{},\"total_metric_values\":{\"recall\":0.005833,\"id\":0,\"precision\":0.000178,\"accuracy\":0.000937}}}", - "system_metric_list": { - "cpuUsage": [ - "0", - "3.10", - "5.76", - "0", - "0", - "0", - "0" - ], - "memUsage": [ - "0", - "0.77", - "2.09", - "0", - "0", - "0", - "0" - ], - "gpuUtil": [ - "0", - "0.25", - "0.88", - "0", - "0", - "0", - "0" - ], - "gpuMemUsage": [ - "0", - "0.65", - "6.01", - "0", - "0", - "0", - "0" - ], - "diskReadRate": [ - "0", - "91811.07", - "38846.63", - "0", - "0", - "0", - "0" - ], - "diskWriteRate": [ - "0", - "2.23", - "0.94", - "0", - "0", - "0", - "0" - ], - "recvBytesRate": [ - "0", - "5770405.50", - "2980077.75", - "0", - "0", - "0", - "0" - ], - "sendBytesRate": [ - "0", - "12607.17", - "10487410.00", - "0", - "0", - "0", - "0" - ], - "interval": 1 - }, - "dataset_name": "dataset-test", - "dataset_version_name": "dataset-version-test", - "spec_code": , - "start_time": 1563172362000, - "volumes": [ - { - "nfs": { - "id": "43b37236-9afa-4855-8174-32254b9562e7", - "src_path": "192.168.8.150:/", - "dest_path": "/home/work/nas", - "read_only": false - } - }, - { - "host_path": { - "src_path": "/root/work", - "dest_path": "/home/mind", - "read_only": false - } - } - ], - "pool_id": "pool9928813f", - "pool_name": "p100", - "nas_mount_path": "/home/work/nas", - "nas_share_addr": "192.168.8.150:/", - "nas_type": "nfs" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_the_statuses_and_gpu_quantity_of_all_job_versions.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_the_statuses_and_gpu_quantity_of_all_job_versions.rst deleted file mode 100644 index 5d2d1f33..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_the_statuses_and_gpu_quantity_of_all_job_versions.rst +++ /dev/null @@ -1,167 +0,0 @@ -.. _en-us_topic_0000001147936839: - -Querying the Statuses and GPU Quantity of All Job Versions -========================================================== - -Function --------- - -You can use this API to query the overview information about all job versions created by a user based on specified conditions, including the statuses and GPU quantity of all job versions. - -URI ---- - -GET /v1/{project_id}/training-jobs/versions - -Table 1 Parameter description describes the required parameters. - -.. table:: **Table 1** Parameter description - - ========== ========= ====== =========== - Parameter Mandatory Type Description - ========== ========= ====== =========== - project_id Yes String Project ID. - ========== ========= ====== =========== - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _en-us_topic_0000001147936839__en-us_topic_0195926038_table125324323545: - -.. table:: **Table 2** Parameter description - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================================================+ - | offset | No | Integer | Offset. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Number of displayed records. The default value is **20**. The value **0** indicates that all records are displayed. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | No | String | Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of **status** to **3**, **5**, **6**, or **13**. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode of the query. By default, the records are sorted by **create_time**. The records can be sorted by **job_desc**, **status**, **duration**, or **job_name**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. Options: | - | | | | | - | | | | - **asc**: ascending order | - | | | | - **desc**: descending order. The default value is **desc**. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | pool_id | No | String | ID of the resource pool to be queried. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace where a job resides. Default value: **0** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _en-us_topic_0000001147936839__en-us_topic_0195926038_table31621671103510: - -.. table:: **Table 3** Parameter description - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+==========================================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | total_count | Integer | Total number of created job versions. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - | versions | JSON Array | Attributes of a training job. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _en-us_topic_0000001147936839__en-us_topic_0195926038_table3971109103614: - -.. table:: **Table 4** **jobs** parameters - - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+=========+============================================================================================================+ - | version_id | Long | ID of a training job | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | version_name | String | Name of a training job | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | status | Byte | Status of a training job. For details about the job statuses, see :ref:`Job Statuses `. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Timestamp when a training job is created | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | start_time | Long | Timestamp when a training job starts. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | end_time | Long | Timestamp when a training job ends. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | duration | Long | Running duration of a training job. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | version_desc | String | Description of a training job | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | pool_id | String | ID of the resource pool to which a training job belongs. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | flavor_code | String | Resource specifications selected for a training job | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | npu_num | integer | Number of NPUs used by a training job. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - | gpu_num | integer | Number of GPUs used by a training job. | - +--------------+---------+------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -Query training jobs in batches. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/versions - -- Sample response of a successful query - - .. code-block:: - - { - versions:[ - { - "version_id": 1485, - "version_name": "trainjob-3f47", - "status": 12, - "create_time": 1557473030000, - "start_time": 1557473040000, - "end_time": 1557473093000, - "duration": 53000, - "version_desc": null, - "pool_id": "pool9928813f", - "flavor_code": "modelarts.p1.2xlarge", - "npu_num": 0, - "gpu_num": 1 - } - ], - "offset": 20, - "limit": 20, - "total_count": 1, - "is_success": true - } - -- Sample response of a failed query - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/querying_training_job_logs.rst b/modelarts/api-ref/result/training_management/training_jobs/querying_training_job_logs.rst deleted file mode 100644 index 60feb330..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/querying_training_job_logs.rst +++ /dev/null @@ -1,123 +0,0 @@ -.. _modelarts_03_0149: - -Querying Training Job Logs -========================== - -Function --------- - -This API is used to query detailed information about training job logs by row. - -URI ---- - -GET /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/aom-log - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0149__en-us_topic_0188093645_table4442765616454: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0149__en-us_topic_0188093645_table87520312215: - -.. table:: **Table 2** Parameters - - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=====================================================================================================================================================================+ - | base_line | No | String | Base line of the log, which is obtained from an API response. If the value is empty, the latest log is obtained. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | lines | No | Integer | Length of the obtained log. The default value is 50 lines. The value range is [0, 500]. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | log_file | Yes | String | Name of the log file to be viewed. For details about how to obtain the log file name, see :ref:`Obtaining the Name of a Training Job Log File `. | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Log query direction | - | | | | | - | | | | - desc: Querying next records | - | | | | - asc: Querying previous records | - +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0149__en-us_topic_0188093645_table1414514116749: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | content | String | Content of the requested log | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | lines | Integer | Lines of the obtained logs | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | start_line | String | Start position of the obtained log | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | end_line | String | End position of the obtained log | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the logs contained in **log1.log** of the job whose **job_id** is **10** and **version_id** is **10**. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/training-jobs/10/versions/10/aom-log?log_file=log1.log&base_line= 1551252759254000002&lines=50&order=desc - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "start_line":1551252759254000002, - "content": "Log string", - "end_line": "1551252759254000003", - "lines": "1" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/training_jobs/stopping_a_training_job.rst b/modelarts/api-ref/result/training_management/training_jobs/stopping_a_training_job.rst deleted file mode 100644 index d56b9af6..00000000 --- a/modelarts/api-ref/result/training_management/training_jobs/stopping_a_training_job.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _modelarts_03_0051: - -Stopping a Training Job -======================= - -Function --------- - -This API is used to stop a training job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Training Job List ` and :ref:`Querying the Details About a Training Job Version `. - -URI ---- - -POST /v1/{project_id}/training-jobs/{job_id}/versions/{version_id}/stop - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0051__en-us_topic_0131151010_table38721821155840: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | Long | ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | version_id | Yes | Long | Version ID of a training job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0051__en-us_topic_0131151010_table61691357155927: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to stop a version of the job whose **job_id** is **10** and **version_id** is **10**. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/training-jobs/10/versions/10/stop - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Error string", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Status Code `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/creating_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/creating_a_visualization_job.rst deleted file mode 100644 index de52f683..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/creating_a_visualization_job.rst +++ /dev/null @@ -1,155 +0,0 @@ -.. _modelarts_03_0064: - -Creating a Visualization Job -============================ - -Function --------- - -This API is used to create a visualization job. - -Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Visualization Job List ` and :ref:`Querying the Details About a Visualization Job `. - -URI ---- - -POST /v1/{project_id}/visualization-jobs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0064__en-us_topic_0131202682_table569625523811: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0064__en-us_topic_0131202682_table196759327241: - -.. table:: **Table 2** Parameters - - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+================================================================================================================================================+ - | job_name | Yes | String | Name of a visualization job. The value is a string of 1 to 20 characters consisting of only digits, letters, underscores (_), and hyphens (-). | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_desc | No | String | Description of a visualization job. The value is a string of 0 to 256 characters. By default, this parameter is left blank. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | train_url | Yes | String | OBS path | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | No | String | Type of a visualization job. You can create visualization jobs of TensorBoard and MindInsight types. The default type is TensorBoard. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | flavor | No | JSON | Specifications when a visualization job is created. You do not need to set this parameter. | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - | schedule | No | JSON | Automatic stop setting | - +-----------+-----------+--------+------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 3** **flavor** parameters - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===============================================================================================================+ - | code | Yes | String | Resource specification code of a visualization job. You can obtain the code through the **flavor** parameter. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** **schedule** parameters - - +-----------+-----------+--------+-----------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+=====================================================+ - | type | Yes | String | Set this parameter to **stop**. | - +-----------+-----------+--------+-----------------------------------------------------+ - | time_unit | Yes | String | Unit of auto stop duration. The value is **HOURS**. | - +-----------+-----------+--------+-----------------------------------------------------+ - | duration | Yes | Int | Auto stop duration. The value ranges from 0 to 24. | - +-----------+-----------+--------+-----------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 5 ` describes the response parameters. - -.. _modelarts_03_0064__en-us_topic_0131202682_table28681002612: - -.. table:: **Table 5** Parameters - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a visualization job. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a visualization job is created, in timestamp format | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | service_url | String | Endpoint of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to create a visualization job whose name is **visualization-job**, description is **this is a visualization job**, and OBS path is **/obs/name/**. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/visualization-jobs - { - "job_name": "visualization-job", - "job_desc": "this is a visualization job", - "train_url": "/obs/name/", - "job_type": "mindinsight", - "schedule": [ - { - "type": "stop", - "time_unit": "HOURS", - "duration": 1 - } - ] - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true, - "job_id": "10", - "job_name": "visualization-job", - "status": "1", - "create_time": "1524189990635" - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "error message", - "error_code": "ModelArts.0103" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/deleting_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/deleting_a_visualization_job.rst deleted file mode 100644 index a4c78506..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/deleting_a_visualization_job.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_03_0068: - -Deleting a Visualization Job -============================ - -Function --------- - -This API is used to delete a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Visualization Job List ` and :ref:`Querying the Details About a Visualization Job `. - -URI ---- - -DELETE /v1/{project_id}/visualization-jobs/{job_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0068__en-us_topic_0131202686_table20736351173356: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | String | ID of a visualization job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0068__en-us_topic_0131202686_table9370583111247: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to delete the visualization job whose ID is 10. - -- Sample request - - .. code-block:: - - DELETE https://endpoint/v1/{project_id}/visualization-jobs/10 - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "This job can't be delete. job status: 9", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/index.rst b/modelarts/api-ref/result/training_management/visualization_jobs/index.rst deleted file mode 100644 index 1d78cf86..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _modelarts_03_0063: - -================== -Visualization Jobs -================== - -.. toctree:: - :maxdepth: 1 - - creating_a_visualization_job - querying_a_visualization_job_list - querying_the_details_about_a_visualization_job - modifying_the_description_of_a_visualization_job - deleting_a_visualization_job - stopping_a_visualization_job - restarting_a_visualization_job diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/modifying_the_description_of_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/modifying_the_description_of_a_visualization_job.rst deleted file mode 100644 index 3ce7adfa..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/modifying_the_description_of_a_visualization_job.rst +++ /dev/null @@ -1,103 +0,0 @@ -.. _modelarts_03_0067: - -Modifying the Description of a Visualization Job -================================================ - -Function --------- - -This API is used to modify the description of a visualization job. - -URI ---- - -PUT /v1/{project_id}/visualization-jobs/{job_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0067__en-us_topic_0131202685_table4247299117445: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | String | ID of a visualization job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -:ref:`Table 2 ` describes the request parameters. - -.. _modelarts_03_0067__en-us_topic_0131202685_table212731411827: - -.. table:: **Table 2** Parameters - - +-----------+-----------+--------+-----------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===================================================================================+ - | job_desc | Yes | String | Description of a visualization job. The value is a string of 0 to 256 characters. | - +-----------+-----------+--------+-----------------------------------------------------------------------------------+ - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0067__en-us_topic_0131202685_table33036183111023: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to modify the description of the visualization job whose ID is **10** to **This is a ModelArts job**. - -- Sample request - - .. code-block:: - - PUT https://endpoint/v1/{project_id}/visualization-jobs/10 - { - "job_desc": "This is a ModelArts job" - } - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "Illegal name: %%123", - "error_code": "ModelArts.0104" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/querying_a_visualization_job_list.rst b/modelarts/api-ref/result/training_management/visualization_jobs/querying_a_visualization_job_list.rst deleted file mode 100644 index 9a93762a..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/querying_a_visualization_job_list.rst +++ /dev/null @@ -1,169 +0,0 @@ -.. _modelarts_03_0065: - -Querying a Visualization Job List -================================= - -Function --------- - -This API is used to query the visualization jobs that meet the search criteria. - -URI ---- - -GET /v1/{project_id}/visualization-jobs - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0065__en-us_topic_0131202683_table569625523811: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+===========================================================================================================================================================================================================================================+ - | status | No | String | Job status. By default, all job statuses are returned. For example, to query failed jobs, set the value of **status** to **3**, **5**, **6**, or **13**. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | per_page | No | Integer | Number of jobs displayed on each page. The value range is [1, 1000]. Default value: **10** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | page | No | Integer | Index of the page to be queried. Default value: **1** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sortBy | No | String | Sorting mode of the query. The value can be **job_id**, **job_name**, **job_desc**, **create_time**, or **status**. Default value: **job_id** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Sorting order. Options: | - | | | | | - | | | | - **asc**: ascending order. It is the default value. | - | | | | - **desc**: descending order | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | search_content | No | String | Search content, for example, a visualization job name. The value is a string of 0 to 64 characters. By default, this parameter is left blank. | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | workspace_id | No | String | Workspace where a job resides. Default value: **0** | - +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 3 ` describes the response parameters. - -.. _modelarts_03_0065__en-us_topic_0131202683_table116520556267: - -.. table:: **Table 3** Parameters - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | job_total_count | Integer | Total number of the queried visualization jobs | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | job_count_limit | Integer | Number of visualization jobs that can be created | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | jobs | **jobs** array | Visualization job attributes. For details, see :ref:`Table 4 `. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - | quotas | Integer | Maximum number of training jobs | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_03_0065__en-us_topic_0131202683_table5856678611720: - -.. table:: **Table 4** **jobs** parameters - - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+=================================================================================================================+ - | job_name | String | Name of a visualization job | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | status | Integer | Status of a visualization job. For details about the job statuses, see :ref:`Job Statuses `. | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a visualization job is created | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | duration | Long | Visualization job running duration, in milliseconds | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | job_desc | String | Description of a visualization job | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | service_url | String | Endpoint of a visualization job | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | train_url | String | Path for storing visualization job logs | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a visualization job | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Charged resource ID of a visualization job | - +-------------+---------+-----------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the top 10 visualization jobs that are being deployed on the first page in ascending order. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/visualization-jobs ?status=7&per_page=10&page=1&sortBy=status&order=asc& search_content=job_name - -- Successful sample response - - .. code-block:: - - { - "quotas": 100, - "is_success": true, - "job_total_count": 1, - "job_count_limit": 999, - "jobs": [ - { - "job_id": 1, - "job_name": "visualization-job", - "status": 1, - "create_time": 15099239923, - "resource_id": "4787c885-e18d-4ef1-aa12-c4ed0c364b27", - "duration": 1502323, - "job_desc": "This is a visualization job", - "service_url": "https://XXX/modelarts/tensoarbod/xxxx/111", - "train_url": "/obs/name/" , - "schedule": [ - { - "type": "stop", - "timeUnit": "HOURS", - "duration": 1 - } - ], - "remaining_duration": null - } - ] - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "error message", - "error_code": "ModelArts.0103" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/querying_the_details_about_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/querying_the_details_about_a_visualization_job.rst deleted file mode 100644 index c777c6cd..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/querying_the_details_about_a_visualization_job.rst +++ /dev/null @@ -1,116 +0,0 @@ -.. _modelarts_03_0066: - -Querying the Details About a Visualization Job -============================================== - -Function --------- - -This API is used to query the details about a specified visualization job based on the job name. - -URI ---- - -GET /v1/{project_id}/visualization-jobs/{job_id} - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0066__en-us_topic_0131202684_table569625523811: - -.. table:: **Table 1** Parameters - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | String | ID of a visualization job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0066__en-us_topic_0131202684_table6495326155010: - -.. table:: **Table 2** Parameters - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+=================================================================================================================+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | job_name | String | Name of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | service_url | String | Endpoint of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | resource_id | String | Charged resource ID of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | job_id | Long | ID of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | job_desc | String | Description of a visualization job | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | duration | Long | Visualization job running duration, in milliseconds | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | create_time | Long | Time when a visualization job is created, in timestamp format | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | train_url | String | OBS path of the visualization job output file | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - | status | Int | Status of a visualization job. For details about the job statuses, see :ref:`Job Statuses `. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to query the visualization job whose ID is 10. - -- Sample request - - .. code-block:: - - GET https://endpoint/v1/{project_id}/visualization-jobs/10 - -- Successful sample response - - .. code-block:: - - { - "duration": 33000, - "service_url": "https://XXX/modelarts2/tensorboard/04f679b17380d32a2f32c00335c4b5ba/197/", - "job_name": "apiTest-11", - "create_time": 1565149736000, - "train_url": "/wph-test/zl-test/Flowers-Set/ApiTest/", - "job_id": 197, - "job_desc": "ModelArts API Dialtest", - "resource_id": "e17dd874-b5e0-4e9b-aaf0-22b045ad8571", - "remaining_duration": null, - "is_success": true, - "status": 7 - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "The length of search content should be in [0,100]", - "error_code": "ModelArts.0104" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/restarting_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/restarting_a_visualization_job.rst deleted file mode 100644 index bd23668f..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/restarting_a_visualization_job.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_03_0070: - -Restarting a Visualization Job -============================== - -Function --------- - -This API is used to restart a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Visualization Job List ` and :ref:`Querying the Details About a Visualization Job `. - -URI ---- - -POST /v1/{project_id}/visualization-jobs/{job_id}/restart - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0070__en-us_topic_0131202688_table20736351173356: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | String | ID of a visualization job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0070__en-us_topic_0131202688_table1616937211145: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to restart the visualization job whose ID is 10. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/visualization-jobs/10/restart - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "This job can't be resubmit. job status: 8", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/training_management/visualization_jobs/stopping_a_visualization_job.rst b/modelarts/api-ref/result/training_management/visualization_jobs/stopping_a_visualization_job.rst deleted file mode 100644 index 74e5282b..00000000 --- a/modelarts/api-ref/result/training_management/visualization_jobs/stopping_a_visualization_job.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_03_0069: - -Stopping a Visualization Job -============================ - -Function --------- - -This API is used to stop a visualization job. Calling this API is an asynchronous operation. The job status can be obtained by calling the APIs described in :ref:`Querying a Visualization Job List ` and :ref:`Querying the Details About a Visualization Job `. - -URI ---- - -POST /v1/{project_id}/visualization-jobs/{job_id}/stop - -:ref:`Table 1 ` describes the required parameters. - -.. _modelarts_03_0069__en-us_topic_0131202687_table20736351173356: - -.. table:: **Table 1** Parameter description - - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+=============================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID and Name `. | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | job_id | Yes | String | ID of a visualization job | - +------------+-----------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Request Body ------------- - -None - -Response Body -------------- - -:ref:`Table 2 ` describes the response parameters. - -.. _modelarts_03_0069__en-us_topic_0131202687_table47616479111324: - -.. table:: **Table 2** Parameter description - - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===========================================================================================+ - | is_success | Boolean | Whether the request is successful | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_code | String | Error code of a failed API call. For details, see :ref:`Error Codes `. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - | error_message | String | Error message of a failed API call. | - | | | | - | | | This parameter is not included when the API call succeeds. | - +-----------------------+-----------------------+-------------------------------------------------------------------------------------------+ - -Samples -------- - -The following shows how to stop the visualization job whose ID is 10. - -- Sample request - - .. code-block:: - - POST https://endpoint/v1/{project_id}/visualization-jobs/10/stop - -- Successful sample response - - .. code-block:: - - { - "is_success": true - } - -- Failed sample response - - .. code-block:: - - { - "is_success": false, - "error_message": "This job can't be stop. job status: 10", - "error_code": "ModelArts.0105" - } - -Status Code ------------ - -For details about the status code, see :ref:`Table 1 `. diff --git a/modelarts/api-ref/result/workspace_management/creating_a_workspace.rst b/modelarts/api-ref/result/workspace_management/creating_a_workspace.rst deleted file mode 100644 index 4b5625f7..00000000 --- a/modelarts/api-ref/result/workspace_management/creating_a_workspace.rst +++ /dev/null @@ -1,181 +0,0 @@ -.. _CreateWorkspace: - -Creating a Workspace -==================== - -Function --------- - -This API is used to create a workspace. The name of the created workspace cannot be **default**, which is the name of the default workspace reserved by the system. - -URI ---- - -POST /v1/{project_id}/workspaces - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+==================================================================+=======================================================================================================================================================================================================================================================================================+ - | name | Yes | String | Workspace name, encoded using UTF-8. Enter 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. In addition, **default** is the name of the default workspace reserved by the system. You are not allowed to create a workspace named **default**. | - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Workspace description. By default, this parameter is left blank. Enter 0 to 256 characters. | - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project ID. The method of obtaining an enterprise project ID is the same as that of obtaining a project ID. | - | | | | | - | | | | Default: **0** | - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auth_type | No | String | Authorization type. Options: | - | | | | | - | | | | - **PUBLIC**: public access of tenants (default value) | - | | | | | - | | | | - **PRIVATE**: accessible only to the creator and primary account | - | | | | | - | | | | - **INTERNAL**: accessible to the creator, primary account, and specified IAM users. This parameter must be used together with **grants**. | - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grants | No | Array of :ref:`grants ` objects | List of authorized users, which is left blank by default. This parameter must be used together with **auth_type** and takes effect only when **auth_type** is set to **INTERNAL**. | - +-----------------------+-----------------+------------------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createworkspace__request_grants: - -.. table:: **Table 3** grants - - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+==========================================================================================================================================================================================================================+ - | user_id | No | String | User ID. For details about how to obtain a user ID, see :ref:`Obtaining a User ID `. Either this parameter or **user_name** must be set. If both of them are set, **user_id** is used preferentially. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user_name | No | String | IAM username. Either this parameter or **user_id** must be set. | - +-----------+-----------+--------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+===================================================================+=================================================================================================================================================================================================================+ - | id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Workspace name | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Workspace description. Enter 0 to 256 characters. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | Creator name. Enter 0 to 64 characters. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Number | Time when a workspace was created, in UTC format | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Last modification time, in UTC format | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auth_type | String | Authorization type. Options: | - | | | | - | | | - **PUBLIC**: public access of tenants (default value) | - | | | | - | | | - **PRIVATE**: accessible only to the creator and primary account | - | | | | - | | | - **INTERNAL**: accessible to the creator, primary account, and specified IAM users. This parameter must be used together with **grants**. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_name | String | Name of an enterprise project | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Workspace status. Options: | - | | | | - | | | - **CREATE_FAILED**: Creating the workspace failed. | - | | | | - | | | - **NORMAL**: The workspace is running properly. | - | | | | - | | | - **DELETING**: The workspace is being deleted. | - | | | | - | | | - **DELETE_FAILED**: Deleting the workspace failed. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status_info | String | Status description. By default, this parameter is left blank. This parameter is used to show detailed information about a status. If a deletion failed, you can use this parameter to obtain the failure cause. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grants | Array of :ref:`grants ` objects | List of authorized users, which is left blank by default. This parameter must be used together with **auth_type** and takes effect only when **auth_type** is set to **INTERNAL**. | - +-------------------------+-------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _createworkspace__response_grants: - -.. table:: **Table 5** grants - - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+===========================================================================================================================+ - | user_id | String | User ID. Either this parameter or **user_name** must be set. If both of them are set, **user_id** is used preferentially. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | IAM username. Either this parameter or **user_id** must be set. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Creating a Workspace - -.. code-block:: - - POST https://{endpoint}/v1/{project_id}/workspaces - - { - "name" : "test-workspace", - "description" : "It is a test project", - "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", - "auth_type" : "internal", - "grants" : [ { - "user_name" : "test" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "id" : "**d05d1a553b4e188ea878e7dcb85e**", - "name" : "test-workspace", - "description" : "It is a test project'", - "owner" : "testUser", - "create_time" : 1470000020000, - "update_time" : 1470000030000, - "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", - "enterprise_project_name" : "test-eps", - "auth_type" : "public", - "status" : "NORMAL", - "status_info" : "" - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/deleting_a_workspace.rst b/modelarts/api-ref/result/workspace_management/deleting_a_workspace.rst deleted file mode 100644 index fff86648..00000000 --- a/modelarts/api-ref/result/workspace_management/deleting_a_workspace.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _DeleteWorkspace: - -Deleting a Workspace -==================== - -Function --------- - -This API is used to delete a workspace. - -URI ---- - -DELETE /v1/{project_id}/workspaces/{workspace_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workspace_id | Yes | String | Workspace ID. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=============================================================================================================================+ - | workspace_id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. | - +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Deleting a Workspace - -.. code-block:: - - DELETE https://{endpoint}/v1/{project_id}/workspaces/{workspace_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "workspace_id" : "***05d1a553b4e188ea878e7dcb85***" - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/index.rst b/modelarts/api-ref/result/workspace_management/index.rst deleted file mode 100644 index 6726458a..00000000 --- a/modelarts/api-ref/result/workspace_management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _workspace: - -==================== -Workspace Management -==================== - -.. toctree:: - :maxdepth: 1 - - creating_a_workspace - querying_a_workspace_list - deleting_a_workspace - querying_details_about_a_workspace - modifying_a_workspace - querying_a_workspace_quota - modifying_a_workspace_quota diff --git a/modelarts/api-ref/result/workspace_management/modifying_a_workspace.rst b/modelarts/api-ref/result/workspace_management/modifying_a_workspace.rst deleted file mode 100644 index ad1baca9..00000000 --- a/modelarts/api-ref/result/workspace_management/modifying_a_workspace.rst +++ /dev/null @@ -1,122 +0,0 @@ -.. _UpdateWorkspace: - -Modifying a Workspace -===================== - -Function --------- - -This API is used to modify a workspace. - -URI ---- - -PUT /v1/{project_id}/workspaces/{workspace_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workspace_id | Yes | String | Workspace ID. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+==================================================================+==========================================================================================================================================================================================================================================================================================================================+ - | name | No | String | Workspace name, encoded using UTF-8. | - | | | | | - | | | | Enter 4 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. In addition, **default** is the name of the default workspace reserved by the system. You are not allowed to change the name of an existing workspace to **default**. The name of the default workspace cannot be changed. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | No | String | Workspace description. By default, this parameter is left blank. Enter 0 to 256 characters. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auth_type | No | String | Authorization type. Options: | - | | | | | - | | | | - **PUBLIC**: public access of tenants (default value) | - | | | | | - | | | | - **PRIVATE**: accessible only to the creator and primary account | - | | | | | - | | | | - **INTERNAL**: accessible to the creator, primary account, and specified IAM users. This parameter must be used together with **grants**. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grants | No | Array of :ref:`grants ` objects | List of authorized users, which is left blank by default. This parameter must be used together with **auth_type** and takes effect only when **auth_type** is set to **INTERNAL**. | - +-----------------+-----------------+------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _updateworkspace__request_grants: - -.. table:: **Table 3** grants - - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========+===========================================================================================================================+ - | user_id | No | String | User ID. Either this parameter or **user_name** must be set. If both of them are set, **user_id** is used preferentially. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | user_name | No | String | IAM username. Either this parameter or **user_id** must be set. | - +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +==============+========+=============================================================================================================================+ - | workspace_id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. | - +--------------+--------+-----------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Modifying a Workspace - -.. code-block:: - - PUT https://{endpoint}/v1/{project_id}/workspaces/{workspace_id} - - { - "name" : "my_workspace", - "description" : "It is my workspace", - "auth_type" : "INTERNAL", - "grants" : [ { - "user_name" : "my_iam_user" - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "workspace_id" : "***05d1a553b4e188ea878e7dcb85***" - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/modifying_a_workspace_quota.rst b/modelarts/api-ref/result/workspace_management/modifying_a_workspace_quota.rst deleted file mode 100644 index 8475b69a..00000000 --- a/modelarts/api-ref/result/workspace_management/modifying_a_workspace_quota.rst +++ /dev/null @@ -1,143 +0,0 @@ -.. _UpdateWorkspaceQuotas: - -Modifying a Workspace Quota -=========================== - -Function --------- - -This API is used to modify a workspace quota. - -URI ---- - -PUT /v1/{project_id}/workspaces/{workspace_id}/quotas - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workspace_id | Yes | String | Workspace ID. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -.. table:: **Table 2** Request body parameters - - +-----------+-----------+------------------------------------------------------------------------+----------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+========================================================================+================+ - | quotas | Yes | Array of :ref:`quotas ` objects | List of quotas | - +-----------+-----------+------------------------------------------------------------------------+----------------+ - -.. _updateworkspacequotas__request_quotas: - -.. table:: **Table 3** quotas - - +-----------+-----------+---------+----------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +===========+===========+=========+======================================================================+ - | resource | Yes | String | Unique resource ID | - +-----------+-----------+---------+----------------------------------------------------------------------+ - | quota | Yes | Integer | Current quota. Value **-1** indicates that the quota is not limited. | - +-----------+-----------+---------+----------------------------------------------------------------------+ - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 4** Response body parameters - - +-----------+-------------------------------------------------------------------------+----------------+ - | Parameter | Type | Description | - +===========+=========================================================================+================+ - | quotas | Array of :ref:`quotas ` objects | List of quotas | - +-----------+-------------------------------------------------------------------------+----------------+ - -.. _updateworkspacequotas__response_quotas: - -.. table:: **Table 5** quotas - - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+=================================================================================================================================================+ - | name_en | String | Name of a quota, in English | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | name_cn | String | Name of a quota, in Chinese | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource | String | Unique resource ID | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota | Integer | Existing quota. Value **-1** indicates that the quota is not limited. | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | min_quota | Integer | Minimum quota | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | max_quota | Integer | Maximum quota | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | unit_en | String | Quota unit, in English | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | unit_cn | String | Quota unit, in Chinese | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Last modification time, in UTC format. If the resource quota has not been modified, the default value is the time when a workspace was created. | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Modifying Workspace Quotas - -.. code-block:: - - PUT https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/quotas - - { - "quotas" : [ { - "workspace_id" : "***9cd9ea8a5432cbcd6496e57839***", - "resource" : "exemlProject.gpu_duration", - "quota" : 10 - } ] - } - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "quotas" : [ { - "name_en" : "ExeMLtraining duration (image classification, object detection, and soundclassification)", - "name_cn" : "Chinese name of the quota", - "resource" : "exemlProject.gpu_duration", - "quota" : 10, - "min_quota" : -1, - "max_quota" : 60000, - "unit_en" : "minute", - "unit_cn" : "Chinese name of the minute", - "update_time" : 1470000020000 - } ] - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/querying_a_workspace_list.rst b/modelarts/api-ref/result/workspace_management/querying_a_workspace_list.rst deleted file mode 100644 index d2ed8eef..00000000 --- a/modelarts/api-ref/result/workspace_management/querying_a_workspace_list.rst +++ /dev/null @@ -1,177 +0,0 @@ -.. _ListWorkspaces: - -Querying a Workspace List -========================= - -Function --------- - -This API is used to obtain a workspace list with detailed information contained in the response body. - -URI ---- - -GET /v1/{project_id}/workspaces - -.. table:: **Table 1** Path parameters - - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Query parameters - - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+=================+=================+=============================================================================================================================================================================================================+ - | offset | No | Integer | Start page for pagination display. The default value is **0**. | - | | | | | - | | | | Minimum: **0** | - | | | | | - | | | | Default: **0** | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | limit | No | Integer | Maximum number of records returned on each page. Default value: **1000** | - | | | | | - | | | | Minimum: **1** | - | | | | | - | | | | Default: **1000** | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | sort_by | No | String | Sorting mode. The value can be **name**, **update_time**, or **status**. Default value: **name** | - | | | | | - | | | | Default: **name** | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | order | No | String | Query sequence. Options: | - | | | | | - | | | | - **asc**: ascending order | - | | | | | - | | | | - **desc**: descending order (default value) | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | No | String | Enterprise project ID. If this parameter is specified, only the workspaces of the enterprise project are returned. By default, all workspaces are displayed. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | No | String | Workspace name. If this parameter is specified, the fuzzy-match workspaces are obtained. By default, all workspaces are displayed. | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | filter_accessible | No | Boolean | Filter accessible workspaces. If this parameter is set to **true**, the workspaces you are not allowed to access are filtered out. The default value is **false**, indicating all workspaces are displayed. | - | | | | | - | | | | Default: **false** | - +-----------------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 3** Response body parameters - - +-------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ - | Parameter | Type | Description | - +=============+======================================================================================================================+=======================================================+ - | total_count | Integer | Total number of workspace queries | - +-------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ - | count | Integer | Number of workspaces returned for the current request | - +-------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ - | workspaces | Array of :ref:`workspacePropertiesWithoutGrants ` objects | Workspace details | - +-------------+----------------------------------------------------------------------------------------------------------------------+-------------------------------------------------------+ - -.. _listworkspaces__response_workspacepropertieswithoutgrants: - -.. table:: **Table 4** workspacePropertiesWithoutGrants - - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=======================+=================================================================================================================================================================================================================+ - | id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Workspace name | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Workspace description. Enter 0 to 256 characters. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | Creator name. Enter 0 to 64 characters. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Number | Time when a workspace was created, in UTC format | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Last modification time, in UTC format | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auth_type | String | Authorization type. Options: | - | | | | - | | | - **PUBLIC**: public access of tenants (default value) | - | | | | - | | | - **PRIVATE**: accessible only to the creator and primary account | - | | | | - | | | - **INTERNAL**: accessible to the creator, primary account, and specified IAM users. This parameter must be used together with **grants**. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_name | String | Name of an enterprise project | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Workspace status. Options: | - | | | | - | | | - **CREATE_FAILED**: Creating the workspace failed. | - | | | | - | | | - **NORMAL**: The workspace is running properly. | - | | | | - | | | - **DELETING**: The workspace is being deleted. | - | | | | - | | | - **DELETE_FAILED**: Deleting the workspace failed. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status_info | String | Status description. By default, this parameter is left blank. This parameter is used to show detailed information about a status. If a deletion failed, you can use this parameter to obtain the failure cause. | - +-------------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying a Workspace List - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/workspaces?limit=2&offset=3&sort_by=name&order=desc&enterprise_project_id=0 - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "total_count" : 10, - "count" : 1, - "workspaces" : [ { - "id" : 0, - "name" : "default", - "description" : "", - "owner" : "testUser", - "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", - "enterprise_project_name" : "default", - "auth_type" : "public", - "create_time" : 1460000010000, - "update_time" : 1460000010000, - "status" : "NORMAL", - "status_info" : "" - } ] - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/querying_a_workspace_quota.rst b/modelarts/api-ref/result/workspace_management/querying_a_workspace_quota.rst deleted file mode 100644 index bc25c9d5..00000000 --- a/modelarts/api-ref/result/workspace_management/querying_a_workspace_quota.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _ListWorkspaceQuotas: - -Querying a Workspace Quota -========================== - -Function --------- - -This API is used to obtain workspace quotas. - -URI ---- - -GET /v1/{project_id}/workspaces/{workspace_id}/quotas - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workspace_id | Yes | String | Workspace ID. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-----------+-----------------------------------------------------------------------+----------------+ - | Parameter | Type | Description | - +===========+=======================================================================+================+ - | quotas | Array of :ref:`quotas ` objects | List of quotas | - +-----------+-----------------------------------------------------------------------+----------------+ - -.. _listworkspacequotas__response_quotas: - -.. table:: **Table 3** quotas - - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=============+=========+=================================================================================================================================================+ - | name_en | String | Name of a quota, in English | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | name_cn | String | Name of a quota, in Chinese | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | resource | String | Unique resource ID | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | quota | Integer | Existing quota. Value **-1** indicates that the quota is not limited. | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | min_quota | Integer | Minimum quota | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | max_quota | Integer | Maximum quota | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | unit_en | String | Quota unit, in English | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | unit_cn | String | Quota unit, in Chinese | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Last modification time, in UTC format. If the resource quota has not been modified, the default value is the time when a workspace was created. | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | used_quota | Number | Used quota. If the value of **quota** is **-1** (indicating that the quota is not limited), the **used_quota** value is **null**. | - +-------------+---------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Workspace Quotas - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/workspaces/{workspace_id}/quotas - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "quotas" : [ { - "name_en" : "ExeMLtraining duration (image classification, object detection, and soundclassification)", - "name_cn" : "Chinese name of the quota", - "resource" : "exemlProject.gpu_duration", - "quota" : 10, - "min_quota" : -1, - "max_quota" : 60000, - "unit_en" : "minute", - "unit_cn" : "Chinese name of the minute", - "update_time" : 1470000020000, - "used_quota" : 5 - } ] - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/api-ref/result/workspace_management/querying_details_about_a_workspace.rst b/modelarts/api-ref/result/workspace_management/querying_details_about_a_workspace.rst deleted file mode 100644 index 84b35610..00000000 --- a/modelarts/api-ref/result/workspace_management/querying_details_about_a_workspace.rst +++ /dev/null @@ -1,143 +0,0 @@ -.. _ShowWorkspaceInfo: - -Querying Details About a Workspace -================================== - -Function --------- - -This API is used to obtain details about a workspace. - -URI ---- - -GET /v1/{project_id}/workspaces/{workspace_id} - -.. table:: **Table 1** Path parameters - - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +==============+===========+========+====================================================================================================================+ - | project_id | Yes | String | Project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - | workspace_id | Yes | String | Workspace ID. | - +--------------+-----------+--------+--------------------------------------------------------------------------------------------------------------------+ - -Request Parameters ------------------- - -None - -Response Parameters -------------------- - -**Status code: 200** - -.. table:: **Table 2** Response body parameters - - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=========================+=====================================================================+=================================================================================================================================================================================================================+ - | id | String | Workspace ID, which is a 32-bit UUID generated by the system without hyphens (-). The ID of the default workspace is **0**. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | String | Workspace name | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | description | String | Workspace description. Enter 0 to 256 characters. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | owner | String | Creator name. Enter 0 to 64 characters. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | create_time | Number | Time when a workspace was created, in UTC format | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | update_time | Number | Last modification time, in UTC format | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | auth_type | String | Authorization type. Options: | - | | | | - | | | - **PUBLIC**: public access of tenants (default value) | - | | | | - | | | - **PRIVATE**: accessible only to the creator and primary account | - | | | | - | | | - **INTERNAL**: accessible to the creator, primary account, and specified IAM users. This parameter must be used together with **grants**. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_id | String | Enterprise project ID | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | enterprise_project_name | String | Name of an enterprise project | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status | String | Workspace status. Options: | - | | | | - | | | - **CREATE_FAILED**: Creating the workspace failed. | - | | | | - | | | - **NORMAL**: The workspace is running properly. | - | | | | - | | | - **DELETING**: The workspace is being deleted. | - | | | | - | | | - **DELETE_FAILED**: Deleting the workspace failed. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | status_info | String | Status description. By default, this parameter is left blank. This parameter is used to show detailed information about a status. If a deletion failed, you can use this parameter to obtain the failure cause. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | grants | Array of :ref:`grants ` objects | List of authorized users, which is left blank by default. This parameter must be used together with **auth_type** and takes effect only when **auth_type** is set to **INTERNAL**. | - +-------------------------+---------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _showworkspaceinfo__response_grants: - -.. table:: **Table 3** grants - - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +===========+========+===========================================================================================================================+ - | user_id | String | User ID. Either this parameter or **user_name** must be set. If both of them are set, **user_id** is used preferentially. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - | user_name | String | IAM username. Either this parameter or **user_id** must be set. | - +-----------+--------+---------------------------------------------------------------------------------------------------------------------------+ - -Example Requests ----------------- - -Querying Details About a Workspace - -.. code-block:: - - GET https://{endpoint}/v1/{project_id}/workspaces/{workspace_id} - -Example Responses ------------------ - -**Status code: 200** - -OK - -.. code-block:: - - { - "id" : "**d05d1a553b4e188ea878e7dcb85e**", - "name" : "test-workspace", - "status" : "NORMAL", - "status_info" : "", - "description" : "", - "owner" : "testUser", - "create_time" : 1470000020000, - "update_time" : 1470000030000, - "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***", - "enterprise_project_name" : "test-eps", - "auth_type" : "INTERNAL", - "grants" : [ { - "user_id" : "***55d2cd53b4x458ea878e7dcb85***", - "user_name" : "test-iam-user" - } ] - } - -Status Codes ------------- - -=========== =================== -Status Code Description -=========== =================== -200 OK -400 BadRequest -403 Forbidden -500 InternalServerError -=========== =================== - -Error Codes ------------ - -See :ref:`Error Codes `. diff --git a/modelarts/umn/result/change_history.rst b/modelarts/umn/result/change_history.rst deleted file mode 100644 index 96665e28..00000000 --- a/modelarts/umn/result/change_history.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_04_0099: - -Change History -============== - -=========== =================================== -Released On Description -=========== =================================== -2021-04-30 This is the first official release. -=========== =================================== diff --git a/modelarts/umn/result/custom_images/creating_and_uploading_a_custom_image.rst b/modelarts/umn/result/custom_images/creating_and_uploading_a_custom_image.rst deleted file mode 100644 index 8231155b..00000000 --- a/modelarts/umn/result/custom_images/creating_and_uploading_a_custom_image.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. _modelarts_23_0085: - -Creating and Uploading a Custom Image -===================================== - -ModelArts allows you to use custom images to create training jobs and import models. Before creating and uploading a custom image, understand the following information: - -- Software Repository for Container (SWR) - - SWR provides easy, secure, and reliable management over Docker container images throughout their lifecycle, facilitating the deployment of containerized applications. You can push, pull, and manage container images through SWR console, SWR APIs, or community Command Line Interface (CLI). - - Obtain the custom images used by ModelArts for model training and import from the SWR service management list. Upload the custom images you create to SWR. - -- Specifications for custom images. For details about how to use a custom image for a training job, see :ref:`Specifications for Custom Images Used for Training Jobs `. For details about how to use a custom image for model import, see :ref:`Specifications for Custom Images Used for Importing Models `. - -.. _modelarts_23_0085__en-us_topic_0171858297_section125639162589: - -.. _creating-and-uploading-a-custom-image-1: - -Creating and Uploading a Custom Image -------------------------------------- - -#. Purchase a cloud server or use a local host to set up the Docker environment. -#. Obtain the basic image from the local environment. -#. Compile a Dockerfile based on your requirements to build a custom image. For details about how to efficiently compile a Dockerfile, see *SoftWare Repository for Container Best Practices*. - -4. After customizing an image, upload the image to SWR by referring to "Uploading an Image Through a Docker Client" in *Software Repository for Container User Guide*. diff --git a/modelarts/umn/result/custom_images/for_importing_models/importing_a_model_using_a_custom_image.rst b/modelarts/umn/result/custom_images/for_importing_models/importing_a_model_using_a_custom_image.rst deleted file mode 100644 index ab1c2ab8..00000000 --- a/modelarts/umn/result/custom_images/for_importing_models/importing_a_model_using_a_custom_image.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _modelarts_23_0086: - -Importing a Model Using a Custom Image -====================================== - -After creating and uploading a custom image to SWR, you can use the image to import a model and deploy the model as a service on the ModelArts management console. - -Prerequisites -------------- - -- You have created a custom image package based on ModelArts specifications. For details about the specifications you need to comply with when using a custom image to import a model, see :ref:`Specifications for Custom Images Used for Importing Models `. -- You have uploaded the custom image to SWR. For details, see :ref:`Creating and Uploading a Custom Image `. - -Importing a Model ------------------ - -Set basic parameters for importing a model according to :ref:`Importing a Meta Model from a Container Image `. When importing a model using a custom image, pay attention to the settings of **Meta Model Source** and **Configuration File**. - -- **Meta Model Source** - - Select **Container Image**. Click |image1| in the edit box of **Container Image Path** to select an image. The system automatically lists all images uploaded to SWR. Select an image based on the site requirements. - -- **Configuration File** - - The model configuration file needs to be compiled independently. For details about how to compile the model configuration file, see :ref:`Specifications for Compiling the Model Configuration File `. For details about the configuration file examples of a custom image, see :ref:`Example of the Custom Image Model Configuration File `. After editing the model configuration file based on the ModelArts specifications, upload it to OBS or use **Edit online** on the **Import Model** page. - -Deploying a Service -------------------- - -After a model is successfully imported using a custom image, that is, the model status is normal, you can deploy the model as a service. On the **Models** page, click **Deploy** in the **Operation** column and select a service type, for example, **Real-time Service**. - -You can deploy models as real-time or batch services based on the business logic of your custom image. The procedure for deploying a model imported using other methods is the same as that for deploying a model imported using a custom image. For details, see :ref:`Introduction to Model Deployment `. - -.. |image1| image:: /_static/images/en-us_image_0000001156920767.png - diff --git a/modelarts/umn/result/custom_images/for_importing_models/index.rst b/modelarts/umn/result/custom_images/for_importing_models/index.rst deleted file mode 100644 index df0a971a..00000000 --- a/modelarts/umn/result/custom_images/for_importing_models/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0218: - -==================== -For Importing Models -==================== - -.. toctree:: - :maxdepth: 1 - - specifications_for_custom_images_used_for_importing_models - importing_a_model_using_a_custom_image diff --git a/modelarts/umn/result/custom_images/for_importing_models/specifications_for_custom_images_used_for_importing_models.rst b/modelarts/umn/result/custom_images/for_importing_models/specifications_for_custom_images_used_for_importing_models.rst deleted file mode 100644 index 8065dfee..00000000 --- a/modelarts/umn/result/custom_images/for_importing_models/specifications_for_custom_images_used_for_importing_models.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _modelarts_23_0219: - -Specifications for Custom Images Used for Importing Models -========================================================== - -When creating an image using locally developed models, ensure that they meet the specifications defined by ModelArts. - -Specifications for Custom Images Used for Model Management ----------------------------------------------------------- - -- Custom images cannot contain malicious code. - -- The size of a custom image cannot exceed 30 GB. - -- **External port of images** - - The external service port of the image must be **8080**. The inference interface must be consistent with the URL defined by **apis** in the **config.json** file. The inference interface can be directly accessed when the image is started. The following is an example of accessing the **mnist** image. The image contains the model trained with the **mnist** dataset. The model can identify handwritten digits in images. In this example, *listen_ip* indicates the IP address of the container. - - - Sample request: **curl -X POST \\ http://{listen_ip}:8080/ \\ -F images=@seven.jpg** - - - Sample response - - .. code-block:: - - {"mnist_result": 7} - -- **Health check port** - - A custom image must provide a health check interface for ModelArts to call. The health check interface is configured in the **config.json** file. For details, see the model configuration file compilation description. A sample health check interface is as follows: - - - URI - - .. code-block:: - - GET /health - - - Sample request: **curl -X GET \\ http://{listen_ip}:8080/health** - - - Sample response - - .. code-block:: - - {"health": "true"} - - - Status code - - .. table:: **Table 1** Status code - - =========== ======= ================== - Status Code Message Description - =========== ======= ================== - 200 OK Successful request - =========== ======= ================== - -- **Log file output** - - To ensure that the log content can be displayed normally, the logs must be standard output. - -- **Image boot file** - - To deploy a batch service, set the boot file of an image to **/home/run.sh** and use CMD to set the default boot path. The following is a sample **Dockerfile**. - - **CMD /bin/sh /home/run.sh** - -- **Image dependencies** - - To deploy a batch service, install component packages such as Python, JRE/JDK, and ZIP in the image. diff --git a/modelarts/umn/result/custom_images/for_training_models/creating_a_training_job_using_a_custom_image_gpu.rst b/modelarts/umn/result/custom_images/for_training_models/creating_a_training_job_using_a_custom_image_gpu.rst deleted file mode 100644 index 1f6c7551..00000000 --- a/modelarts/umn/result/custom_images/for_training_models/creating_a_training_job_using_a_custom_image_gpu.rst +++ /dev/null @@ -1,98 +0,0 @@ -.. _modelarts_23_0087: - -Creating a Training Job Using a Custom Image (GPU) -================================================== - -After creating and uploading a custom image to SWR, you can use the image to create a training job on the ModelArts management console to complete model training. - -Prerequisites -------------- - -- You have created a custom image package based on ModelArts specifications. For details about the specifications you need to comply with when using a custom image to create training jobs, see :ref:`Specifications for Custom Images Used for Training Jobs `. -- You have uploaded the custom image to SWR. For details, see :ref:`Creating and Uploading a Custom Image `. - -Creating a Training Job ------------------------ - -Log in to the ModelArts management console and create a training job according to :ref:`Creating a Training Job `. When using a custom image to create a job, pay attention to the settings of **Algorithm Source**, **Environment Variable**, and **Resource Pool**. - -- **Algorithm Source** - - Select **Custom**. - - - **Image Path**: SWR URL after the image is uploaded to SWR - - .. _modelarts_23_0087__en-us_topic_0171858299_fig1610311596365: - - .. figure:: /_static/images/en-us_image_0000001156920769.png - :alt: **Figure 1** SWR image address - - - **Figure 1** SWR image address - - - **Code Directory**: OBS path for storing the training code file. - - - **Boot Command**: boot command after the image is started. The basic format is as follows: - - **bash /home/work/run_train.sh {UserCommand}** - - **bash /home/work/run_train.sh [python/bash/..] {file_location} {file_parameter}** - - **run_train.sh** is the training boot script. After this script is executed, ModelArts recursively downloads all content in the code directory to the local path of the container. The local path is in the format of **/home/work/user-job-dir/${**\ *Name of the last level in the code directory*}\ **/**. - - For example, if the OBS path of the training code file is **obs://obs-bucket/new/train.py** and the code directory is **obs://obs-bucket/new/**, the local path of the container is **/home/work/user-job-dir/new/**. The local training code path of the container is **/home/work/user-job-dir/new/train.py**. Then, you can set the boot command to the following: **bash /home/work/run_train.sh python /home/work/user-job-dir/new/train.py {python_file_parameter}** - - .. note:: - - If you create a training job using a custom image, ModelArts allows you to customize the boot command. The following are two basic formats for the boot command: - - **bash /home/work/run_train.sh {UserCommand}** - - **bash /home/work/run_train.sh [python/bash/..] {file_location} {file_parameter}** - - **run_train.sh** is the training boot script. When creating a custom image, you can implement the training boot script or place the training code in the custom image environment in advance to customize the boot command (in the basic formats or any other formats). - -- **Environment Variable** - - After the container is started, besides the environment variables added by configuring **Environment Variable** during training job creation, :ref:`Table 1 ` lists other environment variables to be loaded. You can determine whether to use these environment variables in your own Python training script, or run the **{python_file_parameter}** command to pass the required parameters. - - .. _modelarts_23_0087__en-us_topic_0171858299_table341782301619: - - .. table:: **Table 1** Optional environment variables - - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Environment Variable | Description | - +======================================+==============================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | DLS_TASK_INDEX | Container index, starting from 0. | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DLS_TASK_NUMBER | Number of containers, corresponding to **Compute Nodes** | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DLS_APP_URL | Code directory, corresponding to **Code Dir** with the protocol name added. For example, you can use **$DLS_APP_URL/*.py** to read files in OBS. | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DLS_DATA_URL | Dataset path, corresponding to **Data Source** with the protocol name added | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | DLS_TRAIN_URL | Training output path, corresponding to **Training Output Path** with the protocol name added | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | BATCH_{jobName}.0_HOSTS (standalone) | For standalone training, that is, when the number of compute nodes is 1, the environment variable is **BATCH_{jobName}.0_HOSTS**. | - | | | - | | The format of the **HOSTS** environment variable is **hostname:port**. A container can view the **HOSTS** of all containers in the same job, such as **BATCH_CUSTOM0_HOSTS** and **BATCH_CUSTOM1_HOSTS**, varying according to the indexes. If the resource pool is a dedicated resource pool with the **8GPU** specifications, the network type of the container is a host network, and the host IB network can be used to accelerate communications. If other resource pools are used, the network is a container network. | - | | | - | | .. note:: | - | | | - | | When the host IB network is used for communication acceleration, the **ip_mapper.py** tool is required to obtain the IP address of the **ib0** NIC for using the IPoIB feature. | - +--------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- **Resource Pool** - - If you select a resource pool of the GPU type, ModelArts mounts NVME SSDs to the **/cache** directory. You can use this directory to store temporary files. - -Running a Training Job Created Using a Custom Image ---------------------------------------------------- - -After a custom image is uploaded to SWR, ModelArts is authorized to obtain and run the image by default when you create a training job using the custom image. When a custom image is run for the first time, the image is checked first. For details about the check, see :ref:`Specifications for Custom Images Used for Training Jobs `. The check failure cause is outputted in the log, and you can modify the image based on the log. - -After the image is checked, the backend starts the custom image container to run the training job. You can view the training status based on the log. - -.. note:: - - After an image is reviewed, the image does not need to be reviewed again when being used to create training jobs again. diff --git a/modelarts/umn/result/custom_images/for_training_models/index.rst b/modelarts/umn/result/custom_images/for_training_models/index.rst deleted file mode 100644 index f9b6d656..00000000 --- a/modelarts/umn/result/custom_images/for_training_models/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0216: - -=================== -For Training Models -=================== - -.. toctree:: - :maxdepth: 1 - - specifications_for_custom_images_used_for_training_jobs - creating_a_training_job_using_a_custom_image_gpu diff --git a/modelarts/umn/result/custom_images/for_training_models/specifications_for_custom_images_used_for_training_jobs.rst b/modelarts/umn/result/custom_images/for_training_models/specifications_for_custom_images_used_for_training_jobs.rst deleted file mode 100644 index 104dc43a..00000000 --- a/modelarts/umn/result/custom_images/for_training_models/specifications_for_custom_images_used_for_training_jobs.rst +++ /dev/null @@ -1,128 +0,0 @@ -.. _modelarts_23_0217: - -Specifications for Custom Images Used for Training Jobs -======================================================= - -When creating an image using locally developed models and training scripts, ensure that they meet the specifications defined by ModelArts. - -Specifications --------------- - -- Custom images cannot contain malicious code. -- Part of content in the basic images cannot be changed, including all the files in **/bin**, **/sbin**, **/usr**, and **/lib(64)**, some important configuration files in **/etc**, and the ModelArts tools in **$HOME**. -- A file cannot be added whose owner is **root** and has permission **setuid** or **setgid**. -- The size of a custom image cannot exceed 9.5 GB. - -- To ensure that the log content can be displayed normally, the logs must be standard output. -- The default user of a custom image must be the user whose UID is **1101**. -- Custom images can be developed based on basic ModelArts images. For details about the supported basic images, see :ref:`Overview of a Basic Image Package `. -- Currently, the ModelArts backend does not support the download of open source installation packages. You are advised to install the dependency packages required for training in the custom image. - -.. _modelarts_23_0217__en-us_topic_0212179951_section1126616610513: - -Overview of a Basic Image Package ---------------------------------- - -To facilitate code download, training log output, and log file upload to OBS, ModelArts provides basic image packages for creating custom images. The basic images provided by ModelArts have the following features: - -- Some necessary tools are available in the basic image. You need to create a custom image based on the basic images provided by ModelArts. -- ModelArts continuously updates the basic image versions. For compatible updates, after the basic images are updated, you can still use the old images. For incompatible updates, the custom images created based on the old version cannot run on ModelArts, but the approved custom images can still be used. -- If a custom image fails to be approved and the audit log contains an error message indicating that the basic image does not match, you need to use a new basic image to create an image. - -Run the following command to obtain a ModelArts image: - -.. code-block:: - - docker pull
- -After customizing an image, upload it to SWR. Make sure that you have created an organization and obtained the password for logging in to SWR. For details, see "Image Management" > "Uploading an Image Through SWR Console" in *Software Repository for Container User Guide*. - -.. code-block:: - - docker push swr..xxx.com// - -Obtain basic images based on chip requirements: - -- :ref:`CPU-based Basic Images ` -- :ref:`GPU-based Basic Images ` - -.. _modelarts_23_0217__en-us_topic_0212179951_section2357164275019: - -CPU-based Basic Images ----------------------- - -Address for obtaining a basic image - -.. code-block:: - - swr..xxx.com/modelarts-job-dev-image/custom-cpu-base:1.3 - -:ref:`Table 1 ` and :ref:`Table 2 ` list the components and tools used by basic images. - -.. _modelarts_23_0217__en-us_topic_0212179951_table42317014714: - -.. table:: **Table 1** Components - - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | Description | - +==============+===================================================================================================================================================================================+ - | run_train.sh | Training boot script. You can download the code directory, run training commands, redirect training log output, and upload log files to OBS after training commands are executed. | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0217__en-us_topic_0212179951_table624501372: - -.. table:: **Table 2** Tool list - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Tool | Description | - +===================================+==========================================================================================================================================================+ - | utils.sh | Tool script. The **run_train.sh** script depends on this script. | - | | | - | | It provides methods such as SK decryption, code directory download, and log file upload. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_mapper.py | Script for obtaining NIC addresses. | - | | | - | | By default, the IP address of the **ib0** NIC is obtained. Training code can use the IP address of the **ib0** NIC to accelerate network communications. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dls-downloader.py | OBS download script. The **utils.sh** script depends on this script. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0217__en-us_topic_0212179951_section125281544151710: - -GPU-based Basic Images ----------------------- - -Addresses for obtaining a basic image - -.. code-block:: - - swr..xxx.com/modelarts-job-dev-image/custom-gpu-cuda9-base:1.3 - swr..xxx.com/modelarts-job-dev-image/custom-gpu-cuda92-base:1.3 - swr..xxx.com/modelarts-job-dev-image/custom-gpu-cuda10-cudnn74-base:1.1-4 - swr..xxx.com/modelarts-job-dev-image/custom-base-cuda10.0-cp36-ubuntu18.04-x86:1.1 - swr..xxx.com/modelarts-job-dev-image/custom-base-cuda10.1-cp36-ubuntu18.04-x86:1.1 - swr..xxx.com/modelarts-job-dev-image/custom-base-cuda10.2-cp36-ubuntu18.04-x86:1.1 - -.. table:: **Table 3** Components - - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | Description | - +==============+===================================================================================================================================================================================+ - | run_train.sh | Training boot script. You can download the code directory, run training commands, redirect training log output, and upload log files to OBS after training commands are executed. | - +--------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 4** Tool list - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Tool | Description | - +===================================+==========================================================================================================================================================+ - | utils.sh | Tool script. The **run_train.sh** script depends on this script. | - | | | - | | It provides methods such as SK decryption, code directory download, and log file upload. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ip_mapper.py | Script for obtaining NIC addresses. | - | | | - | | By default, the IP address of the **ib0** NIC is obtained. Training code can use the IP address of the **ib0** NIC to accelerate network communications. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dls-downloader.py | OBS download script. The **utils.sh** script depends on this script. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/custom_images/index.rst b/modelarts/umn/result/custom_images/index.rst deleted file mode 100644 index 0db244b7..00000000 --- a/modelarts/umn/result/custom_images/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0083: - -============= -Custom Images -============= - -.. toctree:: - :maxdepth: 1 - - introduction_to_custom_images - creating_and_uploading_a_custom_image - for_training_models/index - for_importing_models/index diff --git a/modelarts/umn/result/custom_images/introduction_to_custom_images.rst b/modelarts/umn/result/custom_images/introduction_to_custom_images.rst deleted file mode 100644 index baf78fa8..00000000 --- a/modelarts/umn/result/custom_images/introduction_to_custom_images.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _modelarts_23_0084: - -Introduction to Custom Images -============================= - -ModelArts provides multiple frequently-used built-in engines. However, when users have special requirements for the deep learning engine and development library, the built-in AI engines cannot meet user requirements. ModelArts provides the custom image function to allow users to customize engines. - -The bottom layer of ModelArts uses the container technology. Custom images refer to that users create container images and run them on ModelArts. The custom image function supports command line parameters and environment variables in free-text format. The custom images are highly flexible and support the job boot requirements of any computing engine. - -The following services are also required for creating a custom image: Software Repository for Container (SWR), OBS, and Elastic Cloud Server (ECS) - -Application Scenarios of Custom Images --------------------------------------- - -- **For Training Models** - - If you have developed a model or training script locally and the AI engine you use is not supported by ModelArts, you can create a custom image based on the basic image packages provided by ModelArts and upload the custom image to SWR. Then, you can use the custom image to create a training job on ModelArts and use the resources provided by ModelArts to train models. - -- **For Importing Models** - - If you use an AI engine that is not supported by ModelArts to develop a model, you can create a custom image, import the image to ModelArts for unified management, and deploy the model as a service. diff --git a/modelarts/umn/result/data_management/creating_a_dataset.rst b/modelarts/umn/result/data_management/creating_a_dataset.rst deleted file mode 100644 index 5a90980e..00000000 --- a/modelarts/umn/result/data_management/creating_a_dataset.rst +++ /dev/null @@ -1,335 +0,0 @@ -.. _modelarts_23_0004: - -Creating a Dataset -================== - -To manage data using ModelArts, create a dataset. Then you can perform operations on the dataset, such as labeling data, importing data, and publishing the dataset. - -Prerequisites -------------- - -- Before using the data management function, you need permissions to access OBS. This function cannot be used if you are not authorized to access OBS. Before using the data management function, go to the **Settings** page and complete access authorization using an agency. -- You have created OBS buckets and folders for storing data. In addition, the OBS buckets and ModelArts are in the same region. -- You have uploaded data to be used to OBS. - -Procedure ---------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. -#. Click **Create Dataset**. On the **Create Dataset** page, create datasets of different types based on the data type and data labeling requirements. - - a. Set the basic information, the name and description of the dataset. - - .. _modelarts_23_0004__en-us_topic_0170886809_fig17294143617510: - - .. figure:: /_static/images/en-us_image_0000001157080905.png - :alt: **Figure 1** Basic information about a dataset - - - **Figure 1** Basic information about a dataset - - b. Select a labeling scene and type as required. For details about the types supported by ModelArts, see :ref:`Dataset Types `. - - .. _modelarts_23_0004__en-us_topic_0170886809_fig3599174864: - - .. figure:: /_static/images/en-us_image_0000001110761058.png - :alt: **Figure 2** Selecting a labeling scene and type - - - **Figure 2** Selecting a labeling scene and type - - c. Set the parameters based on the dataset type. For details, see the parameters of the following dataset types: - - - :ref:`Images (Image Classification, Object Detection, and Image Segmentation) ` - - :ref:`Audio (Sound Classification, Speech Labeling, and Speech Paragraph Labeling) ` - - :ref:`Text (Text Classification, Named Entity Recognition, and Text Triplet) ` - - :ref:`Table ` - - :ref:`Video ` - - :ref:`Other (Free Format) ` - - d. Click **Create** in the lower right corner of the page. - - After the dataset is created, the dataset management page is displayed. You can perform the following operations on the dataset: label data, publish dataset versions, manage dataset versions, modify the dataset, import data, and delete the dataset. For details about the operations supported by different types of datasets, see . - -.. _modelarts_23_0004__en-us_topic_0170886809_section8625131415541: - -Images (Image Classification, Object Detection, and Image Segmentation) ------------------------------------------------------------------------ - -.. _modelarts_23_0004__en-us_topic_0170886809_fig773235071210: - -.. figure:: /_static/images/en-us_image_0000001157080911.png - :alt: **Figure 3** Parameters of datasets for image classification and object detection - - - **Figure 3** Parameters of datasets for image classification and object detection - -.. table:: **Table 1** Dataset parameters - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=====================================================================================================================================================================================================================================================================================================================================================================================+ - | Input Dataset Path | Select the OBS path to the input dataset. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path to the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. Select an empty directory as the **Output Dataset Path**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set | - **Label Name**: Enter a label name. The label name can contain only letters, digits, underscores (_), and hyphens (-). The name contains 1 to 32 characters. | - | | | - | | - **Add Label**: Click **Add Label** to add more labels. | - | | | - | | - Setting a label color: This function is available only for datasets of the object detection type. Select a color from the color palette on the right of a label, or enter the hexadecimal color code to set the color. | - | | | - | | - Setting label attributes: For an object detection dataset, you can click the plus sign (+) on the right to add label attributes after setting a label color. Label attributes are used to distinguish different attributes of the objects with the same label. For example, yellow kittens and black kittens have the same label **cat** and their label attribute is **color**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Team Labeling | Enable or disable team labeling. Image segmentation does not support team labeling. Therefore, this parameter is unavailable when you use image segmentation. | - | | | - | | After enabling team labeling, enter the name and type of the team labeling task, and select the labeling team and team members. For details about the parameter settings, see :ref:`Creating Team Labeling Tasks `. | - | | | - | | Before enabling team labeling, ensure that you have added a team and members on the **Labeling Teams** page. If no labeling team is available, click the link on the page to go to the **Labeling Teams** page, and add your team and members. For details, see :ref:`Introduction to Team Labeling `. | - | | | - | | After a dataset is created with team labeling enabled, you can view the **Team Labeling** mark in **Labeling Type**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_section17893314546: - -Audio (Sound Classification, Speech Labeling, and Speech Paragraph Labeling) ----------------------------------------------------------------------------- - -.. _modelarts_23_0004__en-us_topic_0170886809_fig107351821153417: - -.. figure:: /_static/images/en-us_image_0000001157080903.png - :alt: **Figure 4** Parameters of datasets for sound classification, speech labeling, and speech paragraph labeling - - - **Figure 4** Parameters of datasets for sound classification, speech labeling, and speech paragraph labeling - -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter | Description | -+==============================================+======================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| Input Dataset Path | Select the OBS path to the input dataset. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Output Dataset Path | Select the OBS path to the output dataset. | -| | | -| | .. note:: | -| | | -| | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. Select an empty directory as the **Output Dataset Path**. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Label Set (Sound Classification) | Set labels only for datasets of the sound classification type. | -| | | -| | - **Label Name**: Enter a label name. The label name can contain only letters, digits, underscores (_), and hyphens (-). The name contains 1 to 32 characters. | -| | - **Add Label**: Click **Add Label** to add more labels. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Label Management (Speech Paragraph Labeling) | Only datasets for speech paragraph labeling support multiple labels. | -| | | -| | - **Single Label** | -| | | -| | A single label is used to label a piece of audio that has only one class. | -| | | -| | - **Label Name**: Enter a label name. The label name can contain contains 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. | -| | - **Label Color**: Set the label color in the **Label Color** column. You can select a color from the color palette or enter a hexadecimal color code to set the color. | -| | | -| | - **Multiple Labels** | -| | | -| | Multiple labels are suitable for multi-dimensional labeling. For example, you can label a piece of audio as both noise and speech. For speech, you can label the audio with different speakers. You can click **Add Label Class** to add multiple label classes. A label class can contain multiple labels. The label class and name can contain contains 1 to 32 characters. Only letters, digits, underscores (_), and hyphens (-) are allowed. | -| | | -| | - **Label Class**: Set a label class. | -| | - **Label Name**: Enter a label name. | -| | - **Add Label**: Click **Add Label** to add more labels. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Speech Labeling (Speech Paragraph Labeling) | Only datasets for speech paragraph labeling support speech labeling. By default, speech labeling is disabled. If this function is enabled, you can label speech content. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Team Labeling | Only datasets of speech paragraph labeling support team labeling. | -| | | -| | After enabling team labeling, set the name and type of the team labeling task, and select the team and team members. For details about the parameter settings, see :ref:`Creating Team Labeling Tasks `. | -| | | -| | Before enabling team labeling, ensure that you have added a team and members on the **Labeling Teams** page. If no labeling team is available, click the link on the page to go to the **Labeling Teams** page, and add your team and members. For details, see :ref:`Introduction to Team Labeling `. | -| | | -| | After a dataset is created with team labeling enabled, you can view the **Team Labeling** mark in **Labeling Type**. | -+----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_section16230452125420: - -Text (Text Classification, Named Entity Recognition, and Text Triplet) ----------------------------------------------------------------------- - -.. _modelarts_23_0004__en-us_topic_0170886809_fig13128845173710: - -.. figure:: /_static/images/en-us_image_0000001110920960.png - :alt: **Figure 5** Parameters of datasets for text classification, named entity recognition, and text triplet - - - **Figure 5** Parameters of datasets for text classification, named entity recognition, and text triplet - -.. table:: **Table 2** Dataset parameters - - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +==================================================================+=======================================================================================================================================================================================================================================================================================================================================================+ - | Input Dataset Path | Select the OBS path to the input dataset. | - | | | - | | .. note:: | - | | | - | | Labeled text classification data can be identified only when you import data. When creating a dataset, set an empty OBS directory. After the dataset is created, import the labeled data into it. For details about the format of the data to be imported, see :ref:`Specifications for Importing Data from an OBS Directory `. | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path to the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. Select an empty directory as the **Output Dataset Path**. | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set (for text classification and named entity recognition) | - **Label Name**: Enter a label name. The label name can contain only letters, digits, underscores (_), and hyphens (-). The name contains 1 to 32 characters. | - | | | - | | - **Add Label**: Click **Add Label** to add more labels. | - | | | - | | - Setting a label color: Select a color from the color palette or enter the hexadecimal color code to set the color. | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set (for text triplet) | For datasets of the text triplet type, set entity labels and relationship labels. | - | | | - | | - **Entity Label**: Set the label name and label color. You can click the plus sign (+) on the right of the color area to add multiple labels. | - | | - **Relationship Label**: a relationship between two entities. Set the source entity and target entity. Therefore, add at least two entity labels before adding a relationship label. | - | | | - | | |image1| | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Team Labeling | Enable or disable team labeling. | - | | | - | | After enabling team labeling, enter the name and type of the team labeling task, and select the labeling team and team members. For details about the parameter settings, see :ref:`Creating Team Labeling Tasks `. | - | | | - | | Before enabling team labeling, ensure that you have added a team and members on the **Labeling Teams** page. If no labeling team is available, click the link on the page to go to the **Labeling Teams** page, and add your team and members. For details, see :ref:`Introduction to Team Labeling `. | - | | | - | | After a dataset is created with team labeling enabled, you can view the **Team Labeling** mark in **Labeling Type**. | - +------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_section4103145619546: - -Table ------ - -.. note:: - - When using a CSV file, pay attention to the following: - - - When the data type is set to **String**, the data in the double quotation marks is regarded as one record by default. Ensure that the double quotation marks in the same row are closed. Otherwise, the data will be too large to display. - - If the number of columns in a row of the CSV file is different from that defined in the schema, the row will be ignored. - -.. table:: **Table 3** Dataset parameters - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==============================================================================================================================================================================================================================================================================================+ - | Storage Path | Select the OBS path for storing table data. The data imported from the data source is stored in this path. The path cannot be the same as or a subdirectory of the file path in the OBS data source. | - | | | - | | After a table dataset is created, the following four directories are automatically generated in the storage path: | - | | | - | | - **annotation**: version publishing directory. Each time a version is published, a subdirectory with the same name as the version is generated in this directory. | - | | - **data**: data storage directory. Imported data is stored in this directory. | - | | - **logs**: directory for storing logs | - | | - **temp**: temporary working directory | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Import | If you have stored table data on other cloud services, you can enable this function to import data stored on OBS, DLI, or MRS. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data Source (OBS) | - **File Path**: Browse all OBS buckets of the account and select the directory where the data file to be imported is located. | - | | - **Contain Table Header**: If this parameter is enabled, the imported file contains table headers. In this case, the first row of the imported file is used as the column name. Otherwise, the default column name is added and automatically filled in the schema information. | - | | | - | | For details about OBS functions, see *Object Storage Service Console Operation Guide*. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Schema | Names and types of table columns, which must be the same as those of the imported data. Set the column name based on the imported data and select the column type. For details about the supported types, see :ref:`Table 4 `. | - | | | - | | Click **Add Schema** to add a new record. When creating a dataset, you must specify a schema. Once created, the schema cannot be modified. | - | | | - | | When data is imported from OBS, the schema of the CSV file in the file path is automatically obtained. If the schemas of multiple CSV files are inconsistent, an error is reported. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_table1916832104917: - -.. table:: **Table 4** Migration data types - - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Type | Description | Storage Space | Range | - +===========+========================================================================+===============+=============================================+ - | String | String | - | - | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Short | Signed integer | 2 bytes | -32768 to 32767 | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Int | Signed integer | 4 bytes | –2147483648 to 2147483647 | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Long | Signed integer | 8 bytes | –9223372036854775808 to 9223372036854775807 | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Double | Double-precision floating point | 8 bytes | - | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Float | Single-precision floating point | 4 bytes | - | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Byte | Signed integer | 1 byte | -128 to 127 | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Date | Date type in the format of *yyyy-MM-dd*, for example, 2014-05-29 | - | - | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Timestamp | Timestamp that represents date and time. Format: *yyyy-MM-dd HH:mm:ss* | - | - | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - | Boolean | Boolean | 1 byte | TRUE or FALSE | - +-----------+------------------------------------------------------------------------+---------------+---------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_section1357212065510: - -Video ------ - -.. _modelarts_23_0004__en-us_topic_0170886809_fig973555618557: - -.. figure:: /_static/images/en-us_image_0000001157080907.png - :alt: **Figure 6** Parameters of datasets of the video type - - - **Figure 6** Parameters of datasets of the video type - -.. table:: **Table 5** Dataset parameters - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+============================================================================================================================================================================================+ - | Input Dataset Path | Select the OBS path to the input dataset. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path to the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. Select an empty directory as the **Output Dataset Path**. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set | - **Label Name**: Enter a label name. The label name can contain only letters, digits, underscores (_), and hyphens (-). The name contains 1 to 32 characters. | - | | | - | | - **Add Label**: Click **Add Label** to add more labels. | - | | | - | | - Setting a label color: Select a color from the color palette or enter the hexadecimal color code to set the color. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0004__en-us_topic_0170886809_section359415145517: - -Other (Free Format) -------------------- - -.. _modelarts_23_0004__en-us_topic_0170886809_fig1957792145712: - -.. figure:: /_static/images/en-us_image_0000001156920933.png - :alt: **Figure 7** Parameters of datasets of the free format type - - - **Figure 7** Parameters of datasets of the free format type - -.. table:: **Table 6** Dataset parameters - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+============================================================================================================================================================================================+ - | Input Dataset Path | Select the OBS path to the input dataset. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path to the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. Select an empty directory as the **Output Dataset Path**. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. |image1| image:: /_static/images/en-us_image_0000001156920935.png - diff --git a/modelarts/umn/result/data_management/deleting_a_dataset.rst b/modelarts/umn/result/data_management/deleting_a_dataset.rst deleted file mode 100644 index bc13bd6b..00000000 --- a/modelarts/umn/result/data_management/deleting_a_dataset.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_23_0021: - -Deleting a Dataset -================== - -If a dataset is no longer in use, you can delete it to release resources. - -.. note:: - - After a dataset is deleted, if you need to delete the data in the dataset input and output paths in OBS to release resources, delete the data and the OBS folders on the OBS Console. - -Procedure ---------- - -#. In the left navigation pane, choose **Data Management > Datasets**. On the **Datasets** page, choose **More > Delete** in the **Operation** column of the dataset. -#. In the displayed dialog box, click **OK**. - - .. note:: - - After a dataset is deleted, some functions such as dataset version management become unavailable. Exercise caution when performing this operation. However, the original data and labeling data of the dataset are still stored in OBS. diff --git a/modelarts/umn/result/data_management/exporting_data.rst b/modelarts/umn/result/data_management/exporting_data.rst deleted file mode 100644 index 0a17d664..00000000 --- a/modelarts/umn/result/data_management/exporting_data.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_23_0214: - -Exporting Data -============== - -A dataset includes labeled and unlabeled data. You can select images or filter data based on the filter criteria and export to a new dataset or the specified OBS directory. In addition, you can view the task history to learn about the export records. - -.. note:: - - Only datasets of image classification, object detection, image segmentation, and free format types can be exported. - - - For image classification datasets, only the label files in TXT format can be exported. - - For object detection datasets, only XML label files in Pascal VOC format can be exported. - - For image segmentation datasets, only XML label files in Pascal VOC format and mask images can be exported. - - For free format datasets, all files of the datasets can be exported. - -Exporting Data to a New Dataset -------------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset of the object detection or image classification type and click the dataset name to go to the **Dashboard** tab page of the dataset. - - .. note:: - - For a dataset of the free format type, you can click the dataset name to directly access the dataset details page and go to :ref:`4 `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. - -#. .. _modelarts_23_0214__en-us_topic_0209632492_li114071010139: - - On the dataset details page, select or filter data to be exported. Click **Export To** and choose **New Dataset** from the drop-down list. - -#. In the displayed **Export to New Dataset** dialog box, enter the related information and click **OK**. - - **Name**: name of the new dataset - - **Storage Path**: input path of the new dataset, that is, the OBS path where the data to be exported is stored - - **Output Path**: output path of the new dataset, that is, the output path after labeling is complete. The output path cannot be the same as the storage path, and the output path cannot be a subdirectory of the storage path. - - **Export Content**: The options are **Export the selected samples** and **Export all samples meeting filtering criteria**. - -#. After the data is exported, you can view the new dataset in the dataset list. - -Exporting Data to OBS ---------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset of the object detection or image classification type and click the dataset name to go to the **Dashboard** tab page of the dataset. - - .. note:: - - For a dataset of the free format type, you can click the dataset name to directly access the dataset details page and go to :ref:`4 `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. - -#. .. _modelarts_23_0214__en-us_topic_0209632492_li2056103713438: - - On the dataset details page, select or filter data to be exported. Click **Export To** and choose **OBS** from the drop-down list. - -#. In the displayed **Export to OBS** dialog box, enter the related information and click **OK**. - - **Storage Path**: path where the data to be exported is stored. You are advised not to save data to the input or output path of the current dataset. - - **Export Content**: The options are **Export the selected samples** and **Export all samples meeting filtering criteria**. - -#. After the data is exported, you can view it in the specified path. - -Viewing the Task History ------------------------- - -When you export data to a new dataset or OBS, you can view the export task details in the **View Task History** dialog box. - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset of the object detection or image classification type and click the dataset name to go to the **Dashboard** tab page of the dataset. - - .. note:: - - For a dataset of the free format type, you can click the dataset name to directly access the dataset details page and go to :ref:`4 `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. - -#. .. _modelarts_23_0214__en-us_topic_0209632492_li19995141771413: - - On the dataset details page, select or filter data to be exported. Click **Export To** and choose **View Task History** from the drop-down list. - -#. In the **View Task History** dialog box, view the export task history of the current dataset. Information about **Task ID**, **Created**, **Type**, **Path**, **Total**, and **Status** is included. diff --git a/modelarts/umn/result/data_management/importing_data/import_operation.rst b/modelarts/umn/result/data_management/importing_data/import_operation.rst deleted file mode 100644 index 56495ed5..00000000 --- a/modelarts/umn/result/data_management/importing_data/import_operation.rst +++ /dev/null @@ -1,112 +0,0 @@ -.. _modelarts_23_0006: - -Import Operation -================ - -After a dataset is created, you can directly synchronize data from the dataset. Alternatively, you can import more data by importing the dataset. Data can be imported from an OBS directory or the manifest file. - -Prerequisites -------------- - -- You have created a dataset. -- You have stored the data to be imported in OBS. You have stored the manifest file in OBS. -- The OBS buckets and ModelArts are in the same region. - -Import Modes ------------- - -There are two import modes: **OBS path** and **Manifest file**. - -- **OBS path**: indicates that the dataset to be imported has been stored in an OBS directory in advance. In this case, you need to select an OBS path that you can access. In addition, the directory structure in the OBS path must comply with the specifications. For details, see :ref:`Specifications for Importing Data from an OBS Directory `. Only the following types of dataset support the **OBS path** import mode: **Image classification**, **Object detection**, **Text classification**, **Table**, and **Sound classification**. -- **Manifest file**: indicates that the dataset file is in the manifest format and data is imported from the manifest file. The manifest file defines the mapping between labeling objects and content. In addition, the manifest file has been uploaded to OBS. For details about the specifications of the manifest file, see :ref:`Specifications for Importing the Manifest File `. - -.. note:: - - Before importing an object detection dataset, ensure that the labeling range of the labeling file does not exceed the size of the original image. Otherwise, the import may fail. - -.. table:: **Table 1** Import modes supported by datasets - - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Dataset Type | Importing Data from an OBS Path | Importing Data from a Manifest File | - +===========================+==============================================================================================================================================+==================================================================================================================================================+ - | Image classification | Supported | Supported | - | | | | - | | Follow the format specifications described in :ref:`Image Classification `. | Follow the format specifications described in :ref:`Image Classification `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Object detection | Supported | Supported | - | | | | - | | Follow the format specifications described in :ref:`Object Detection `. | Follow the format specifications described in :ref:`Object Detection `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Image segmentation | Supported | Supported | - | | | | - | | Follow the format specifications described in :ref:`Image Segmentation `. | Follow the format specifications described in :ref:`Image Segmentation `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Sound classification | Supported | Supported | - | | | | - | | Follow the format specifications described in :ref:`Sound Classification `. | Follow the format specifications described in :ref:`Sound Classification `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Speech labeling | N/A | Supported | - | | | | - | | | Follow the format specifications described in :ref:`Speech Paragraph Labeling `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Speech paragraph labeling | N/A | Supported | - | | | | - | | | Follow the format specifications described in :ref:`Speech Labeling `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Text classification | Supported | Supported | - | | | | - | | Follow the format specifications described in :ref:`Text Classification `. | Follow the format specifications described in :ref:`Text Classification `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Named entity recognition | N/A | Supported | - | | | | - | | | Follow the format specifications described in :ref:`Named Entity Recognition `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Text triplet | N/A | Supported | - | | | | - | | | Follow the format specifications described in :ref:`Text Triplet `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Table | Supported | N/A | - | | | | - | | Follow the format specifications described in :ref:`Table `. | | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Video | N/A | Supported | - | | | | - | | | Follow the format specifications described in :ref:`Video Labeling `. | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - | Free format | N/A | N/A | - +---------------------------+----------------------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ - -Importing Data from an OBS Path -------------------------------- - -The parameters on the GUI for data import vary according to the dataset type. The following uses a dataset of the image classification type as an example. - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. Locate the row that contains the desired dataset and choose **More > Import** in the **Operation** column. - - Alternatively, you can click the dataset name to go to the **Dashboard** tab page of the dataset, and click **Import** in the upper right corner. - -#. In the **Import** dialog box, set **Import Mode** to **OBS path** and set **OBS path** to the path for storing data. Then click **OK**. - - After the data import is successful, the data is automatically synchronized to the dataset. On the **Datasets** page, you can click the dataset name to view its details and label the data. - -Importing Data from a Manifest File ------------------------------------ - -The parameters on the GUI for data import vary according to the dataset type. The following uses a dataset of the object detection type as an example. Datasets of the table type cannot be imported from the manifest file. - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. Locate the row that contains the desired dataset and choose **More > Import** in the **Operation** column. - - Alternatively, you can click the dataset name to go to the **Dashboard** tab page of the dataset, and click **Import** in the upper right corner. - -#. In the **Import** dialog box, set the parameters as follows and click **OK**. - - - **Import Mode**: Select **Manifest file**. - - **Manifest file**: Select the OBS path for storing the manifest file. - - **Import by Label**: The system automatically obtains the labels of the dataset. You can click **Add Label** to add a label or click the deletion icon on the right to delete a label. This field is optional. After importing a dataset, you can add or delete labels during data labeling. - - **Import labels**: If this parameter is selected, the labels defined in the manifest file are imported to the ModelArts dataset. - - After the data import is successful, the data is automatically synchronized to the dataset. On the **Datasets** page, you can click the dataset name to go to the **Dashboard** tab page of the dataset, and click **Label** in the upper right corner. On the displayed dataset details page, view detailed data and label data. diff --git a/modelarts/umn/result/data_management/importing_data/index.rst b/modelarts/umn/result/data_management/importing_data/index.rst deleted file mode 100644 index b9931234..00000000 --- a/modelarts/umn/result/data_management/importing_data/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0005: - -============== -Importing Data -============== - -.. toctree:: - :maxdepth: 1 - - import_operation - specifications_for_importing_data_from_an_obs_directory - specifications_for_importing_the_manifest_file diff --git a/modelarts/umn/result/data_management/importing_data/specifications_for_importing_data_from_an_obs_directory.rst b/modelarts/umn/result/data_management/importing_data/specifications_for_importing_data_from_an_obs_directory.rst deleted file mode 100644 index 9a2df156..00000000 --- a/modelarts/umn/result/data_management/importing_data/specifications_for_importing_data_from_an_obs_directory.rst +++ /dev/null @@ -1,307 +0,0 @@ -.. _modelarts_23_0008: - -Specifications for Importing Data from an OBS Directory -======================================================= - -When a dataset is imported, the data storage directory and file name must comply with the ModelArts specifications if the data to be used is stored in OBS. - -Only the following types of dataset support the **OBS path** import mode: **Image classification**, **Object detection**, **Text classification**, **Table**, and **Sound classification**. - -.. note:: - - To import data from an OBS directory, you must have the read permission on the OBS directory. - -.. _modelarts_23_0008__en-us_topic_0170886816_section570816190577: - -Image Classification --------------------- - -- Image classification data can be in two modes. The first mode (directory mode) supports only single labels. The second mode (**.txt** label files) supports multiple labels. - - - Images with the same label must be stored in the same directory, and the label name is the directory name. If there are multiple levels of directories, the last level is used as the label name. - - In the following example, **Cat** and **Dog** are label names. - - .. code-block:: - - dataset-import-example - ├─Cat - │ 10.jpg - │ 11.jpg - │ 12.jpg - │ - └─Dog - 1.jpg - 2.jpg - 3.jpg - - - If **.txt** files exist in the directory, the content in the **.txt** files is used as the image label. This mode is better than the previous one. - - In the following example, **import-dir-1** and **import-dir-2** are the imported subdirectories: - - .. code-block:: - - dataset-import-example - ├─import-dir-1 - │ 10.jpg - │ 10.txt - │ 11.jpg - │ 11.txt - │ 12.jpg - │ 12.txt - └─import-dir-2 - 1.jpg - 1.txt - 2.jpg - 2.txt - - The following shows a label file for a single label, for example, the **1.txt** file: - - .. code-block:: - - Cat - - The following shows a label file for multiple labels, for example, the **1.txt** file: - - .. code-block:: - - Cat - Dog - -- Only images in JPG, JPEG, PNG, and BMP formats are supported. The size of a single image cannot exceed 5 MB, and the total size of all images uploaded at a time cannot exceed 8 MB. - -.. _modelarts_23_0008__en-us_topic_0170886816_section1371122614572: - -Object Detection ----------------- - -- The simple mode of object detection requires users store labeled objects and their label files (in one-to-one relationship with the labeled objects) in the same directory. For example, if the name of the labeled object file is **IMG_20180919_114745.jpg**, the name of the label file must be **IMG_20180919_114745.xml**. - - The label files for object detection must be in PASCAL VOC format. For details about the format, see :ref:`Table 8 `. - - Example: - - .. code-block:: - - ├─dataset-import-example - │ IMG_20180919_114732.jpg - │ IMG_20180919_114732.xml - │ IMG_20180919_114745.jpg - │ IMG_20180919_114745.xml - │ IMG_20180919_114945.jpg - │ IMG_20180919_114945.xml - - A label file example is as follows: - - +-----------------------------------+-----------------------------------------------------------+ - | :: | :: | - | | | - | 1 | | - | 2 | | - | 3 | NA | - | 4 | bike_1_1593531469339.png | - | 5 | | - | 6 | Unknown | - | 7 | | - | 8 | | - | 9 | 554 | - | 10 | 606 | - | 11 | 3 | - | 12 | | - | 13 | 0 | - | 14 | | - | 15 | Dog | - | 16 | Unspecified | - | 17 | 0 | - | 18 | 0 | - | 19 | 0 | - | 20 | | - | 21 | 279 | - | 22 | 52 | - | 23 | 474 | - | 24 | 278 | - | 25 | | - | 26 | | - | 27 | | - | 28 | Cat | - | 29 | Unspecified | - | 30 | 0 | - | 31 | 0 | - | 32 | 0 | - | 33 | | - | 34 | 279 | - | 35 | 198 | - | 36 | 456 | - | 37 | 421 | - | 38 | | - | 39 | | - | 40 | | - +-----------------------------------+-----------------------------------------------------------+ - -- Only images in JPG, JPEG, PNG, and BMP formats are supported. The size of a single image cannot exceed 5 MB, and the total size of all images uploaded at a time cannot exceed 8 MB. - -.. _modelarts_23_0008__en-us_topic_0170886816_section1363851815518: - -Image Segmentation ------------------- - -- The simple mode of image segmentation requires users store labeled objects and their label files (in one-to-one relationship with the labeled objects) in the same directory. For example, if the name of the labeled object file is **IMG_20180919_114746.jpg**, the name of the label file must be **IMG_20180919_114746.xml**. - - Fields **mask_source** and **mask_color** are added to the label file in PASCAL VOC format. For details about the format, see :ref:`Table 4 `. - - Example: - - .. code-block:: - - ├─dataset-import-example - │ IMG_20180919_114732.jpg - │ IMG_20180919_114732.xml - │ IMG_20180919_114745.jpg - │ IMG_20180919_114745.xml - │ IMG_20180919_114945.jpg - │ IMG_20180919_114945.xml - - A label file example is as follows: - - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | | - | 2 | | - | 3 | NA | - | 4 | image_0006.jpg | - | 5 | | - | 6 | Unknown | - | 7 | | - | 8 | | - | 9 | 230 | - | 10 | 300 | - | 11 | 3 | - | 12 | | - | 13 | 1 | - | 14 | obs://xianao/out/dataset-8153-Jmf5ylLjRmSacj9KevS/annotation/V001/segmentationClassRaw/image_0006.png | - | 15 | | - | 16 | bike | - | 17 | Unspecified | - | 18 | 0 | - | 19 | 0 | - | 20 | 193,243,53 | - | 21 | 0 | - | 22 | | - | 23 | 71 | - | 24 | 48 | - | 25 | 75 | - | 26 | 73 | - | 27 | 49 | - | 28 | 69 | - | 29 | 68 | - | 30 | 92 | - | 31 | 90 | - | 32 | 101 | - | 33 | 45 | - | 34 | 110 | - | 35 | 71 | - | 36 | 48 | - | 37 | | - | 38 | | - | 39 | | - +-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0008__en-us_topic_0170886816_section163641141195713: - -Text Classification -------------------- - -Text classification supports two import modes. - -- The labeled objects and labels for text classification are in the same text file. You can specify a separator to separate the labeled objects and labels, as well as multiple labeled objects. - - For example, the following shows an example text file. The **Tab** key is used to separate the labeled object from the label. - - .. code-block:: - - It touches good and responds quickly. I don't know how it performs in the future. positive - Three months ago, I bought a very good phone and replaced my old one with it. It can operate longer between charges. positive - Why does my phone heat up if I charge it for a while? The volume button stuck after being pressed down. negative - It's a gift for Father's Day. The logistics is fast and I received it in 24 hours. I like the earphones because the bass sounds feel good and they would not fall off. positive - -- The labeled objects and label files for text classification are text files, and correspond to each other based on the rows. For example, the first row in a label file indicates the label of the first row in the file of the labeled object. - - For example, the content of labeled object **COMMENTS_20180919_114745.txt** is as follows: - - .. code-block:: - - It touches good and responds quickly. I don't know how it performs in the future. - Three months ago, I bought a very good phone and replaced my old one with it. It can operate longer between charges. - Why does my phone heat up if I charge it for a while? The volume button stuck after being pressed down. - It's a gift for Father's Day. The logistics is fast and I received it in 24 hours. I like the earphones because the bass sounds feel good and they would not fall off. - - The content of label file **COMMENTS_20180919_114745_result.txt** is as follows: - - .. code-block:: - - positive - negative - negative - positive - - The data format requires users to store labeled objects and their label files (in one-to-one relationship with the labeled objects) in the same directory. For example, if the name of the labeled object file is **COMMENTS_20180919_114745.txt**, the name of the label file must be **COMMENTS \_20180919_114745_result.txt**. - - Example of data file storage: - - .. code-block:: - - ├─dataset-import-example - │ COMMENTS_20180919_114732.txt - │ COMMENTS _20180919_114732_result.txt - │ COMMENTS _20180919_114745.txt - │ COMMENTS _20180919_114745_result.txt - │ COMMENTS _20180919_114945.txt - │ COMMENTS _20180919_114945_result.txt - -.. _modelarts_23_0008__en-us_topic_0170886816_section1683314458578: - -Sound Classification --------------------- - -For sound classification, sound files with the same label must be stored in the same directory, and the label name is the directory name. - -Example: - -.. code-block:: - - dataset-import-example - ├─Cat - │ 10.wav - │ 11.wav - │ 12.wav - │ - └─Dog - 1.wav - 2.wav - 3.wav - -.. _modelarts_23_0008__en-us_topic_0170886816_section1171862514918: - -Table ------ - -You can import data from OBS. - -Import description: - -#. The prerequisite for successful import is that the schema of the data source must be the same as that specified during dataset creation. The schema indicates column names and types of a table. Once specified during dataset creation, the values cannot be changed. -#. If the data format is invalid, the data is set to null values. For details, see :ref:`Table 4 `. -#. When a CSV file is imported from OBS, the data type is not verified, but the number of columns must be the same as that in the schema of the dataset. - -- From OBS - - CSV files can be imported from OBS. You need to select the directory where the files are stored. The number of columns in the CSV file must be the same as that in the dataset schema. The schema of the CSV file can be automatically obtained. - - .. code-block:: - - ├─dataset-import-example - │ table_import_1.csv - │ table_import_2.csv - │ table_import_3.csv - │ table_import_4.csv diff --git a/modelarts/umn/result/data_management/importing_data/specifications_for_importing_the_manifest_file.rst b/modelarts/umn/result/data_management/importing_data/specifications_for_importing_the_manifest_file.rst deleted file mode 100644 index d214da03..00000000 --- a/modelarts/umn/result/data_management/importing_data/specifications_for_importing_the_manifest_file.rst +++ /dev/null @@ -1,951 +0,0 @@ -.. _modelarts_23_0009: - -Specifications for Importing the Manifest File -============================================== - -The manifest file defines the mapping between labeling objects and content. The **Manifest file** import mode means that the manifest file is used for dataset import. The manifest file can be imported from OBS. When importing a manifest file from OBS, ensure that the current user has the permissions to access the directory housing the manifest file. - -.. note:: - - There are many requirements on the Manifest file compilation. Import new data from OBS. Generally, Manifest file import is used for data migration of ModelArts in different regions or using different accounts. If you have labeled data in a region using ModelArts, you can obtain the manifest file of the published dataset from the output path. Then you can import the dataset using the manifest file to ModelArts of other regions or accounts. The imported data carries the labeling information and does not need to be labeled again, improving development efficiency. - -The manifest file that contains information about the original file and labeling can be used in labeling, training, and inference scenarios. The manifest file that contains only information about the original file can be used in inference scenarios or used to generate an unlabeled dataset. The manifest file must meet the following requirements: - -- The manifest file uses the UTF-8 encoding format. The **source** value of text classification can contain Chinese characters. However, Chinese characters are not recommended for other parameters. - -- The manifest file uses the JSON Lines format (**jsonlines.org**). A line contains one JSON object. - - .. code-block:: - - {"source": "/path/to/image1.jpg", "annotation": ... } - {"source": "/path/to/image2.jpg", "annotation": ... } - {"source": "/path/to/image3.jpg", "annotation": ... } - - In the preceding example, the manifest file contains multiple lines of JSON object. - -- The manifest file can be generated by users, third-party tools, or ModelArts Data Labeling. The file name can be any valid file name. To facilitate the internal use of the ModelArts system, the file name generated by the ModelArts Data Labeling function consists of the following character strings: *DatasetName*-*VersionName*\ **.manifest**. For example, **animal-v201901231130304123.manifest**. - -.. _modelarts_23_0009__en-us_topic_0170886817_section260132417144: - -Image Classification --------------------- - -+-----------------------------------+--------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | { | -| 2 | "source":"s3://path/to/image1.jpg", | -| 3 | "usage":"TRAIN", | -| 4 | "id":"0162005993f8065ef47eefb59d1e4970", | -| 5 | "annotation": [ | -| 6 | { | -| 7 | "type": "modelarts/image_classification", | -| 8 | "name": "cat", | -| 9 | "property": { | -| 10 | "color":"white", | -| 11 | "kind":"Persian cat" | -| 12 | }, | -| 13 | "annotated-by":"human", | -| 14 | "creation-time":"2019-01-23 11:30:30" | -| 15 | }, | -| 16 | { | -| 17 | "type": "modelarts/image_classification", | -| 18 | "name":"animal", | -| 19 | "annotated-by":"modelarts/active-learning", | -| 20 | "confidence": 0.8, | -| 21 | "creation-time":"2019-01-23 11:30:30" | -| 22 | }], | -| 23 | "inference-loc":"/path/to/inference-output" | -| 24 | } | -+-----------------------------------+--------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_table598984218223: - -.. table:: **Table 1** Parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+================================================================================================================================================================================================================================================+ - | source | Yes | URI of an object to be labeled. For details about data source types and examples, see :ref:`Table 2 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | usage | No | By default, the parameter value is left blank. Possible values are as follows: | - | | | | - | | | - **TRAIN**: The object is used for training. | - | | | - **EVAL**: The object is used for evaluation. | - | | | - **TEST**: The object is used for testing. | - | | | - **INFERENCE**: The object is used for inference. | - | | | | - | | | If the parameter value is left blank, the user decides how to use the object. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | No | Sample ID exported from the system. You do not need to set this parameter when importing the sample. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotation | No | If the parameter value is left blank, the object is not labeled. The value of **annotation** consists of an object list. For details about the parameters, see :ref:`Table 3 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | inference-loc | No | This parameter is available when the file is generated by the inference service, indicating the location of the inference result file. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_table9303122642318: - -.. table:: **Table 2** Data source types - - ======= ============================================ - Type Example - ======= ============================================ - OBS "source":"s3://path-to-jpg" - Content "source":"content://I love machine learning" - ======= ============================================ - -.. _modelarts_23_0009__en-us_topic_0170886817_table48141825192716: - -.. table:: **Table 3** **annotation** objects - - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+================================================================================================================================================================================================================================================================================+ - | type | Yes | Label type. Possible values are as follows: | - | | | | - | | | - **image_classification**: image classification | - | | | - **text_classification**: text classification | - | | | - **text_entity**: named entity recognition | - | | | - **object_detection**: object detection | - | | | - **audio_classification**: sound classification | - | | | - **audio_content**: speech labeling | - | | | - **audio_segmentation**: speech paragraph labeling | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | name | Yes/No | This parameter is mandatory for the classification type but optional for other types. This example uses the image classification type. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | id | Yes/No | Label ID. This parameter is mandatory for triplets but optional for other types. The entity label ID of a triplet is in **E+number** format, for example, **E1** and **E2**. The relationship label ID of a triplet is in **R+number** format, for example, **R1** and **R2**. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | property | No | Labeling property. In this example, the cat has two properties: color and kind. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | annotated-by | No | The default value is **human**, indicating manual labeling. | - | | | | - | | | - human | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | creation-time | No | Time when the labeling job was created. It is the time when labeling information was written, not the time when the manifest file was generated. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | confidence | No | Confidence score of machine labeling. The value ranges from 0 to 1. | - +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_section6459163044216: - -Image Segmentation ------------------- - -.. code-block:: - - { - "annotation": [{ - "annotation-format": "PASCAL VOC", - "type": "modelarts/image_segmentation", - "annotation-loc": "s3://path/to/annotation/image1.xml", - "creation-time": "2020-12-16 21:36:27", - "annotated-by": "human" - }], - "usage": "train", - "source": "s3://path/to/image1.jpg", - "id": "16d196c19bf61994d7deccafa435398c", - "sample-type": 0 - } - -- The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. -- **annotation-loc** indicates the path for saving the label file. This parameter is mandatory for image segmentation and object detection but optional for other labeling types. -- **annotation-format** indicates the format of the label file. This parameter is optional. The default value is **PASCAL VOC**. Only **PASCAL VOC** is supported. -- **sample-type** indicates a sample format. Value **0** indicates image, **1** text, **2** audio, **4** table, and **6** video. - -.. _modelarts_23_0009__en-us_topic_0170886817_table1516151991311: - -.. table:: **Table 4** PASCAL VOC format parameters - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+=========================================================================================================================================================================================+ - | folder | Yes | Directory where the data source is located | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | filename | Yes | Name of the file to be labeled | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Image pixel | - | | | | - | | | - **width**: image width. This parameter is mandatory. | - | | | - **height**: image height. This parameter is mandatory. | - | | | - **depth**: number of image channels. This parameter is mandatory. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | segmented | Yes | Segmented or not | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | mask_source | No | Segmentation mask path | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object | Yes | Object detection information. Multiple **object{}** functions are generated for multiple objects. | - | | | | - | | | - **name**: class of the labeled content. This parameter is mandatory. | - | | | - **pose**: shooting angle of the labeled content. This parameter is mandatory. | - | | | - **truncated**: whether the labeled content is truncated (**0** indicates that the content is not truncated). This parameter is mandatory. | - | | | - **occluded**: whether the labeled content is occluded (**0** indicates that the content is not occluded). This parameter is mandatory. | - | | | - **difficult**: whether the labeled object is difficult to identify (**0** indicates that the object is easy to identify). This parameter is mandatory. | - | | | - **confidence**: confidence score of the labeled object. The value ranges from 0 to 1. This parameter is optional. | - | | | - **bndbox**: bounding box type. This parameter is mandatory. For details about the possible values, see :ref:`Table 5 `. | - | | | - **mask_color**: label color, which is represented by the RGB value. This parameter is mandatory. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_table181711917139: - -.. table:: **Table 5** Bounding box types - - +-----------------------+-----------------------+-----------------------+ - | Type | Shape | Labeling Information | - +=======================+=======================+=======================+ - | polygon | Polygon | Coordinates of points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 250 | - | | | | - | | | 150 | - | | | | - | | | 200 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 50 | - | | | | - | | | 150 | - | | | | - | | | 100 | - | | | | - | | | 100 | - +-----------------------+-----------------------+-----------------------+ - -Example: - -.. code-block:: - - - - NA - image_0006.jpg - - Unknown - - - 230 - 300 - 3 - - 1 - obs://xianao/out/dataset-8153-Jmf5ylLjRmSacj9KevS/annotation/V001/segmentationClassRaw/image_0006.png - - bike - Unspecified - 0 - 0 - 193,243,53 - 0 - - 71 - 48 - 75 - 73 - 49 - 69 - 68 - 92 - 90 - 101 - 45 - 110 - 71 - 48 - - - - -.. _modelarts_23_0009__en-us_topic_0170886817_section8593163192118: - -Text Classification -------------------- - -.. code-block:: - - { - "source": "content://I like this product ", - "id":"XGDVGS", - "annotation": [ - { - "type": "modelarts/text_classification", - "name": " positive", - "annotated-by": "human", - "creation-time": "2019-01-23 11:30:30" - } ] - } - -The **content** parameter indicates the text to be labeled (in UTF-8 encoding format, which can be Chinese). The other parameters are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. - -.. _modelarts_23_0009__en-us_topic_0170886817_section335761812211: - -Named Entity Recognition ------------------------- - -.. code-block:: - - { - "source":"content://Michael Jordan is the most famous basketball player in the world.", - "usage":"TRAIN", - "annotation":[ - { - "type":"modelarts/text_entity", - "name":"Person", - "property":{ - "@modelarts:start_index":0, - "@modelarts:end_index":14 - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }, - { - "type":"modelarts/text_entity", - "name":"Category", - "property":{ - "@modelarts:start_index":34, - "@modelarts:end_index":44 - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - } - ] - } - -The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. - -:ref:`Table 6 ` describes the property parameters. For example, if you want to extract **Michael** from **"source":"content://Michael Jordan"**, the value of **start_index** is **0** and that of **end_index** is **7**. - -.. _modelarts_23_0009__en-us_topic_0170886817_table8486339124912: - -.. table:: **Table 6** Description of **property** parameters - - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------+ - | Parameter | Data Type | Description | - +========================+===========+=============================================================================================================+ - | @modelarts:start_index | Integer | Start position of the text. The value starts from 0, including the characters specified by **start_index**. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the text, excluding the characters specified by **end_index**. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_section29512198: - -Text Triplet ------------- - -.. code-block:: - - { - "source":"content://"Three Body" is a series of long science fiction novels created by Liu Cix.", - "usage":"TRAIN", - "annotation":[ - { - "type":"modelarts/text_entity", - "name":"Person", - "id":"E1", - "property":{ - "@modelarts:start_index":67, - "@modelarts:end_index":74 - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }, - { - "type":"modelarts/text_entity", - "name":"Book", - "id":"E2", - "property":{ - "@modelarts:start_index":0, - "@modelarts:end_index":12 - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }, - { - "type":"modelarts/text_triplet", - "name":"Author", - "id":"R1", - "property":{ - "@modelarts:from":"E1", - "@modelarts:to":"E2" - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }, - { - "type":"modelarts/text_triplet", - "name":"Works", - "id":"R2", - "property":{ - "@modelarts:from":"E2", - "@modelarts:to":"E1" - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - } - ] - } - -The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. - -:ref:`Table 5 property parameters ` describes the **property** parameters. **@modelarts:start_index** and **@modelarts:end_index** are the same as those of named entity recognition. For example, when **source** is set to **content://"Three Body" is a series of long science fiction novels created by Liu Cix.**, **Liu Cix** is an entity person, **Three Body** is an entity book, the person is the author of the book, and the book is works of the person. - -.. _modelarts_23_0009__en-us_topic_0170886817_table134893213914: - -.. table:: **Table 7** Description of **property** parameters - - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Data Type | Description | - +========================+===========+=========================================================================================================================+ - | @modelarts:start_index | Integer | Start position of the triplet entities. The value starts from 0, including the characters specified by **start_index**. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_index | Integer | End position of the triplet entities, excluding the characters specified by **end_index**. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:from | String | Start entity ID of the triplet relationship. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:to | String | Entity ID pointed to in the triplet relationship. | - +------------------------+-----------+-------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_section1571582442114: - -Object Detection ----------------- - -.. code-block:: - - { - "source":"s3://path/to/image1.jpg", - "usage":"TRAIN", - "annotation": [ - { - "type":"modelarts/object_detection", - "annotation-loc": "s3://path/to/annotation1.xml", - "annotation-format":"PASCAL VOC", - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }] - } - -- The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. -- **annotation-loc** indicates the path for saving the label file. This parameter is mandatory for object detection and image segmentation but optional for other labeling types. -- **annotation-format** indicates the format of the label file. This parameter is optional. The default value is **PASCAL VOC**. Only **PASCAL VOC** is supported. - -.. _modelarts_23_0009__en-us_topic_0170886817_table77167388472: - -.. table:: **Table 8** PASCAL VOC format parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | folder | Yes | Directory where the data source is located | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | filename | Yes | Name of the file to be labeled | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Image pixel | - | | | | - | | | - **width**: image width. This parameter is mandatory. | - | | | - **height**: image height. This parameter is mandatory. | - | | | - **depth**: number of image channels. This parameter is mandatory. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | segmented | Yes | Segmented or not | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object | Yes | Object detection information. Multiple **object{}** functions are generated for multiple objects. | - | | | | - | | | - **name**: class of the labeled content. This parameter is mandatory. | - | | | - **pose**: shooting angle of the labeled content. This parameter is mandatory. | - | | | - **truncated**: whether the labeled content is truncated (**0** indicates that the content is not truncated). This parameter is mandatory. | - | | | - **occluded**: whether the labeled content is occluded (**0** indicates that the content is not occluded). This parameter is mandatory. | - | | | - **difficult**: whether the labeled object is difficult to identify (**0** indicates that the object is easy to identify). This parameter is mandatory. | - | | | - **confidence**: confidence score of the labeled object. The value ranges from 0 to 1. This parameter is optional. | - | | | - **bndbox**: bounding box type. This parameter is mandatory. For details about the possible values, see :ref:`Table 9 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_table1770752310500: - -.. table:: **Table 9** Description of bounding box types - - +-----------------------+-----------------------+------------------------------------------------------+ - | Type | Shape | Labeling Information | - +=======================+=======================+======================================================+ - | point | Point | Coordinates of a point | - | | | | - | | | 100 | - | | | | - | | | 100 | - +-----------------------+-----------------------+------------------------------------------------------+ - | line | Line | Coordinates of points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 200 | - +-----------------------+-----------------------+------------------------------------------------------+ - | bndbox | Rectangle | Coordinates of the upper left and lower right points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 200 | - +-----------------------+-----------------------+------------------------------------------------------+ - | polygon | Polygon | Coordinates of points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 250 | - | | | | - | | | 150 | - | | | | - | | | 200 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 50 | - | | | | - | | | 150 | - +-----------------------+-----------------------+------------------------------------------------------+ - | circle | Circle | Center coordinates and radius | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 50 | - +-----------------------+-----------------------+------------------------------------------------------+ - -Example: - -.. code-block:: - - - test_data - 260730932.jpg - - 767 - 959 - 3 - - 0 - - point - Unspecified - 0 - 0 - 0 - - 456 - 596 - - - - line - Unspecified - 0 - 0 - 0 - - 133 - 651 - 229 - 561 - - - - bag - Unspecified - 0 - 0 - 0 - - 108 - 101 - 251 - 238 - - - - boots - Unspecified - 0 - 0 - 0 - - - 373 - 264 - 500 - 198 - 437 - 76 - 310 - 142 - - - - circle - Unspecified - 0 - 0 - 0 - - 405 - 170 - 100 - - - - -.. _modelarts_23_0009__en-us_topic_0170886817_section2373122922115: - -Sound Classification --------------------- - -.. code-block:: - - { - "source": - "s3://path/to/pets.wav", - "annotation": [ - { - "type": "modelarts/audio_classification", - "name":"cat", - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - } - ] - } - -The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. - -.. _modelarts_23_0009__en-us_topic_0170886817_section10586153472113: - -Speech Labeling ---------------- - -.. code-block:: - - { - "source":"s3://path/to/audio1.wav", - "annotation":[ - { - "type":"modelarts/audio_content", - "property":{ - "@modelarts:content":"Today is a good day." - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - } - ] - } - -- The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. -- The **@modelarts:content** parameter in **property** indicates speech labeling. The data type is **String**. - -.. _modelarts_23_0009__en-us_topic_0170886817_section1260563812219: - -Speech Paragraph Labeling -------------------------- - -.. code-block:: - - { - "source":"s3://path/to/audio1.wav", - "usage":"TRAIN", - "annotation":[ - { - - "type":"modelarts/audio_segmentation", - "property":{ - "@modelarts:start_time":"00:01:10.123", - "@modelarts:end_time":"00:01:15.456", - - "@modelarts:source":"Tom", - - "@modelarts:content":"How are you?" - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - }, - { - "type":"modelarts/audio_segmentation", - "property":{ - "@modelarts:start_time":"00:01:22.754", - "@modelarts:end_time":"00:01:24.145", - "@modelarts:source":"Jerry", - "@modelarts:content":"I'm fine, thank you." - }, - "annotated-by":"human", - "creation-time":"2019-01-23 11:30:30" - } - ] - } - -- The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. - -- :ref:`Table 10 ` describes the **property** parameters. - - .. _modelarts_23_0009__en-us_topic_0170886817_table1151144815513: - - .. table:: **Table 10** Description of **property** parameters - - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Data Type | Description | - +=======================+=======================+=============================================================================================================================+ - | @modelarts:start_time | String | Start time of the sound. The format is **hh:mm:ss.SSS**. | - | | | | - | | | **hh** indicates the hour, **mm** indicates the minute, **ss** indicates the second, and **SSS** indicates the millisecond. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:end_time | String | End time of the sound. The format is **hh:mm:ss.SSS**. | - | | | | - | | | **hh** indicates the hour, **mm** indicates the minute, **ss** indicates the second, and **SSS** indicates the millisecond. | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:source | String | Sound source | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - | @modelarts:content | String | Sound content | - +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_section1269454020180: - -Video Labeling --------------- - -.. code-block:: - - { - "annotation": [{ - "annotation-format": "PASCAL VOC", - "type": "modelarts/object_detection", - "annotation-loc": "s3://path/to/annotation1_t1.473722.xml", - "creation-time": "2020-10-09 14:08:24", - "annotated-by": "human" - }], - "usage": "train", - "property": { - "@modelarts:parent_duration": 8, - "@modelarts:parent_source": "s3://path/to/annotation1.mp4", - "@modelarts:time_in_video": 1.473722 - }, - "source": "s3://input/path/to/annotation1_t1.473722.jpg", - "id": "43d88677c1e9a971eeb692a80534b5d5", - "sample-type": 0 - } - -- The parameters such as **source**, **usage**, and **annotation** are the same as those described in :ref:`Image Classification `. For details, see :ref:`Table 1 `. -- **annotation-loc** indicates the path for saving the label file. This parameter is mandatory for object detection but optional for other labeling types. -- **annotation-format** indicates the format of the label file. This parameter is optional. The default value is **PASCAL VOC**. Only **PASCAL VOC** is supported. -- **sample-type** indicates a sample format. Value **0** indicates image, **1** text, **2** audio, **4** table, and **6** video. - -.. table:: **Table 11** **property** parameters - - +----------------------------+-----------+--------------------------------------------------+ - | Parameter | Data Type | Description | - +============================+===========+==================================================+ - | @modelarts:parent_duration | Double | Duration of the labeled video, in seconds | - +----------------------------+-----------+--------------------------------------------------+ - | @modelarts:time_in_video | Double | Timestamp of the labeled video frame, in seconds | - +----------------------------+-----------+--------------------------------------------------+ - | @modelarts:parent_source | String | OBS path of the labeled video | - +----------------------------+-----------+--------------------------------------------------+ - -.. table:: **Table 12** PASCAL VOC format parameters - - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+==========================================================================================================================================================================================+ - | folder | Yes | Directory where the data source is located | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | filename | Yes | Name of the file to be labeled | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Image pixel | - | | | | - | | | - **width**: image width. This parameter is mandatory. | - | | | - **height**: image height. This parameter is mandatory. | - | | | - **depth**: number of image channels. This parameter is mandatory. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | segmented | Yes | Segmented or not | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object | Yes | Object detection information. Multiple **object{}** functions are generated for multiple objects. | - | | | | - | | | - **name**: class of the labeled content. This parameter is mandatory. | - | | | - **pose**: shooting angle of the labeled content. This parameter is mandatory. | - | | | - **truncated**: whether the labeled content is truncated (**0** indicates that the content is not truncated). This parameter is mandatory. | - | | | - **occluded**: whether the labeled content is occluded (**0** indicates that the content is not occluded). This parameter is mandatory. | - | | | - **difficult**: whether the labeled object is difficult to identify (**0** indicates that the object is easy to identify). This parameter is mandatory. | - | | | - **confidence**: confidence score of the labeled object. The value ranges from 0 to 1. This parameter is optional. | - | | | - **bndbox**: bounding box type. This parameter is mandatory. For details about the possible values, see :ref:`Table 13 `. | - +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0009__en-us_topic_0170886817_table869624041814: - -.. table:: **Table 13** Bounding box types - - +-----------------------+-----------------------+------------------------------------------------------+ - | Type | Shape | Labeling Information | - +=======================+=======================+======================================================+ - | point | Point | Coordinates of a point | - | | | | - | | | 100 | - | | | | - | | | 100 | - +-----------------------+-----------------------+------------------------------------------------------+ - | line | Line | Coordinates of points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 200 | - +-----------------------+-----------------------+------------------------------------------------------+ - | bndbox | Rectangle | Coordinates of the upper left and lower right points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 200 | - +-----------------------+-----------------------+------------------------------------------------------+ - | polygon | Polygon | Coordinates of points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 250 | - | | | | - | | | 150 | - | | | | - | | | 200 | - | | | | - | | | 200 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 50 | - | | | | - | | | 150 | - +-----------------------+-----------------------+------------------------------------------------------+ - | circle | Circle | Center coordinates and radius | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 50 | - +-----------------------+-----------------------+------------------------------------------------------+ - -Example: - -.. code-block:: - - - test_data - 260730932_t1.473722.jpg.jpg - - 767 - 959 - 3 - - 0 - - point - Unspecified - 0 - 0 - 0 - - 456 - 596 - - - - line - Unspecified - 0 - 0 - 0 - - 133 - 651 - 229 - 561 - - - - bag - Unspecified - 0 - 0 - 0 - - 108 - 101 - 251 - 238 - - - - boots - Unspecified - 0 - 0 - 0 - - 373 - 264 - 500 - 198 - 437 - 76 - 310 - 142 - - - - circle - Unspecified - 0 - 0 - 0 - - 405 - 170 - 100 - - - diff --git a/modelarts/umn/result/data_management/index.rst b/modelarts/umn/result/data_management/index.rst deleted file mode 100644 index 402ff34f..00000000 --- a/modelarts/umn/result/data_management/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _modelarts_23_0002: - -=============== -Data Management -=============== - -.. toctree:: - :maxdepth: 1 - - introduction_to_data_management - creating_a_dataset - labeling_data/index - importing_data/index - exporting_data - modifying_a_dataset - publishing_a_dataset - deleting_a_dataset - managing_dataset_versions - team_labeling/index diff --git a/modelarts/umn/result/data_management/introduction_to_data_management.rst b/modelarts/umn/result/data_management/introduction_to_data_management.rst deleted file mode 100644 index 380b47bd..00000000 --- a/modelarts/umn/result/data_management/introduction_to_data_management.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _modelarts_23_0003: - -Introduction to Data Management -=============================== - -In ModelArts, you can import and label data on the **Data Management** page to prepare for model building. ModelArts uses datasets as the basis for model development or training. - -.. _modelarts_23_0003__en-us_topic_0171496996_section51771731153811: - -Dataset Types -------------- - -ModelArts supports datasets of images, audio, text, tables, videos, and other types for the following purposes: - -- Images - - - Image classification: identifies a class of objects in images. - - Object detection: identifies the position and class of each object in an image. - - Image segmentation: identifies the outline of each object in an image. - -- Audio - - - Sound classification: classifies and identifies different sounds. - - Speech labeling: labels speech content. - - Speech paragraph labeling: segments and labels speech content. - -- Text - - - Text classification: assigns labels to text according to its content. - - Named entity recognition: assigns labels to named entities in text, such as time and locations. - - Text triplet: assigns labels to entity segments and entity relationships in the text. - -- Tables - - - Table: applies to structured data processing such as tables. The file format can be CSV. You can preview a maximum of 100 records in a table. - -- Videos - - - Video labeling: identifies the position and class of each object in a video. Only the MP4 format is supported. - -- Others - - - Free format: manages data in any format. Labeling is not available for data of the free format type. The free format type is applicable to scenarios where labeling is not required or developers customize labeling. If your dataset needs to contain data in multiple formats or your data format does not meet the requirements of other types of datasets, you can select a dataset in free format. - - .. _modelarts_23_0003__en-us_topic_0171496996_fig594265714140: - - .. figure:: /_static/images/en-us_image_0000001156920919.png - :alt: **Figure 1** Example of a dataset in free format - - - **Figure 1** Example of a dataset in free format - -Dataset Management Process and Functions ----------------------------------------- - -.. table:: **Table 1** Function description - - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Function | Description | - +==========================================================+=============================================================================================================================================================================================+ - | :ref:`Creating a Dataset ` | Create a dataset. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Image Classification ` | Label data based on the types of datasets. Data labeling is not supported for datasets in free format or table format. | - | | | - | :ref:`Object Detection ` | | - | | | - | :ref:`Text Classification ` | | - | | | - | :ref:`Named Entity Recognition ` | | - | | | - | :ref:`Text Triplet ` | | - | | | - | :ref:`Sound Classification ` | | - | | | - | :ref:`Speech Labeling ` | | - | | | - | :ref:`Speech Paragraph Labeling ` | | - | | | - | :ref:`Video Labeling ` | | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Import Operation ` | Import the local manifest file or data stored in OBS to the dataset. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Exporting Data ` | Export part of the data as a new dataset or to OBS. Historical tasks can be viewed and managed. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Modifying a Dataset ` | Modify the basic information about a dataset, such as the dataset name, description, and labels. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Publishing a Dataset ` | Publish the labeled dataset as a new version for model building. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Managing Dataset Versions ` | View data version updates. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Introduction to Team Labeling ` | Allow multiple users to label the same dataset and enable the dataset creator to manage labeling tasks in a unified manner. Add a team and its members to participate in labeling datasets. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Deleting a Dataset ` | Delete a dataset to release resources. | - +----------------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/data_management/labeling_data/image_classification.rst b/modelarts/umn/result/data_management/labeling_data/image_classification.rst deleted file mode 100644 index 26d606c7..00000000 --- a/modelarts/umn/result/data_management/labeling_data/image_classification.rst +++ /dev/null @@ -1,135 +0,0 @@ -.. _modelarts_23_0011: - -Image Classification -==================== - -Model training uses a large number of labeled images. Therefore, before the model training, add labels to the images that are not labeled. You can add labels to images by manual labeling or auto labeling. In addition, you can modify the labels of images, or remove their labels and label the images again. - -Before labeling an image in image classification scenarios, you need to understand the following: - -- You can add multiple labels to an image. -- A label name can contain a maximum of 32 characters, including Chinese characters, letters, digits, hyphens (-), and underscores (_). - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing Data Sources --------------------------- - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -- For an image classification dataset, the .txt file with the same name in the same directory as the data source is used as the label of the target image. -- For an object detection dataset or image segmentation dataset, the .xml file with the same name in the same directory is used as the label of the target image. - -To quickly obtain the latest data in the OBS bucket, on the **All** or **Unlabeled** tab page of the dataset details page, click **Synchronize Data Source** to add data from OBS to the dataset. - -Filtering Data --------------- - -On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed, showing all data in the dataset by default. On the **All**, **Unlabeled**, or **Labeled** tab page, you can add filter criteria in the filter criteria area to quickly filter the data you want to view. - -The following filter criteria are supported. You can set one or more filter criteria. - -- **Label**: Select **All** or one or more labels you specified. -- **Sample Creation Time**: Select **Within 1 month**, **Within 1 day**, or **Custom** to customize a time range. -- **File Name** or **Path**: Filter files by file name or file storage path. -- **Labeled By**: Select the name of the user who performs the labeling operation. - -.. _modelarts_23_0011__en-us_topic_0170889731_section888019266174: - -Labeling Images (Manually) --------------------------- - -The dataset details page displays images on the **All**, **Labeled**, and **Unlabeled** tabs. Images on the **All** tab page are displayed by default. Click an image to preview it. For the images that have been labeled, the label information is displayed at the bottom of the preview page. - -#. On the **Unlabeled** tab page, select the images to be labeled. - - - Manual selection: In the image list, click the selection box in the upper left corner of an image to enter the selection mode, indicating that the image is selected. You can select multiple images of the same type and add labels to them together. - - Batch selection: If all the images on the current page of the image list belong to the same type, you can click **Select Images on Current Page** in the upper right corner to select all the images on the current page. - -#. Add labels to the selected images. - - a. In the label adding area on the right, set the label in the **Label** text box. - - Click the **Label** text box and select an existing label from the drop-down list. If the existing labels cannot meet the requirements, you can go to the page for :ref:`modifying the dataset ` and add labels. - - b. Confirm the **Labels of Selected Image** information and click **OK**. The selected image is automatically moved to the **Labeled** tab page. On the **Unlabeled** and **All** tab pages, the labeling information is updated along with the labeling process, including the added label names and the number of images for each label. - -Viewing Labeled Images ----------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled images. By default, the corresponding labels are displayed under the image thumbnails. You can also select an image and view the label information of the image in the **File Labels** area on the right. - -Modifying Labeling Information ------------------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- **Modifying based on images** - - On the dataset details page, click the **Labeled** tab, and select one or more images to be modified from the image list. Modify the image information in the label information area on the right. - - Modifying a label: In the **File Labels** area, click the edit icon in the **Operation** column, enter the correct label name in the text box, and click the check mark to complete the modification. - - Deleting a label: In the **File Labels** area, click the delete icon in the **Operation** column to delete the label. This operation deletes only the labels added to the selected image. - - .. _modelarts_23_0011__en-us_topic_0170889731_en-us_topic_0170889731_fig171368141175: - - .. figure:: /_static/images/en-us_image_0000001156921011.png - :alt: **Figure 1** Modifying a label - - - **Figure 1** Modifying a label - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Modifying a label: Click the editing icon in the **Operation** column. In the dialog box that is displayed, enter the new label name and click **OK**. After the modification, the images that have been added with the label use the new label name. - - Deleting a label: Click the deletion icon in the **Operation** column. In the displayed dialog box, select **Delete label**, **Delete label and images with only the label (Do not delete source files)**, or **Delete label and images with only the label (Delete source files)**, and click **OK**. - - .. _modelarts_23_0011__en-us_topic_0170889731_en-us_topic_0170889731_fig19495403277: - - .. figure:: /_static/images/en-us_image_0000001157080983.png - :alt: **Figure 2** Information about all labels - - - **Figure 2** Information about all labels - -Adding Images -------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add images on ModelArts for data labeling. - -#. On the dataset details page, click the **All** or **Unlabeled** tab. Then click **Add**. - -#. On the **Add** page that is displayed, click **Add Image**. - - Select one or more images to be uploaded in the local environment. Images in JPG, JPEG, PNG, and BMP formats are supported. The size of a single image cannot exceed 5 MB, and the total size of all images uploaded at a time cannot exceed 8 MB. - - After the images are selected, their thumbnails and sizes are displayed on the **Add** page. - -#. On the **Add** page, click **OK**. - - The images you have added will be automatically displayed in the image list on the **Unlabeled** tab page. In addition, the images are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Images ---------------- - -You can quickly delete the images you want to discard. - -On the **All**, **Unlabeled**, or **Labeled** tab page, select the images to be deleted or click **Select Images on Current Page** to select all images on the page, and click **Delete** in the upper left corner to delete the images. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the images. - -If a tick is displayed in the upper left corner of an image, the image is selected. If no image is selected on the page, the **Delete** button is unavailable. - -.. note:: - - If you select **Delete source files**, images stored in the corresponding OBS directory will be deleted when you delete the selected images. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. diff --git a/modelarts/umn/result/data_management/labeling_data/image_segmentation.rst b/modelarts/umn/result/data_management/labeling_data/image_segmentation.rst deleted file mode 100644 index 683af79f..00000000 --- a/modelarts/umn/result/data_management/labeling_data/image_segmentation.rst +++ /dev/null @@ -1,229 +0,0 @@ -.. _modelarts_23_0345: - -Image Segmentation -================== - -Training a model uses a large number of labeled images. Therefore, label images before the model training. You can label images on the ModelArts management console. Alternatively, modify labels, or delete them and label them again. - -Before labeling an image in image segmentation scenarios, you need to understand the following: - -- All objects whose contours need to be extracted from the image must be labeled. -- Polygons and points can be used for labeling. - - - In polygon labeling, draw a polygon based on the outline of the target object. - - In point labeling, label the top, bottom, leftmost, and rightmost points on the object contour. The system will infer the outline of the object based on the labeled points. For images with complex backgrounds, it is a good practice to use polygons for labeling. - -- When labeling an image, ensure that the polygons or points are within the image. Otherwise, an error will occur in subsequent operations. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing Data Sources --------------------------- - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -- For an image classification dataset, the .txt file with the same name in the same directory as the data source is used as the label of the target image. -- For an object detection dataset or image segmentation dataset, the .xml file with the same name in the same directory is used as the label of the target image. - -To quickly obtain the latest data in the OBS bucket, on the **All** or **Unlabeled** tab page of the dataset details page, click **Synchronize Data Source** to add data from OBS to the dataset. - -Filtering Data --------------- - -On the **Dashboard** tab page of the dataset, the summary of the dataset is displayed by default. In the upper right corner of the page, click **Label**. The dataset details page is displayed, showing all data in the dataset by default. On the **All**, **Unlabeled**, or **Labeled** tab page, you can add filter criteria in the filter criteria area to quickly filter the data you want to view. - -The following filter criteria are supported. You can set one or more filter criteria. - -- **Label**: Select **All** or one or more labels you specified. -- **Sample Creation Time**: Select **Within 1 month**, **Within 1 day**, or **Custom** to customize a time range. -- **File Name** or **Path**: Filter files by file name or file storage path. -- **Labeled By**: Select the name of the user who labeled the image. - -Manually Labeling Images ------------------------- - -The dataset details page provides the **Labeled** and **Unlabeled** tabs. The **All** tab page is displayed by default. - -#. On the **Unlabeled** tab page, click an image. The system automatically directs you to the page for labeling the image. For details about how to use common buttons on this page, see :ref:`Table 2 `. - -#. Select a labeling method. - - On the labeling page, common :ref:`labeling methods ` and :ref:`buttons ` are provided in the toolbar. By default, polygon labeling is selected. Use polygon or point labeling as needed. - - .. note:: - - After you select a method to label the first image, the labeling method automatically applies to subsequent images. - - .. _modelarts_23_0345__en-us_topic_0000001126398947_fig1362531203220: - - .. figure:: /_static/images/en-us_image_0000001110920986.png - :alt: **Figure 1** Toolbar - - - **Figure 1** Toolbar - - .. _modelarts_23_0345__en-us_topic_0000001126398947_table165201739119: - - .. table:: **Table 1** Labeling methods - - +----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Icon | Description | - +==========+================================================================================================================================================================================================================================================================================================================+ - | |image3| | Polygon labeling. In the area where the object to be labeled is located, click to label a point, move the mouse and click multiple points along the edge of the object, and then click the first point again. All the points form a polygon. In this way, the object to be labeled is within the bounding box. | - +----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image4| | Point labeling. Label the top, bottom, leftmost, and rightmost points on the object contour. The system will infer the outline of the object based on the labeled points. | - +----------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_23_0345__en-us_topic_0000001126398947_table194471512463: - - .. table:: **Table 2** Toolbar buttons - - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Icon | Description | - +===========+========================================================================================================================================================+ - | |image14| | Cancel the previous operation. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image15| | Redo the previous operation. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image16| | Zoom in an image. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image17| | Zoom out an image. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image18| | Delete all bounding boxes on the current image. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image19| | Display or hide a bounding box. This operation can be performed only on a labeled image. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image20| | Drag a bounding box to another position or drag the edge of the bounding box to resize it. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image21| | Reset a bounding box. After dragging a bounding box, you can click this button to quickly restore the bounding box to its original shape and position. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image22| | Display the labeled image in full screen. | - +-----------+--------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. Label an object. - - This section uses point labeling as an example. Identify an object in an image. Click to label the top, bottom, leftmost, and rightmost points on the object contour. In the dialog box that is displayed, set the label name and click **Add**. Then, the system automatically infers the object contour. - - After labeling an image, click an image that has not been labeled in the image list below to label the new image. - - .. _modelarts_23_0345__en-us_topic_0000001126398947_fig16575195124518: - - .. figure:: /_static/images/en-us_image_0000001110761086.gif - :alt: **Figure 2** Labeling an object outline - - - **Figure 2** Labeling an object outline - -#. Click **Back to Data Labeling Preview** in the upper left part of the page to view the labeling information. In the dialog box that is displayed, click **OK** to save the labeling settings. - - The selected image is automatically moved to the **Labeled** tab page. On the **Unlabeled** and **All** tab pages, the labeling information is updated along with the labeling process, including the added label names and the number of images for each label. - -Viewing Labeled Images ----------------------- - -On the dataset details page, click the **Labeled** tab to view the list of labeled images. Click an image to view its labeling information in the **File Labels** area on the right. - -Modifying a Label ------------------ - -After labeling an object, you can modify labeled data on the **Labeled** tab page. - -On the dataset details page, click the **Labeled** tab and then the image to be modified. On the labeling page that is displayed, modify the labeling information in the **File Labels** area on the right. - -- Modifying a label: In the **Labeling** area, click the edit icon, set the target label name or color in the displayed dialog box, and click the save icon to save the modification. Alternatively, click a label to be modified. In the image labeling area, adjust the position and size of the bounding box. After the adjustment is complete, click another label to save the modification. -- Modifying image labeling information: In the area for displaying images, click the target bounding box. Then, blue points on the bounding box are displayed. Drag a blue point and adjust the bounding box to the edge of the object. -- Deleting a label: In the **Labeling** area, click the deletion icon to delete a label from the image. After all labels of an image are deleted, the image is displayed on the **Unlabeled** tab page. - -After the labeling information is modified, click **Back to Data Labeling Preview** in the upper left part of the page to exit the labeling page. In the dialog box that is displayed, click **OK** to save the modification. - -.. _modelarts_23_0345__en-us_topic_0000001126398947_en-us_topic_0170889732_fig16709173213107: - -.. figure:: /_static/images/en-us_image_0000001156920955.gif - :alt: **Figure 3** Editing image labeling information - - - **Figure 3** Editing image labeling information - -Adding Images -------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add images on ModelArts for data labeling. - -#. On the dataset details page, click the **All** or **Unlabeled** tab. Then click **Add**. - -#. On the **Add** page that is displayed, click **Add Image**. - - Select one or more images to be uploaded in the local environment. Images in JPG, JPEG, PNG, and BMP formats are supported. The size of a single image cannot exceed 5 MB, and the total size of all images uploaded at a time cannot exceed 8 MB. - - After the images are selected, their thumbnails and sizes are displayed on the **Add** page. - -#. On the **Add** page, click **OK**. - - The images you have added will be automatically displayed in the image list on the **Unlabeled** tab page. In addition, the images are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Images ---------------- - -You can quickly delete the images you want to discard. - -On the **All**, **Unlabeled**, or **Labeled** tab page, select the images to be deleted or click **Select Images on Current Page** to select all images on the page, and click **Delete** in the upper left corner to delete the images. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the images. - -If a tick is displayed in the upper left corner of an image, the image is selected. If no image is selected on the page, the **Delete** button is unavailable. - -.. note:: - - If you select **Delete source files**, images stored in the corresponding OBS directory will be deleted when you delete the selected images. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001110920998.png - -.. |image2| image:: /_static/images/en-us_image_0000001156920965.png - -.. |image3| image:: /_static/images/en-us_image_0000001110920998.png - -.. |image4| image:: /_static/images/en-us_image_0000001156920965.png - -.. |image5| image:: /_static/images/en-us_image_0000001110761078.png - -.. |image6| image:: /_static/images/en-us_image_0000001110761088.png - -.. |image7| image:: /_static/images/en-us_image_0000001110920974.png - -.. |image8| image:: /_static/images/en-us_image_0000001110920976.png - -.. |image9| image:: /_static/images/en-us_image_0000001157080931.png - -.. |image10| image:: /_static/images/en-us_image_0000001156920961.png - -.. |image11| image:: /_static/images/en-us_image_0000001110761074.png - -.. |image12| image:: /_static/images/en-us_image_0000001156920967.png - -.. |image13| image:: /_static/images/en-us_image_0000001156920951.png - -.. |image14| image:: /_static/images/en-us_image_0000001110761078.png - -.. |image15| image:: /_static/images/en-us_image_0000001110761088.png - -.. |image16| image:: /_static/images/en-us_image_0000001110920974.png - -.. |image17| image:: /_static/images/en-us_image_0000001110920976.png - -.. |image18| image:: /_static/images/en-us_image_0000001157080931.png - -.. |image19| image:: /_static/images/en-us_image_0000001156920961.png - -.. |image20| image:: /_static/images/en-us_image_0000001110761074.png - -.. |image21| image:: /_static/images/en-us_image_0000001156920967.png - -.. |image22| image:: /_static/images/en-us_image_0000001156920951.png - diff --git a/modelarts/umn/result/data_management/labeling_data/index.rst b/modelarts/umn/result/data_management/labeling_data/index.rst deleted file mode 100644 index 53e52979..00000000 --- a/modelarts/umn/result/data_management/labeling_data/index.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _modelarts_23_0010: - -============= -Labeling Data -============= - -.. toctree:: - :maxdepth: 1 - - image_classification - object_detection - image_segmentation - text_classification - named_entity_recognition - text_triplet - sound_classification - speech_labeling - speech_paragraph_labeling - video_labeling diff --git a/modelarts/umn/result/data_management/labeling_data/named_entity_recognition.rst b/modelarts/umn/result/data_management/labeling_data/named_entity_recognition.rst deleted file mode 100644 index 2e9ae355..00000000 --- a/modelarts/umn/result/data_management/labeling_data/named_entity_recognition.rst +++ /dev/null @@ -1,106 +0,0 @@ -.. _modelarts_23_0014: - -Named Entity Recognition -======================== - -Named entity recognition assigns labels to named entities in text, such as time and locations. Before labeling, you need to understand the following: - -- A label name can contain a maximum of 32 characters, including Chinese characters, letters, digits, hyphens (-), and underscores (_). - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -.. _modelarts_23_0014__en-us_topic_0170889734_section888019266174: - -Labeling Content ----------------- - -The dataset details page displays the labeled and unlabeled text files in the dataset. The **Unlabeled** tab page is displayed by default. - -#. On the **Unlabeled** tab page, the objects to be labeled are listed in the left pane. In the list, click the text object to be labeled, select a part of text displayed under **Label Set** for labeling, and select a label in the **Label Set** area in the right pane. Multiple labels can be added to a labeling object. - - You can repeat this operation to select objects and add labels to the objects. - -#. Click **Save Current Page** in the lower part of the page to complete the labeling. - -Adding Labels -------------- - -- Adding labels on the **Unlabeled** tab page: Click the plus sign (+) next to **Label Set**. On the **Add Label** page that is displayed, add a label name, select a label color, and click **OK**. - - .. _modelarts_23_0014__en-us_topic_0170889734_fig162371842293: - - .. figure:: /_static/images/en-us_image_0000001156921015.png - :alt: **Figure 1** Adding a named entity label (1) - - - **Figure 1** Adding a named entity label (1) - -- Adding labels on the **Labeled** tab page: Click the plus sign (+) next to **All Labels**. On the **Add Label** page that is displayed, add a label name, select a label color, and click **OK**. - - .. _modelarts_23_0014__en-us_topic_0170889734_fig1418544013104: - - .. figure:: /_static/images/en-us_image_0000001156921017.png - :alt: **Figure 2** Adding a named entity label (2) - - - **Figure 2** Adding a named entity label (2) - -Viewing the Labeled Text ------------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled text. You can also view all labels supported by the dataset in the **All Labels** area on the right. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -On the dataset details page, click the **Labeled** tab, and modify the text information in the label information area on the right. - -- **Modifying based on texts** - - On the dataset details page, click the **Labeled** tab, and select the text to be modified from the text list. - - Manual deletion: In the text list, click the text. When the text background turns blue, the text is selected. On the right of the page, click |image1| above a text label to delete the label. - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Batch modification: In the **All Labels** area, click the editing icon in the **Operation** column, add a label name in the text box, select a label color, and click **OK**. - - Batch deletion: In the **All Labels** area, click the deletion icon in the **Operation** column to delete the label. In the dialog box that is displayed, select **Delete label** or **Delete label and objects with only the label**, and click **OK**. - -Adding Files ------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add text files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add File**. - -#. In the displayed **Add File** dialog box, set the parameters as required and then select the file to be uploaded. - - Select one or more files to be uploaded in the local environment. Only **.txt** and **.csv** files are supported. The total size of files uploaded at a time cannot exceed 8 MB. - -#. In the **Add File** dialog box, click **Upload**. The files you add will be automatically displayed on the **Unlabeled** tab page. - -Deleting a File ---------------- - -You can quickly delete the files you want to discard. - -- On the **Unlabeled** tab page, select the text to be deleted, and click **Delete** in the upper left corner to delete the text. -- On the **Labeled** tab page, select the text to be deleted and click **Delete**. Alternatively, you can tick **Select Images on Current Page** to select all text objects on the current page and click **Delete** in the upper left corner. - -The background of the selected text is blue. - -.. |image1| image:: /_static/images/en-us_image_0000001110761148.png - diff --git a/modelarts/umn/result/data_management/labeling_data/object_detection.rst b/modelarts/umn/result/data_management/labeling_data/object_detection.rst deleted file mode 100644 index 253e9e6b..00000000 --- a/modelarts/umn/result/data_management/labeling_data/object_detection.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _modelarts_23_0012: - -Object Detection -================ - -Model training uses a large number of labeled images. Therefore, before the model training, add labels to the images that are not labeled. You can add labels to images by manual labeling or auto labeling. In addition, you can modify the labels of images, or remove their labels and label the images again. - -Before labeling an image in object detection scenarios, pay attention to the following: - -- All target objects in the image must be labeled. -- Target objects are clear without any blocking and contained within bounding boxes. -- Only the entire object must be contained within a bounding box. The edge of the bounding box cannot intersect the edge outline of the target object. Additionally, there must not be a gap between the edge and the target object to prevent the background from interfering with the model training. - -Labeling the Dataset --------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, click the dataset to be labeled based on the labeling type. The **Dashboard** tab page of the dataset is displayed. - - By default, the **Dashboard** tab page of the current dataset version is displayed. To label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing Data Sources --------------------------- - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -- For an image classification dataset, the .txt file with the same name in the same directory as the data source is used as the label of the target image. -- For an object detection dataset or image segmentation dataset, the .xml file with the same name in the same directory is used as the label of the target image. - -To quickly obtain the latest data in the OBS bucket, on the **All** or **Unlabeled** tab page of the dataset details page, click **Synchronize Data Source**. - -Filtering Data --------------- - -On the **Dashboard** tab page of the dataset, the summary of the dataset is displayed by default. In the upper left corner of the page, click **Label**. The dataset details page is displayed, showing all data in the dataset by default. On the **All**, **Unlabeled**, or **Labeled** tab page, you can add filter criteria in the filter criteria area to quickly filter the data you want to view. - -The following filter criteria are supported. You can set one or more filter criteria. - -- **Label**: Select **All** or one or more labels you specified. -- **Sample Creation Time**: Select **Within 1 month**, **Within 1 day**, or **Custom** to customize a time range. -- **File Name** or **Path**: Filter files by file name or file storage path. -- **Labeled By**: Select the name of the user who performs the labeling operation. - -.. _modelarts_23_0012__en-us_topic_0170889732_section888019266174: - -Labeling Images (Manually) --------------------------- - -The dataset details page provides the **Labeled** and **Unlabeled** tabs. The **All** tab page is displayed by default. - -#. On the **Unlabeled** tab page, click an image. The image labeling page is displayed. For details about how to use common buttons on the **Labeled** tab page, see :ref:`Table 2 `. - -#. In the left tool bar, select a proper labeling shape. The default labeling shape is a rectangle. In this example, the rectangle is used for labeling. - - .. note:: - - On the left of the page, multiple tools are provided for you to label images. However, you can use only one tool at a time. - - .. _modelarts_23_0012__en-us_topic_0170889732_table165201739119: - - .. table:: **Table 1** Supported bounding box - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Icon | Description | - +===========+=================================================================================================================================================================================================================================================================================================+ - | |image7| | Rectangle. Click the edge of the upper left corner of the object to be labeled. A rectangle will be displayed. Drag the rectangle to cover the object and click to label the object. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image8| | Polygon. In the area where the object to be labeled is located, click to label a point, move the mouse and click multiple points along the edge of the object, and then click the first point again. All the points form a polygon. Therefore, the object to be labeled is in the bounding box. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image9| | Circle. Click the center point of an object, and move the mouse to draw a circle to cover the object and click to label the object. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image10| | Straight line. Click to specify the start and end points of an object, and move the mouse to draw a straight line to cover the object and click to label the object. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image11| | Dotted line. Click to specify the start and end points of an object, and move the mouse to draw a dotted line to cover the object and click to label the object. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | |image12| | Point. Click the object in an image to label a point. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. In the **Add Label** text box, enter a new label name, select the label color, and click **Add**. Alternatively, select an existing label from the drop-down list. - - Label all objects in an image. Multiple labels can be added to an image. After labeling an image, you can click the image list below the image to quickly select other images that are not labeled and label them on the labeling page. - -#. Click **Back to Data Labeling Preview** in the upper left part of the page to view the labeling information. In the dialog box that is displayed, click **OK** to save the labeling settings. - - The selected image is automatically moved to the **Labeled** tab page. On the **Unlabeled** and **All** tab pages, the labeling information is updated along with the labeling process, including the added label names and the number of images for each label. - -.. _modelarts_23_0012__en-us_topic_0170889732_table194471512463: - -.. table:: **Table 2** Common icons on the labeling page - - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | Icon | Description | - +===========+=========================================================================================================================================+ - | |image22| | Cancel the previous operation. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image23| | Redo the previous operation. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image24| | Zoom in an image. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image25| | Zoom out an image. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image26| | Delete all bounding boxes on the current image. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image27| | Display or hide a bounding box. You can perform this operation only on a labeled image. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image28| | Drag a bounding box to another position or drag the edge of the bounding box to resize it. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image29| | Reset. After dragging a bounding box, you can click this button to quickly restore the bounding box to its original shape and position. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - | |image30| | Display the labeled image in full screen. | - +-----------+-----------------------------------------------------------------------------------------------------------------------------------------+ - -Viewing Labeled Images ----------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled images. You can click an image to view the label information about the image in the **All Labels** area on the right. - -Modifying Labeling Information ------------------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- **Modifying based on images** - - On the dataset details page, click the **Labeled** tab, click the image to be modified. The labeling page is displayed. Modify the image information in the label information area on the right. - - - Modifying a label: In the **Labeling** area, click the edit icon, enter the correct label name in the text box, and click the check mark to complete the modification. Alternatively, click a label. In the image labeling area, adjust the position and size of the bounding box. After the adjustment is complete, click another label to save the modification. - - - Deleting a label: In the **Labeling** area, click the deletion icon to delete a label from the image. - - After deleting the label, click **Back to Data Labeling Preview** in the upper left corner of the page to exit the labeling page. In the dialog box that is displayed, save the modification. After all labels of an image are deleted, the image is displayed on the **Unlabeled** tab page. - - .. _modelarts_23_0012__en-us_topic_0170889732_en-us_topic_0170889732_fig16709173213107: - - .. figure:: /_static/images/en-us_image_0000001157080933.png - :alt: **Figure 1** Editing an object detection label - - - **Figure 1** Editing an object detection label - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Modifying a label: Click the edit icon in the **Operation** column. In the dialog box that is displayed, enter the new label name, select the new label color, and click **OK**. After the modification, the images that have been added with the label use the new label name. - - Deleting a label: Click the deletion icon in the **Operation** column to delete a label. - - .. _modelarts_23_0012__en-us_topic_0170889732_en-us_topic_0170889732_fig19495403277: - - .. figure:: /_static/images/en-us_image_0000001157080935.png - :alt: **Figure 2** All labels for object detection - - - **Figure 2** All labels for object detection - -Adding Images -------------- - -In addition to the data automatically synchronized from **Input Dataset Path**, you can directly add images on ModelArts for labeling. - -#. On the dataset details page, click the **All** or **Unlabeled** tab. Then, click **Add**. - -#. On the **Add** page that is displayed, click **Add Image**. - - Select one or more images to be uploaded in the local environment. Images in JPG, JPEG, PNG, or BMP formats are supported. The size of a single image cannot exceed 5 MB, and the total size of all images uploaded at a time cannot exceed 8 MB. - - After the images are selected, their thumbnails and total size are displayed on the **Add** page. - -#. On the **Add** page, click **OK**. - - The images you have added will be automatically displayed in the image list on the **Unlabeled** tab page. In addition, the images are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Images ---------------- - -You can quickly delete the images you want to discard. - -On the **All**, **Unlabeled**, or **Labeled** tab page, select the images to be deleted or click **Select Images on Current Page**, and click **Delete** in the upper left corner to delete them. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the images. - -If a tick is displayed in the upper left corner of an image, the image is selected. If no image is selected on the page, the **Delete** button is unavailable. - -.. note:: - - If you select **Delete source files**, images stored in the OBS directory will be deleted accordingly. This operation may affect other dataset versions or datasets using those files, for example, leading to an error in page display, training, or inference. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001156920971.png - -.. |image2| image:: /_static/images/en-us_image_0000001156920969.png - -.. |image3| image:: /_static/images/en-us_image_0000001157080923.png - -.. |image4| image:: /_static/images/en-us_image_0000001110761098.png - -.. |image5| image:: /_static/images/en-us_image_0000001110920992.png - -.. |image6| image:: /_static/images/en-us_image_0000001110920994.png - -.. |image7| image:: /_static/images/en-us_image_0000001156920971.png - -.. |image8| image:: /_static/images/en-us_image_0000001156920969.png - -.. |image9| image:: /_static/images/en-us_image_0000001157080923.png - -.. |image10| image:: /_static/images/en-us_image_0000001110761098.png - -.. |image11| image:: /_static/images/en-us_image_0000001110920992.png - -.. |image12| image:: /_static/images/en-us_image_0000001110920994.png - -.. |image13| image:: /_static/images/en-us_image_0000001110920996.png - -.. |image14| image:: /_static/images/en-us_image_0000001110920984.png - -.. |image15| image:: /_static/images/en-us_image_0000001110761082.png - -.. |image16| image:: /_static/images/en-us_image_0000001110920982.png - -.. |image17| image:: /_static/images/en-us_image_0000001156920959.png - -.. |image18| image:: /_static/images/en-us_image_0000001110921000.png - -.. |image19| image:: /_static/images/en-us_image_0000001110761080.png - -.. |image20| image:: /_static/images/en-us_image_0000001110921004.png - -.. |image21| image:: /_static/images/en-us_image_0000001110920978.png - -.. |image22| image:: /_static/images/en-us_image_0000001110920996.png - -.. |image23| image:: /_static/images/en-us_image_0000001110920984.png - -.. |image24| image:: /_static/images/en-us_image_0000001110761082.png - -.. |image25| image:: /_static/images/en-us_image_0000001110920982.png - -.. |image26| image:: /_static/images/en-us_image_0000001156920959.png - -.. |image27| image:: /_static/images/en-us_image_0000001110921000.png - -.. |image28| image:: /_static/images/en-us_image_0000001110761080.png - -.. |image29| image:: /_static/images/en-us_image_0000001110921004.png - -.. |image30| image:: /_static/images/en-us_image_0000001110920978.png - diff --git a/modelarts/umn/result/data_management/labeling_data/sound_classification.rst b/modelarts/umn/result/data_management/labeling_data/sound_classification.rst deleted file mode 100644 index bb2efe6a..00000000 --- a/modelarts/umn/result/data_management/labeling_data/sound_classification.rst +++ /dev/null @@ -1,113 +0,0 @@ -.. _modelarts_23_0015: - -Sound Classification -==================== - -Model training requires a large amount of labeled data. Therefore, before the model training, label the unlabeled audio files. ModelArts enables you to label audio files in batches by one click. In addition, you can modify the labels of audio files, or remove their labels and label the audio files again. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing the Data Source ------------------------------ - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -To quickly obtain the latest data in the OBS bucket, click **Synchronize Data Source** on the **Unlabeled** tab page of the dataset details page to add the data uploaded using OBS to the dataset. - -Labeling Audio Files --------------------- - -The dataset details page displays the labeled and unlabeled audio files. The **Unlabeled** tab page is displayed by default. Click |image1| on the left of the audio to preview the audio. - -#. On the **Unlabeled** tab page, select the audio files to be labeled. - - - Manual selection: In the audio list, click the target audio. If the blue check box is displayed in the upper right corner, the audio is selected. You can select multiple audio files of the same type and label them together. - - Batch selection: If all audio files of the current page belong to one type, you can click **Select Images on Current Page** in the upper right corner of the list to select all the audio files on the page. - -#. Add labels. - - a. In the right pane, set a label name in the **Label** text box. - - Method 1 (the required label already exists): In the right pane, select a shortcut from the **Shortcut** drop-down list, select an existing label name from the **Label** text box, and click **OK**. - - Method 2 (adding a label): In the right pane, select a shortcut from the **Shortcut** drop-down list, and enter a new label name in the **Label** text box. - - b. The selected audio files are automatically moved to the **Labeled** tab page. On the **Unlabeled** tab page, the labeling information is updated along with the labeling process, including the added label names and the number of audio files corresponding to each label. - - .. note:: - - **Shortcut key description**: After specifying a shortcut key for a label, you can select an audio file and press the shortcut key to add a label for the audio file. Example: Specify **1** as the shortcut key for the **aa** label. Select one or more files and press **1** during data labeling. A message is displayed, asking you whether to label the files with **aa**. Click **OK**. - - Each label has a shortcut key. A shortcut key cannot be specified for different labels. Shortcut keys can greatly improve the labeling efficiency. - -Viewing the Labeled Audio Files -------------------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled audio files. Click an audio file. You can view the label information about the audio file in the **File Labels** area on the right. - -Modifying Labels ----------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- **Modifying based on audio** - - On the data labeling page, click the **Labeled** tab. Select one or more audio files to be modified from the audio list. Modify the label in the label details area on the right. - - - Modifying a label: In the **File Labels** area, click the edit icon in the **Operation** column, enter the correct label name in the text box, and click the check mark to complete the modification. - - Deleting a label: In the **File Labels** area, click the delete icon in the **Operation** column to delete the label. - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - .. _modelarts_23_0015__en-us_topic_0170889735_fig19495403277: - - .. figure:: /_static/images/en-us_image_0000001110761044.png - :alt: **Figure 1** Information about all labels - - - **Figure 1** Information about all labels - - - Modifying a label: Click the editing icon in the **Operation** column. In the dialog box that is displayed, enter the new label name and click **OK**. After the modification, the new label applies to the audio files that contain the original label. - - Deleting a label: Click the deletion icon in the **Operation** column. In the displayed dialog box, select the object to be deleted as prompted and click **OK**. - -Adding Audio Files ------------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add audio files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add Audio** in the upper left corner. - -#. In the **Add Audio** dialog box that is displayed, click **Add Audio**. - - Select the audio files to be uploaded in the local environment. Only WAV audio files are supported. The size of an audio file cannot exceed 4 MB. The total size of audio files uploaded at a time cannot exceed 8 MB. - -#. In the **Add Audio** dialog box, click **OK**. - - The audio files you add will be automatically displayed on the **Unlabeled** tab page. In addition, the audio files are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Audio Files --------------------- - -You can quickly delete the audio files you want to discard. - -On the **Unlabeled** or **Labeled** tab page, select the audio files to be deleted one by one or tick **Select Images on Current Page** to select all audio files on the page, and then click **Delete File** in the upper left corner. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the audio files. - -If a tick is displayed in the upper right corner of an audio file, the audio file is selected. If no audio file is selected on the page, the **Delete File** button is unavailable. - -.. note:: - - If you select **Delete source files**, audio files stored in the corresponding OBS directory will be deleted when you delete the selected audio files. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001157080893.png - diff --git a/modelarts/umn/result/data_management/labeling_data/speech_labeling.rst b/modelarts/umn/result/data_management/labeling_data/speech_labeling.rst deleted file mode 100644 index 3b6b8c1e..00000000 --- a/modelarts/umn/result/data_management/labeling_data/speech_labeling.rst +++ /dev/null @@ -1,84 +0,0 @@ -.. _modelarts_23_0016: - -Speech Labeling -=============== - -Model training requires a large amount of labeled data. Therefore, before the model training, label the unlabeled audio files. ModelArts enables you to label audio files in batches by one click. In addition, you can modify the labels of audio files, or remove their labels and label the audio files again. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing the Data Source ------------------------------ - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -To quickly obtain the latest data in the OBS bucket, click **Synchronize Data Source** on the **Unlabeled** tab page of the dataset details page to add the data uploaded using OBS to the dataset. - -Labeling Audio Files --------------------- - -The dataset details page displays the labeled and unlabeled audio files. The **Unlabeled** tab page is displayed by default. - -#. In the audio file list on the **Unlabeled** tab page, click the target audio file. In the area on the right, the audio file is displayed. Click |image1| below the audio file to play the audio. - -#. In **Speech Content**, enter the speech content. - -#. After entering the content, click **OK** to complete the labeling. The audio file is automatically moved to the **Labeled** tab page. - - .. _modelarts_23_0016__en-us_topic_0170889736_fig1525911501178: - - .. figure:: /_static/images/en-us_image_0000001110920914.png - :alt: **Figure 1** Labeling an audio file - - - **Figure 1** Labeling an audio file - -Viewing the Labeled Audio Files -------------------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled audio files. Click the audio file to view the audio content in the **Speech Content** text box on the right. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -On the data labeling page, click the **Labeled** tab, and select the audio file to be modified from the audio file list. In the label information area on the right, modify the content of the **Speech Content** text box, and click **OK** to complete the modification. - -Adding Audio Files ------------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add audio files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add Audio** in the upper left corner. - -#. In the **Add Audio** dialog box that is displayed, click **Add Audio**. - - Select the audio files to be uploaded in the local environment. Only WAV audio files are supported. The size of an audio file cannot exceed 4 MB. The total size of audio files uploaded at a time cannot exceed 8 MB. - -#. In the **Add Audio** dialog box, click **OK**. - - The audio files you add will be automatically displayed on the **Unlabeled** tab page. In addition, the audio files are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Audio Files --------------------- - -You can quickly delete the audio files you want to discard. - -On the **Unlabeled** or **Labeled** tab page, select the audio files to be deleted, and then click **Delete File** in the upper left corner. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the audio files. - -.. note:: - - If you select **Delete source files**, audio files stored in the corresponding OBS directory will be deleted when you delete the selected audio files. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001110761012.png - diff --git a/modelarts/umn/result/data_management/labeling_data/speech_paragraph_labeling.rst b/modelarts/umn/result/data_management/labeling_data/speech_paragraph_labeling.rst deleted file mode 100644 index 3f7d05e2..00000000 --- a/modelarts/umn/result/data_management/labeling_data/speech_paragraph_labeling.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. _modelarts_23_0017: - -Speech Paragraph Labeling -========================= - -Model training requires a large amount of labeled data. Therefore, before the model training, label the unlabeled audio files. ModelArts enables you to label audio files. In addition, you can modify the labels of audio files, or remove their labels and label the audio files again. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing the Data Source ------------------------------ - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -To quickly obtain the latest data in the OBS bucket, click **Synchronize Data Source** on the **Unlabeled** tab page of the dataset details page to add the data uploaded using OBS to the dataset. - -Labeling Audio Files --------------------- - -The dataset details page displays the labeled and unlabeled audio files. The **Unlabeled** tab page is displayed by default. - -#. In the audio file list on the **Unlabeled** tab page, click the target audio file. In the area on the right, the audio file is displayed. Click |image1| below the audio file to play the audio. - -#. Select an audio segment based on the content being played, and enter the audio file label and content in the **Speech Content** text box. - - .. _modelarts_23_0017__en-us_topic_0170889737_fig116336410274: - - .. figure:: /_static/images/en-us_image_0000001157080965.png - :alt: **Figure 1** Labeling an audio file - - - **Figure 1** Labeling an audio file - -#. After entering the content, click **OK** to complete the labeling. The audio file is automatically moved to the **Labeled** tab page. - -Viewing the Labeled Audio Files -------------------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled audio files. Click the audio file to view the audio content in the **Speech Content** text box on the right. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- Modifying a label: On the dataset details page, click the **Labeled** tab, and select the audio file to be modified from the audio file list. In the **Speech Content** area, modify **Label** and **Content**, and click **OK** to complete the modification. -- Deleting a label: Click |image2| in the **Operation** column of the target number to delete the label of the audio segment. Alternatively, you can click the cross (x) icon above the labeled audio file to delete the label. Then click **OK**. - -Adding Audio Files ------------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add audio files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add Audio** in the upper left corner. - -#. In the **Add Audio** dialog box that is displayed, click **Add Audio**. - - Select the audio files to be uploaded in the local environment. Only WAV audio files are supported. The size of an audio file cannot exceed 4 MB. The total size of audio files uploaded at a time cannot exceed 8 MB. - -#. In the **Add Audio** dialog box, click **OK**. - - The audio files you add will be automatically displayed on the **Unlabeled** tab page. In addition, the audio files are automatically saved to the OBS directory specified by **Input Dataset Path**. - -Deleting Audio Files --------------------- - -You can quickly delete the audio files you want to discard. - -On the **Unlabeled** or **Labeled** tab page, select the audio files to be deleted, and then click **Delete File** in the upper left corner. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the audio files. - -.. note:: - - If you select **Delete source files**, audio files stored in the corresponding OBS directory will be deleted when you delete the selected audio files. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001110761012.png - -.. |image2| image:: /_static/images/en-us_image_0000001156920989.png - diff --git a/modelarts/umn/result/data_management/labeling_data/text_classification.rst b/modelarts/umn/result/data_management/labeling_data/text_classification.rst deleted file mode 100644 index 70aabfbc..00000000 --- a/modelarts/umn/result/data_management/labeling_data/text_classification.rst +++ /dev/null @@ -1,119 +0,0 @@ -.. _modelarts_23_0013: - -Text Classification -=================== - -Model training requires a large amount of labeled data. Therefore, before the model training, add labels to the files that are not labeled. In addition, you can modify, delete, and re-label the labeled text. - -Text classification classifies text content based on labels. Before labeling text content, you need to understand the following: - -- Text labeling supports multiple labels. That is, you can add multiple labels to a labeling object. -- A label name can contain a maximum of 32 characters, including Chinese characters, letters, digits, hyphens (-), and underscores (_). - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -.. _modelarts_23_0013__en-us_topic_0170889733_section888019266174: - -Labeling Content ----------------- - -The dataset details page displays the labeled and unlabeled text files in the dataset. The **Unlabeled** tab page is displayed by default. - -#. On the **Unlabeled** tab page, the objects to be labeled are listed in the left pane. In the list, click the text object to be labeled, and select a label in the **Label Set** area in the right pane. Multiple labels can be added to a labeling object. - - You can repeat this operation to select objects and add labels to the objects. - - .. _modelarts_23_0013__en-us_topic_0170889733_fig127381972311: - - .. figure:: /_static/images/en-us_image_0000001110760906.png - :alt: **Figure 1** Labeling for text classification - - - **Figure 1** Labeling for text classification - -#. After all objects are labeled, click **Save Current Page** at the bottom of the page to complete labeling text files on the **Unlabeled** tab page. - -Adding Labels -------------- - -- Adding labels on the **Unlabeled** tab page: Click the plus sign (+) next to **Label Set**. On the **Add Label** page that is displayed, add a label name, select a label color, and click **OK**. - - .. _modelarts_23_0013__en-us_topic_0170889733_fig162371842293: - - .. figure:: /_static/images/en-us_image_0000001157080759.png - :alt: **Figure 2** Adding a label (1) - - - **Figure 2** Adding a label (1) - -- Adding labels on the **Labeled** tab page: Click the plus sign (+) next to **All Labels**. On the **Add Label** page that is displayed, add a label name, select a label color, and click **OK**. - - .. _modelarts_23_0013__en-us_topic_0170889733_fig1418544013104: - - .. figure:: /_static/images/en-us_image_0000001110760912.png - :alt: **Figure 3** Adding a label (2) - - - **Figure 3** Adding a label (2) - -Viewing the Labeled Text ------------------------- - -On the dataset details page, click the **Labeled** tab to view the list of the labeled text. You can also view all labels supported by the dataset in the **All Labels** area on the right. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- **Modifying based on texts** - - On the dataset details page, click the **Labeled** tab, and select the text to be modified from the text list. - - In the text list, click the text. When the text background turns blue, the text is selected. If a text file has multiple labels, you can click |image1| above a label to delete the label. - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Batch modification: In the **All Labels** area, click the editing icon in the **Operation** column, modify the label name in the text box, select a label color, and click **OK**. - - Batch deletion: In the **All Labels** area, click the deletion icon in the **Operation** column to delete the label. In the dialog box that is displayed, select **Delete label** or **Delete label and objects with only the label**, and click **OK**. - -Adding Files ------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add text files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add File**. - -#. In the displayed **Add File** dialog box, set the parameters as required and then select the file to be uploaded. - - Select one or more files to be uploaded in the local environment. Only **.txt** and **.csv** files are supported. The total size of files uploaded at a time cannot exceed 8 MB. **Text and Label Separator** and **Label Separator** must be different. - - - **Pattern**: Select **Merge text objects and labels** or **Separate text objects and labels**. An example is provided. Determine the mode of the file to be added by referring to the example. - - **Text and Label Separator**: Select **Tab**, **Space**, **Semicolon**, **Comma**, or **Other**. If you select **Other**, enter a separator in the text box on the right. - - **Label Separator**: Select **Tab**, **Space**, **Semicolon**, **Comma**, or **Other**. If you select **Other**, enter a separator in the text box on the right. - -#. In the **Add File** dialog box, click **Upload**. The files you add will be automatically displayed on the **Unlabeled** or **Labeled** tab page. - -Deleting a File ---------------- - -You can quickly delete the files you want to discard. - -- On the **Unlabeled** tab page, select the text to be deleted, and click **Delete** in the upper left corner to delete the text. -- On the **Labeled** tab page, select the text to be deleted and click **Delete**. Alternatively, you can tick **Select Images on Current Page** to select all text objects on the current page and click **Delete** in the upper left corner. - -The background of the selected text is blue. - -.. |image1| image:: /_static/images/en-us_image_0000001110760908.png - diff --git a/modelarts/umn/result/data_management/labeling_data/text_triplet.rst b/modelarts/umn/result/data_management/labeling_data/text_triplet.rst deleted file mode 100644 index f364e4bd..00000000 --- a/modelarts/umn/result/data_management/labeling_data/text_triplet.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _modelarts_23_0211: - -Text Triplet -============ - -Triplet labeling is suitable for scenarios where structured information, such as subjects, predicates, and objects, needs to be labeled in statements. With this function, not only entities in statements, but also relationships between entities can be labeled. Triplet labeling is often used in natural language processing tasks such as dependency syntax analysis and information extraction. - -Text triplet labeling involves two classes of important labels: **Entity Label** and **Relationship Label**. For the **Relationship Label**, you need to set its **Source entity** and **Target entity**. - -- You can define multiple entity and relationship labels for a text object. -- The **Entity Label** defined during dataset creation cannot be deleted. - -Precautions ------------ - -Before labeling, ensure that the **Entity Label** and **Relationship Label** of a dataset have been defined. For the **Relationship Label**, you need to set its **Source entity** and **Target entity**. The **Relationship Label** must be between the defined **Source entity** and **Target entity**. - -For example, if two entities are labeled as **Place**, you cannot add any relationship label between them. If a relationship label cannot be added, a red cross is displayed. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -.. _modelarts_23_0211__en-us_topic_0209128667_section888019266174: - -Labeling Content ----------------- - -The dataset details page displays the labeled and unlabeled text objects in the dataset. The **Unlabeled** tab page is displayed by default. - -#. On the **Unlabeled** tab page, the objects to be labeled are listed in the left pane. In the list, click a text object, select the corresponding text content on the right pane, and select an entity name from the displayed entity list to label the content. - - .. _modelarts_23_0211__en-us_topic_0209128667_fig127381972311: - - .. figure:: /_static/images/en-us_image_0000001110760968.png - :alt: **Figure 1** Labeling an entity - - - **Figure 1** Labeling an entity - -#. After labeling multiple entities, click the source entity and target entity in sequence and select a relationship type from the displayed relationship list to label the relationship. - - .. _modelarts_23_0211__en-us_topic_0209128667_fig16874184518477: - - .. figure:: /_static/images/en-us_image_0000001110920874.png - :alt: **Figure 2** Labeling a relationship - - - **Figure 2** Labeling a relationship - -#. After all objects are labeled, click **Save Current Page** at the bottom of the page. - -.. note:: - - You cannot modify the labels of a dataset in the text triplet type on the labeling page. Instead, click **Edit** to enter the **Modify Dataset** page and modify the **Entity Label** and **Relationship Label**. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -On the dataset details page, click the **Labeled** tab. Select a text object in the left pane and the right pane displays the detailed label information. You can move your cursor to the entity or relationship label, and right-click to delete it. You can also click the source entity and target entity in sequence to add a relationship label. - -You can click **Delete Labels on Current Item** at the bottom of the page to delete all labels in the selected text object. - -Adding a File -------------- - -In addition to automatically synchronizing data from **Input Dataset Path**, you can directly add text files on ModelArts for data labeling. - -#. On the dataset details page, click the **Unlabeled** tab. Then click **Add File**. - -#. In the **Add File** dialog box that is displayed, select the files to be uploaded. - - Select one or more files to be uploaded in the local environment. Only **.txt** and **.csv** files are supported. The total size of files uploaded at a time cannot exceed 8 MB. - -#. In the **Add File** dialog box, click **Upload**. The files you add will be automatically displayed in the **Labeling Objects** list on the **Unlabeled** tab page. - -Deleting a File ---------------- - -You can quickly delete the files you want to discard. - -- On the **Unlabeled** tab page, select the text to be deleted, and click **Delete** in the upper left corner to delete the text. -- On the **Labeled** tab page, select the text to be deleted and click **Delete**. Alternatively, you can tick **Select Images on Current Page** to select all text objects on the current page and click **Delete** in the upper left corner. - -The background of the selected text is blue. If no text is selected on the page, the **Delete** button is unavailable. diff --git a/modelarts/umn/result/data_management/labeling_data/video_labeling.rst b/modelarts/umn/result/data_management/labeling_data/video_labeling.rst deleted file mode 100644 index 679766a3..00000000 --- a/modelarts/umn/result/data_management/labeling_data/video_labeling.rst +++ /dev/null @@ -1,97 +0,0 @@ -.. _modelarts_23_0282: - -Video Labeling -============== - -Model training requires a large amount of labeled video data. Therefore, before the model training, label the unlabeled video files. ModelArts enables you to label video files. In addition, you can modify the labels of video files, or remove their labels and label the video files again. - -Starting Labeling ------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, select the dataset to be labeled based on the labeling type, and click the dataset name to go to the **Dashboard** tab page of the dataset. - - By default, the **Dashboard** tab page of the current dataset version is displayed. If you need to label the dataset of another version, click the **Versions** tab and then click **Set to Current Version** in the right pane. For details, see :ref:`Managing Dataset Versions `. - -#. On the **Dashboard** page of the dataset, click **Label** in the upper right corner. The dataset details page is displayed. By default, all data of the dataset is displayed on the dataset details page. - -Synchronizing Data Sources --------------------------- - -ModelArts automatically synchronizes data and labeling information from **Input Dataset Path** to the dataset details page. - -To quickly obtain the latest data in the OBS bucket, click **Synchronize Data Source** on the **Unlabeled** tab page of the dataset details page to add the data uploaded using OBS to the dataset. - -Labeling Video Files --------------------- - -On the dataset details page, both unlabeled and labeled video files in the dataset are displayed. - -#. On the **Unlabeled** tab page, click the target video file in the video list on the left. The labeling page is displayed. - -#. Play the video. When the video is played to the time point to be labeled, click the pause button in the progress bar to pause the video to a specific image. - -#. .. _modelarts_23_0282__en-us_topic_0257844727_li993163014399: - - In the left pane, select a bounding box. By default, a rectangular box is selected. Drag the mouse to select an object in the video image, enter a new label name in the displayed **Add Label** text box, select a label color, and click **Add** to label the object. Alternatively, select an existing label from the drop-down list and click **Add** to label the object. Label all objects in the image. Multiple labels can be added to an image. - - The supported bounding boxes are the same as those supported by Object Detection. For details, see :ref:`Table 1 ` in :ref:`Object Detection `. - - .. _modelarts_23_0282__en-us_topic_0257844727_fig87011122454: - - .. figure:: /_static/images/en-us_image_0000001110761112.png - :alt: **Figure 1** Labeling video files - - - **Figure 1** Labeling video files - -#. After the previous image is labeled, click the play button on the progress bar to resume the playback. Then, repeat :ref:`3 ` to complete labeling on the entire video. - - The labeled time points of the current video are displayed on the right of the page. - - .. _modelarts_23_0282__en-us_topic_0257844727_fig629913537509: - - .. figure:: /_static/images/en-us_image_0000001156920985.png - :alt: **Figure 2** File labels - - - **Figure 2** File labels - -#. Click **Back to Data Labeling Preview** in the upper left corner of the page. The dataset details page is displayed, and the labeled video file is displayed on the **Labeled** tab page. - -Modifying Labeled Data ----------------------- - -After labeling data, you can delete labeled data on the **Labeled** tab page. - -- Click |image1| in the **Operation** column of the target number to delete the label of the video segment. Alternatively, you can click the cross (x) icon above the labeled video file to delete the label. Then click **OK**. - -On the **Labeled** tab page, click the target video file. In the **All Labels** area on the right of the labeling page, click the triangle icon on the right of the time point to view details. You can modify or delete a label. - -- Modifying a label: Click the edit icon on the right of a label to modify the label name. -- Deleting a label: Click the delete icon on the right of a label to delete the label. If you click the delete icon on the right of the image time, all labels on the image are deleted. - -.. _modelarts_23_0282__en-us_topic_0257844727_fig338933705619: - -.. figure:: /_static/images/en-us_image_0000001156920983.png - :alt: **Figure 3** Modifying labeled data - - - **Figure 3** Modifying labeled data - -Deleting a Video File ---------------------- - -You can quickly delete the video files you want to discard. - -On the **All**, **Unlabeled**, or **Labeled** tab page, select the video files to be deleted or click **Select Images on Current Page** to select all video files on the page, and click **Delete** in the upper left corner to delete the video files. In the displayed dialog box, select or deselect **Delete source files** as required. After confirmation, click **OK** to delete the videos. - -If a tick is displayed in the upper left corner of a video file, the video file is selected. If no video file is selected on the page, the **Delete File** button is unavailable. - -.. note:: - - If you select **Delete source files**, video files stored in the corresponding OBS directory will be deleted when you delete the selected video files. Deleting source files may affect other dataset versions or datasets using those files. As a result, the page display, training, or inference is abnormal. Deleted data cannot be recovered. Exercise caution when performing this operation. - -.. |image1| image:: /_static/images/en-us_image_0000001110921012.png - diff --git a/modelarts/umn/result/data_management/managing_dataset_versions.rst b/modelarts/umn/result/data_management/managing_dataset_versions.rst deleted file mode 100644 index 8c6b236a..00000000 --- a/modelarts/umn/result/data_management/managing_dataset_versions.rst +++ /dev/null @@ -1,39 +0,0 @@ -.. _modelarts_23_0019: - -Managing Dataset Versions -========================= - -After labeling data, you can publish the dataset to multiple versions for management. For the published versions, you can view the dataset version updates, set the current version, and delete versions. For details about dataset versions, see :ref:`About Dataset Versions `. - -For details about how to publish a new version, see :ref:`Publishing a Dataset `. - -Viewing Dataset Version Updates -------------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, choose **More > Manage Version** in the **Operation** column. The **Manage Version** tab page is displayed. - - You can view basic information about the dataset, and view the versions and publish time on the left. - -Setting to Current Version --------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. -#. In the dataset list, choose **More > Manage Version** in the **Operation** column. The **Manage Version** tab page is displayed. -#. On the **Manage Version** tab page, select the desired dataset version, and click **Set to Current Version** in the basic information area on the right. After the setting is complete, **Current version** is displayed to the right of the version name. - - .. note:: - - Only the version in **Normal** status can be set to the current version. - -Deleting a Dataset Version --------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. -#. In the dataset list, choose **More > Manage Version** in the **Operation** column. The **Manage Version** tab page is displayed. -#. Locate the row that contains the target version, and click **Delete** in the **Operation** column. In the dialog box that is displayed, click **OK**. - - .. note:: - - Deleting a dataset version does not remove the original data. Data and its labeling information are still stored in the OBS directory. However, if it is deleted, you cannot manage the dataset versions on the ModelArts management console. Exercise caution when performing this operation. diff --git a/modelarts/umn/result/data_management/modifying_a_dataset.rst b/modelarts/umn/result/data_management/modifying_a_dataset.rst deleted file mode 100644 index 05f24dd2..00000000 --- a/modelarts/umn/result/data_management/modifying_a_dataset.rst +++ /dev/null @@ -1,36 +0,0 @@ -.. _modelarts_23_0020: - -Modifying a Dataset -=================== - -For a created dataset, you can modify its basic information to match service changes. - -Prerequisites -------------- - -You have created a dataset. - -Modifying the Basic Information About a Dataset ------------------------------------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, choose **More > Modify** in the **Operation** column. - - Alternatively, you can click the dataset name to go to the **Dashboard** tab page of the dataset, and click **Modify** in the upper right corner. - -#. Modify basic information about the dataset and then click **OK**. Refer to :ref:`Table 1 ` for details. - - .. _modelarts_23_0020__en-us_topic_0170886811_table151481125214: - - .. table:: **Table 1** Parameters - - +-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=============+====================================================================================================================================================================================================+ - | Name | Enter the name of the dataset. A dataset name can contain only letters, digits, underscores (_), and hyphens (-). | - +-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Enter a brief description for the dataset. | - +-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set | The label set varies depending on the dataset type. For details about how to modify the label set, see the parameters of different dataset types in :ref:`Creating a Dataset `. | - +-------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/data_management/publishing_a_dataset.rst b/modelarts/umn/result/data_management/publishing_a_dataset.rst deleted file mode 100644 index e7cf0d69..00000000 --- a/modelarts/umn/result/data_management/publishing_a_dataset.rst +++ /dev/null @@ -1,89 +0,0 @@ -.. _modelarts_23_0018: - -Publishing a Dataset -==================== - -ModelArts distinguishes data of the same source according to versions labeled at different time, which facilitates the selection of dataset versions during subsequent model building and development. After labeling the data, you can publish the dataset to generate a new dataset version. - -.. _modelarts_23_0018__en-us_topic_0170886812_section38541340654: - -About Dataset Versions ----------------------- - -- For a newly created dataset (before publishing), there is no dataset version information. The dataset must be published before being used for model development or training. -- The default naming rules of dataset versions are V001 and V002 in ascending order. You can customize the version number during publishing. -- You can set any version to the current directory. Then the details of the version are displayed on the dataset details page. -- You can obtain the dataset in the manifest file format corresponding to each dataset version based on the value of **Storage Path**. The dataset can be used when you import data or filter hard examples. -- The version of a table dataset cannot be changed. - -.. _publishing-a-dataset-1: - -Publishing a Dataset --------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. The **Datasets** page is displayed. - -#. In the dataset list, click **Publish** in the **Operation** column. - - Alternatively, you can click the dataset name to go to the **Dashboard** tab page of the dataset, and click **Publish** in the upper right corner. - -#. In the displayed dialog box, set the parameters and click **OK**. - - .. table:: **Table 1** Parameters for publishing a dataset - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==================================================================================================================================================================================================================================================+ - | Version Name | The naming rules of V001 and V002 in ascending order are used by default. A version name can be customized. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Format | Only table datasets support version format setting. Available values are **CSV** and **CarbonData**. | - | | | - | | .. note:: | - | | | - | | If the exported CSV file contains any command starting with =, +, -, or @, ModelArts automatically adds the Tab setting and escapes the double quotation marks (") for security purposes. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Splitting | Only image classification, object detection, text classification, and sound classification datasets support data splitting. | - | | | - | | By default, this function is disabled. After this function is enabled, you need to set the training and validation ratios. | - | | | - | | Enter a value ranging from 0 to 1 for **Training Set Ratio**. After the training set ratio is set, the validation set ratio is determined. The sum of the training set ratio and the validation set ratio is 1. | - | | | - | | The training set ratio is the ratio of sample data used for model training. The validation set ratio is the ratio of the sample data used for model validation. The training and validation ratios affect the performance of training templates. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Description of the current dataset version. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - After the version is published, you can go to the **Version Manager** tab page to view the detailed information. By default, the system sets the latest version to the current directory. - -Directory Structure of Related Files After the Dataset Is Published -------------------------------------------------------------------- - -Datasets are managed based on OBS directories. After a new version is published, the directory is generated based on the new version in the output dataset path. - -Take an image classification dataset as an example. After the dataset is published, the directory structure of related files generated in OBS is as follows: - -.. code-block:: - - |-- user-specified-output-path - |-- DatasetName-datasetId - |-- annotation - |-- VersionMame1 - |-- VersionMame1.manifest - |-- VersionMame2 - ... - |-- ... - -The following uses object detection as an example. If a manifest file is imported to the dataset, the following provides the directory structure of related files after the dataset is published: - -.. code-block:: - - |-- user-specified-output-path - |-- DatasetName-datasetId - |-- annotation - |-- VersionMame1 - |-- VersionMame1.manifest - |-- annotation - |-- file1.xml - |-- VersionMame2 - ... - |-- ... diff --git a/modelarts/umn/result/data_management/team_labeling/index.rst b/modelarts/umn/result/data_management/team_labeling/index.rst deleted file mode 100644 index 6c2d85f9..00000000 --- a/modelarts/umn/result/data_management/team_labeling/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0180: - -============= -Team Labeling -============= - -.. toctree:: - :maxdepth: 1 - - introduction_to_team_labeling - team_management - member_management - managing_team_labeling_tasks diff --git a/modelarts/umn/result/data_management/team_labeling/introduction_to_team_labeling.rst b/modelarts/umn/result/data_management/team_labeling/introduction_to_team_labeling.rst deleted file mode 100644 index 1603e871..00000000 --- a/modelarts/umn/result/data_management/team_labeling/introduction_to_team_labeling.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _modelarts_23_0181: - -Introduction to Team Labeling -============================= - -Generally, a small data labeling task can be completed by an individual. However, team work is required to label a large dataset. ModelArts provides the team labeling function. A labeling team can be formed to manage labeling for the same dataset. - -.. note:: - - The team labeling function supports only datasets for image classification, object detection, text classification, named entity recognition, text triplet, and speech paragraph labeling. - -How to Enable Team Labeling ---------------------------- - -- When creating a dataset, enable **Team Labeling** and select a team or task manager. - - .. _modelarts_23_0181__en-us_topic_0186456616_fig19662182219716: - - .. figure:: /_static/images/en-us_image_0000001157080899.png - :alt: **Figure 1** Enabling during dataset creation - - - **Figure 1** Enabling during dataset creation - -- If team labeling is not enabled for a dataset that has been created, create a team labeling task to enable team labeling. For details about how to create a team labeling task, see :ref:`Creating Team Labeling Tasks `. - - .. _modelarts_23_0181__en-us_topic_0186456616_fig1943110322817: - - .. figure:: /_static/images/en-us_image_0000001156921451.png - :alt: **Figure 2** Creating a team labeling task in a dataset list - - - **Figure 2** Creating a team labeling task in a dataset list - - .. _modelarts_23_0181__en-us_topic_0186456616_fig183348421489: - - .. figure:: /_static/images/en-us_image_0000001110761582.png - :alt: **Figure 3** Creating a team labeling task - - - **Figure 3** Creating a team labeling task - - .. _modelarts_23_0181__en-us_topic_0186456616_fig1542082785810: - - .. figure:: /_static/images/en-us_image_0000001110761054.png - :alt: **Figure 4** Creating a team labeling task on the dataset details page - - - **Figure 4** Creating a team labeling task on the dataset details page - -Operations Related to Team Labeling ------------------------------------ - -- :ref:`Team Management ` -- :ref:`Member Management ` -- :ref:`Managing Team Labeling Tasks ` diff --git a/modelarts/umn/result/data_management/team_labeling/managing_team_labeling_tasks.rst b/modelarts/umn/result/data_management/team_labeling/managing_team_labeling_tasks.rst deleted file mode 100644 index 03ddff45..00000000 --- a/modelarts/umn/result/data_management/team_labeling/managing_team_labeling_tasks.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _modelarts_23_0210: - -Managing Team Labeling Tasks -============================ - -For datasets with team labeling enabled, you can create team labeling tasks and assign the labeling tasks to different teams so that team members can complete the labeling tasks together. During data labeling, members can initiate acceptance, continue acceptance, and view acceptance reports. - -.. _modelarts_23_0210__en-us_topic_0209053802_section72262410214: - -Creating Team Labeling Tasks ----------------------------- - -If you enable team labeling when creating a dataset and assign a team to label the dataset, the system creates a labeling task based on the team by default. After the dataset is created, you can view the labeling task on the **Labeling Progress** tab page of the dataset. - -You can also create a team marking task and assign it to different members in the same team or to other labeling teams. - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Data Management** > **Datasets**. A dataset list is displayed. -#. In the dataset list, select a dataset that supports team labeling, and click the dataset name to go to the **Dashboard** tab page of the dataset. -#. Click the **Labeling Progress** tab to view existing labeling tasks of the dataset. Click **Create Team Labeling Task** in the upper right corner to create a task. -#. In the displayed **Create Team Labeling Task** dialog box, set related parameters and click **OK**. - - - **Name**: Enter a task name. - - - **Type**: Select a task type, **Team** or **Task Manager**. - - - **Select Team**: If **Type** is set to **Team**, you need to select a team and members for labeling. The **Select Team** drop-down list lists the labeling teams and members created by the current account. For details about team management, see :ref:`Introduction to Team Labeling `. - - - **Select Task Manager**: If **Type** is set to **Task Manager**, you need to select one **Team Manager** member from all teams as the task manager. - - - **Label Set**: All existing labels and label attributes of the dataset are displayed. You can also select **Automatically synchronize new images to the team labeling task** or **Automatically load the intelligent labeling results to images that need to be labeled** under **Label Set**. - - The process of loading auto labeling results to a team labeling task is as follows: - - - If you set **Type** to **Team**, you are required to create a team labeling task before executing the task. - - If you set **Type** to **Task Manager**, you are required to log in to the data labeling console and assign a labeling task before executing the task. - - After the task is created, you can view the new task on the **Labeling Progress** tab page. - -Labeling (Team Member) ----------------------- - -After a labeling task is created, the team member to which the task is assigned receives a labeling notification email. - -In the email details, click the labeling task link and use your email address and initial password to log in to the labeling platform. After login, change the password. After logging in to the labeling platform, you can view the assigned labeling task and click the task name to go to the labeling page. The labeling method varies depending on the dataset type. For details, see the following: - -- :ref:`Image Classification ` -- :ref:`Object Detection ` -- :ref:`Text Classification ` -- :ref:`Named Entity Recognition ` -- :ref:`Text Triplet ` - -On the labeling platform, each member can view the images that are not labeled, to be corrected, rejected, to be reviewed, approved, and accepted. Pay attention to the images rejected by the administrator and the images to be corrected. - -If the Reviewer role is assigned for a team labeling task, the labeling result needs to be reviewed. After the labeling result is reviewed, it is submitted to the administrator for acceptance. - -.. _modelarts_23_0210__en-us_topic_0209053802_fig13465256141515: - -.. figure:: /_static/images/en-us_image_0000001110760934.png - :alt: **Figure 1** Labeling platform - - - **Figure 1** Labeling platform - -Task Acceptance (Administrator) -------------------------------- - -- **Initiating acceptance** - - After team members complete data labeling, the dataset creator can initiate acceptance to check labeling results. The acceptance can be initiated only when a labeling member has labeled data. Otherwise, the acceptance initiation button is unavailable. - - #. On the **Labeling Progress** tab page, click **Initiate Acceptance** to accept tasks. - - #. In the displayed dialog box, set **Sample Policy** to **By percentage** or **By quantity**. Click **OK** to start the acceptance. - - **By percentage**: Sampling is performed based on a percentage for acceptance. - - **By quantity**: Sampling is performed based on quantity for acceptance. - - #. After the acceptance is initiated, an acceptance report is displayed on the console in real time. In the **Acceptance Result** area on the right, select **Pass** or **Reject**. - - If you select **Pass**, set **Rating** to **A**, **B**, **C**, or **D**. Option **A** indicates the highest score. If you select **Reject**, enter your rejection reasons in the text box. - -- **Continuing acceptance** - - You can continue accepting tasks whose acceptance is not completed. For tasks for which an acceptance process is not initiated, the **Continue Acceptance** button is unavailable. - - On the **Labeling Progress** tab page, click **Continue Acceptance** to continue accepting tasks. The **Real-Time Acceptance Report** page is displayed. You can continue to accept the images that are not accepted. - -- **Finishing acceptance** - - In the acceptance completion window, you can view dataset acceptance details, such as the number of sample files, set the following parameters, and perform acceptance. The labeling information is synchronized to the **Labeled** tab page of the dataset only after the acceptance is complete. - - Once the labeled data is accepted, team members cannot modify the labeling information. Only the dataset creator can modify the labeling information. - - .. table:: **Table 1** Parameters for finishing acceptance - - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=====================================================================================================================================================================================================================+ - | Modifying Labeled Data | - **Not overwrite**: For the same data, do not overwrite the existing data with the labeling result of the current team. | - | | - **Overlays**: For the same data, overwrite the existing data with the labeling result of the current team. Overwritten data cannot be recovered. Exercise caution when performing this operation. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Acceptance Scope | - All: all data that has been labeled by the current team, including **Accepted**, **Pending Acceptance**, and **Rejected** data. It refers to all sample files in the dataset. | - | | | - | | - All rejects: rejects all data that has been labeled by the current team. That is, all labeled data is rejected to the labeling personnel. | - | | | - | | - Accepted and pending acceptance: accepts the data that passes the acceptance or is in the Pending Acceptance state in the sample files and rejects the data that fails the acceptance to the labeling personnel. | - | | | - | | - Accepted: accepts the data that has passed the acceptance in the sample files and rejects the data that is in the Pending Acceptance state or fails the acceptance to the labeling personnel. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Viewing an Acceptance Report ----------------------------- - -You can view the acceptance report of an ongoing or finished labeling task. On the **Labeling Progress** tab page, click **Acceptance Report**. In the displayed **Acceptance Report** dialog box, view report details. - -Deleting a Labeling Task ------------------------- - -On the **Labeling Progress** tab page, click **Delete** in the row where a labeling task to be deleted. After a task is deleted, the labeling details that are not accepted will be lost. Exercise caution when performing this operation. However, the original data in the dataset and the labeled data that has been accepted are still stored in the corresponding OBS bucket. diff --git a/modelarts/umn/result/data_management/team_labeling/member_management.rst b/modelarts/umn/result/data_management/team_labeling/member_management.rst deleted file mode 100644 index fb717d9d..00000000 --- a/modelarts/umn/result/data_management/team_labeling/member_management.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _modelarts_23_0183: - -Member Management -================= - -There is no member in a new team. You need to add members who will participate in a team labeling task. - -A maximum of 100 members can be added to a team. If there are more than 100 members, add them to different teams for better management. - -.. _modelarts_23_0183__en-us_topic_0186456618_section060323818470: - -Adding a Member ---------------- - -#. In the left navigation pane of the ModelArts management console, choose **Data Management > Labeling Teams**. The **Labeling Teams** page is displayed. - -#. On the **Labeling Teams** page, select a team from the team list on the left and click a team name. The team details are displayed in the right pane. - -#. In the **Team Details** area, click **Add Member**. - -#. In the displayed **Add Member** dialog box, enter an email address, description, and a role for a member and click **OK**. - - An email address uniquely identifies a team member. Different members cannot use the same email address. The email address you enter will be recorded and saved in ModelArts. It is used only for ModelArts team labeling. After a member is deleted, the email address will also be deleted. - - Possible values of **Role** are **Labeler**, **Reviewer**, and **Team Manager**. Only one **Team Manager** can be set. - - .. _modelarts_23_0183__en-us_topic_0186456618_fig2095294217492: - - .. figure:: /_static/images/en-us_image_0000001156920939.png - :alt: **Figure 1** Adding a member - - - **Figure 1** Adding a member - - .. _modelarts_23_0183__en-us_topic_0186456618_fig2953352181118: - - .. figure:: /_static/images/en-us_image_0000001157081267.png - :alt: **Figure 2** Adding a member - - - **Figure 2** Adding a member - - Information about the added member is displayed in the **Team Details** area. - -Modifying Member Information ----------------------------- - -You can modify member information if it is changed. - -#. In the **Team Details** area, select the desired member. - -#. In the row containing the desired member, click **Modify** in the **Operation** column. In the displayed dialog box, modify the description or role. - - The email address of a member cannot be changed. To change the email address of a member, delete the member, and set a new email address when adding a member. - - Possible values of **Role** are **Labeler**, **Reviewer**, and **Team Manager**. Only one **Team Manager** can be set. - -Deleting Members ----------------- - -- **Deleting a single member** - - In the **Team Details** area, select the desired member, and click **Delete** in the **Operation** column. In the dialog box that is displayed, click **OK**. - -- **Batch Deletion** - - In the **Team Details** area, select members to be deleted and click **Delete**. In the dialog box that is displayed, click **OK**. diff --git a/modelarts/umn/result/data_management/team_labeling/team_management.rst b/modelarts/umn/result/data_management/team_labeling/team_management.rst deleted file mode 100644 index f19a255f..00000000 --- a/modelarts/umn/result/data_management/team_labeling/team_management.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _modelarts_23_0182: - -Team Management -=============== - -Team labeling is managed in a unit of teams. To enable team labeling for a dataset, a team must be specified. Multiple members can be added to a team. - -Background ----------- - -- An account can have a maximum of 10 teams. -- An account must have at least one team to enable team labeling for datasets. If the account has no team, add a team by referring to :ref:`Adding a Team `. - -.. _modelarts_23_0182__en-us_topic_0186456617_section165361815383: - -Adding a Team -------------- - -#. In the left navigation pane of the ModelArts management console, choose **Data Management > Labeling Teams**. The **Labeling Teams** page is displayed. - -#. On the **Labeling Teams** page, click **Add Team**. - -#. In the displayed **Add Team** dialog box, enter a team name and description and click **OK**. The labeling team is added. - - The new team is displayed on the **Labeling Teams** page. You can view team details in the right pane. There is no member in the new team. Add members to the new team by referring to :ref:`Adding a Member `. - -Deleting a Team ---------------- - -You can delete a team that is no longer used. - -On the **Labeling Teams** page, select the target team and click **Delete**. In the dialog box that is displayed, click **OK**. diff --git a/modelarts/umn/result/devenviron_notebook/index.rst b/modelarts/umn/result/devenviron_notebook/index.rst deleted file mode 100644 index ceb75d78..00000000 --- a/modelarts/umn/result/devenviron_notebook/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0032: - -===================== -DevEnviron (Notebook) -===================== - -.. toctree:: - :maxdepth: 1 - - introduction_to_notebook - managing_notebook_instances/index - using_jupyter_notebook/index - using_jupyterlab/index diff --git a/modelarts/umn/result/devenviron_notebook/introduction_to_notebook.rst b/modelarts/umn/result/devenviron_notebook/introduction_to_notebook.rst deleted file mode 100644 index 10103372..00000000 --- a/modelarts/umn/result/devenviron_notebook/introduction_to_notebook.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. _modelarts_23_0033: - -Introduction to Notebook -======================== - -ModelArts integrates the open-source Jupyter Notebook and JupyterLab to provide you with online interactive development and debugging environments. You can use the Notebook on the ModelArts management console to compile and debug code and train models based on the code, without concerning installation and configurations. - -- Jupyter Notebook is an interactive notebook. For details about how to perform operations on Jupyter Notebook, see `Jupyter Notebook Documentation `__. -- JupyterLab is an interactive development environment. It is a next-generation product of Jupyter Notebook. JupyterLab enables you to compile notebooks, operate terminals, edit MarkDown text, open interaction modes, and view CSV files and images. For details about how to perform operations on JupyterLab, see `JupyterLab Documentation `__. - -.. _modelarts_23_0033__en-us_topic_0162690357_section191109611479: - -Supported AI Engines --------------------- - -Each development environment supports multiple AI engines that run independently. All supported AI engines can be used in the same notebook instance, and these engines can be switched quickly and conveniently. - -.. note:: - - - Each ModelArts notebook instance can use all supported engines. - -.. table:: **Table 1** AI engines - - +------------------------------------------+--------------------------------+----------------+ - | Work Environment | Built-in AI Engine and Version | Supported Chip | - +==========================================+================================+================+ - | Multi-Engine 1.0 (Python 3, Recommended) | MXNet-1.2.1 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | PySpark-2.3.2 | CPU | - +------------------------------------------+--------------------------------+----------------+ - | | Pytorch-1.0.0 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-1.13.1 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | XGBoost-Sklearn | CPU | - +------------------------------------------+--------------------------------+----------------+ - | Multi-Engine 2.0 (Python3) | Pytorch-1.4.0 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-2.1.0 | CPU/GPU | - +------------------------------------------+--------------------------------+----------------+ - | Ascend-Powered-Engine 1.0 (Python3) | MindSpore-1.1.1 | Ascend 910 | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-1.15.0 | Ascend 910 | - +------------------------------------------+--------------------------------+----------------+ - -Constraints ------------ - -- For security purposes, the root permission is not granted to the notebook instances integrated in ModelArts. You can use the non-privileged user **jovyan** or **ma-user** (using **Multi-Engine**) to perform operations. Therefore, you cannot use **apt-get** to install the OS software. -- Notebook instances support only standalone training under the current AI engine framework. If you need to use distributed training, use ModelArts training jobs and specify multiple nodes in the resource pool. -- ModelArts DevEnviron does not support apt-get. You can use a :ref:`custom image ` to train a model. -- Notebook instances do not support GUI-related libraries, such as PyQt. -- Notebook instances created using Ascend specifications cannot be attached to EVS disks. -- Notebook instances cannot be connected to DWS and database services. -- Notebook instances cannot directly read files in OBS. You need to download the files to the local host. To access data in OBS, use Moxing or SDK for interaction. -- DevEnviron does not support TensorBoard. Use the visualization job function under **Training Jobs**. -- After a notebook instance is created, you cannot modify its specifications. For example, you cannot change the CPU specifications to GPU specifications or change the work environment. Therefore, select the specifications required by the service when creating a notebook instance, or save your code and data to OBS in a timely manner during development so that you can quickly upload the code and data to a new notebook instance. -- If the code output is still displayed after you close the page and open it again, use Terminal. diff --git a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/creating_a_notebook_instance.rst b/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/creating_a_notebook_instance.rst deleted file mode 100644 index 74b5bf10..00000000 --- a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/creating_a_notebook_instance.rst +++ /dev/null @@ -1,95 +0,0 @@ -.. _modelarts_23_0034: - -Creating a Notebook Instance -============================ - -Before developing a model, create a notebook instance, open it, and perform encoding. - -Background ----------- - -- Only notebook instances in the **Running** state can be started. -- A maximum of 10 notebook instances can be created for an account. By default, the notebook instances created by the current user are displayed. If **Display Only My Instances** is disabled, all notebook instances created by the current account and its IAM users are displayed. -- If OBS storage is used, ensure that the OBS directory you use and ModelArts are in the same region. -- Before creating a notebook instance, learn about the :ref:`AI engines supported by ModelArts ` and their versions. - -.. _creating-a-notebook-instance-1: - -Creating a Notebook Instance ----------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **DevEnviron > Notebooks** to switch to the **Notebooks** page. - -#. Click **Create**. On the displayed page, set the required parameters. - - a. Enter the basic information about the notebook instance, including the name, description, and whether to automatically stop the notebook instance. For details about the parameters, see :ref:`Table 1 `. - - .. _modelarts_23_0034__en-us_topic_0162690358_fig12309736151510: - - .. figure:: /_static/images/en-us_image_0000001156920885.png - :alt: **Figure 1** Basic information about a notebook instance - - - **Figure 1** Basic information about a notebook instance - - .. _modelarts_23_0034__en-us_topic_0162690358_table1669535791517: - - .. table:: **Table 1** Parameters of basic information - - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=======================================================================================================================================================================================+ - | Name | Name of a notebook instance, which contains a maximum of 64 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. This parameter is mandatory. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of a notebook instance. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Auto Stop | This function is enabled by default. The default value is **1 hour later**, indicating that the notebook instance automatically stops after running for 1 hour and its billing stops. | - | | | - | | The options are **1 hour later**, **2 hours later**, **4 hours later**, **6 hours later**, and **Custom**. You can select **Custom** to specify any integer from 1 to 24 hours. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Set notebook parameters, such as the work environment and instance flavor. For details, see :ref:`Table 2 `. - - .. _modelarts_23_0034__en-us_topic_0162690358_table4606194015227: - - .. table:: **Table 2** Notebook instance parameters - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Work Environment | Only public images, which are the AI frameworks built in ModelArts are supported. | - | | | - | | All supported AI engines can be used in the same notebook instance. Different engines can be switched quickly and conveniently, and run in independent development environments. After the notebook instance is created, go to the **Jupyter** page to create the development environment with the desired AI engine. The AI engine varies depending on the operating environment. For details, see :ref:`Supported AI Engines `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Resource Pool | Select **Public resource pools** or **Dedicated resource pools**. For details about the dedicated resource pools and how to buy them, see :ref:`Resource Pools `. | - | | | - | | Public resource pools are available immediately after being provisioned. Dedicated resource pools are queue-free. When a large number of users use the public resource pool, they may queue for resources. Purchase a dedicated resource pool to improve development efficiency. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | The CPU and GPU types are supported. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Instance Flavor | If you select a public resource pool, available flavors vary depending on the selected type. | - | | | - | | - If you select **CPU** for **Type**, available options include **2 vCPUs \| 8 GiB** and **8 vCPUs \| 32 GiB**. | - | | - If you select **GPU** for **Type**, the available option is **GPU: 1 x v100NV32 CPU: 8 vCPUs \| 64 GiB**. | - | | - If you select **Ascend** for **Type**, available options include **Ascend: 1 x Ascend 910 CPU: 24 vCPUs \| 96 GiB** and **Ascend: 8 x Ascend 910 CPU: 192 vCPUs \| 720 GiB**. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Storage | The **EVS** and **OBS** options are available. | - | | | - | | - Selecting **EVS** | - | | | - | | Set **Disk Space** based on the actual usage. The default value of **Disk Space** is 5 GB. ModelArts provides 5 GB disk space for you to use for free. If the disk space exceeds 5 GB, the additional space is billed by GB according to pricing of **ultra-high I/O** disks. The value of **Disk Space** ranges from 5 to 4096. | - | | | - | | If you select this storage mode, all read and write operations on files on the notebook instances take effect on the data stored in your notebook instances. There is no data loss after you restart notebook instances. | - | | | - | | - Selecting **OBS** | - | | | - | | Click **Select** next to the **Storage Path** text box to set the OBS path for storing notebook instance data. If you want to use existing files or data, upload the files or data to the corresponding OBS path in advance. **Storage Path** must be set to a specific directory in an OBS bucket rather than the root directory of the OBS bucket. | - | | | - | | If you select this storage mode, all read and write operations on files on the notebook instances take effect on the data stored in your selected OBS path. To synchronize data in a file stored in OBS to a notebook instance, select the file and click **Sync OBS**. For details, see :ref:`Synchronizing Files with OBS `. There is no data loss after you restart this notebook instance. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. Click **Next**. - -#. After confirming the parameter configurations, click **Submit**. - - Switch to the notebook instance list. **Status** of the notebook instance being created is **Starting**. If **Status** of the notebook instance changes to **Running**, the notebook instance has been created. diff --git a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/deleting_a_notebook_instance.rst b/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/deleting_a_notebook_instance.rst deleted file mode 100644 index 4fed2aea..00000000 --- a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/deleting_a_notebook_instance.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0042: - -Deleting a Notebook Instance -============================ - -You can delete notebook instances that are no longer used to release resources. - -#. Log in to the ModelArts management console. In the left navigation pane, choose **DevEnviron > Notebooks** to switch to the **Notebooks** page. -#. In the notebook instance list, locate the row where the target notebook instance resides and click **Delete** in the **Operation** column. In the dialog box that is displayed, click **OK**. - - .. note:: - - Deleted notebook instances cannot be recovered. Therefore, exercise caution when performing this operation. However, the files created in notebook instances are still stored in OBS specified during creation of the notebook instances. diff --git a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/index.rst b/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/index.rst deleted file mode 100644 index a94ef42b..00000000 --- a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0111: - -=========================== -Managing Notebook Instances -=========================== - -.. toctree:: - :maxdepth: 1 - - creating_a_notebook_instance - opening_a_notebook_instance - starting_or_stopping_a_notebook_instance - deleting_a_notebook_instance diff --git a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/opening_a_notebook_instance.rst b/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/opening_a_notebook_instance.rst deleted file mode 100644 index 581479d7..00000000 --- a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/opening_a_notebook_instance.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _modelarts_23_0325: - -Opening a Notebook Instance -=========================== - -You can open a created notebook instance (that is, an instance in the **Running** state) and start coding in the development environment. - -Instance Opening ----------------- - -- Go to the **Jupyter Notebook** page. - - In the notebook instance list, locate the row where the target notebook instance resides and click **Open** in the **Operation** column or click the notebook instance name. - -- Go to the **JupyterLab** page. - - In the notebook instance list, select the notebook instance to be opened and click **Open JupyterLab** in the **Operation** column. - -Code Development ----------------- - -ModelArts provides two environments for code development: Jupyter Notebook and JupyterLab. - -- :ref:`Jupyter Notebook `: a web-based application for interactive computing. It can be applied to full-process computing: development, documentation, running code, and presenting results. -- :ref:`JupyterLab `: an interactive development environment. It is a next-generation product of Jupyter Notebook. JupyterLab enables you to compile notebooks, operate terminals, edit MarkDown text, open interaction modes, and view CSV files and images. diff --git a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/starting_or_stopping_a_notebook_instance.rst b/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/starting_or_stopping_a_notebook_instance.rst deleted file mode 100644 index ac05cdc1..00000000 --- a/modelarts/umn/result/devenviron_notebook/managing_notebook_instances/starting_or_stopping_a_notebook_instance.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0041: - -Starting or Stopping a Notebook Instance -======================================== - -You can stop unwanted notebook instances to prevent unnecessary fees. You can also start a notebook instance that is in the **Stopped** state to use it again. - -Log in to the ModelArts management console. In the left navigation pane, choose **DevEnviron > Notebooks** to switch to the **Notebooks** page. Perform the following operations to stop or start a notebook instance: - -- To stop a notebook instance, locate the row where the notebook instance resides and click **Stop** in the **Operation** column. Only notebook instances in the **Running** state can be stopped. -- To start a notebook instance, locate the row where the notebook instance resides and click **Start** in the **Operation** column. Only notebook instances in the **Stopped** state can be started. diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/common_operations_on_jupyter_notebook.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/common_operations_on_jupyter_notebook.rst deleted file mode 100644 index 60c4e6e0..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/common_operations_on_jupyter_notebook.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. _modelarts_23_0120: - -Common Operations on Jupyter Notebook -===================================== - -This section describes common operations on Jupyter Notebook. - -Opening Jupyter Notebook ------------------------- - -In the notebook instance list, locate the row where the target notebook instance resides and click **Open** in the **Operation** column to switch to the **Jupyter Notebook** page. - -Two tab pages are available on the **Jupyter Notebook** page: **Files** and **Running**. - -.. _modelarts_23_0120__en-us_topic_0188347008_fig13203124195913: - -.. figure:: /_static/images/en-us_image_0000001110761034.png - :alt: **Figure 1** Jupyter Notebook - - - **Figure 1** Jupyter Notebook - -Selecting Different AI Engines to Create Files ----------------------------------------------- - -Open a notebook instance and go to the **Jupyter Notebook** page. On the **Files** tab page, click **New** in the upper right corner, select the required AI engine, and create a file for encoding. - -.. _modelarts_23_0120__en-us_topic_0188347008_fig8224175513165: - -.. figure:: /_static/images/en-us_image_0000001157080885.png - :alt: **Figure 2** Selecting different AI engines - - - **Figure 2** Selecting different AI engines - -Uploading a File ----------------- - -Open a notebook instance and go to the **Jupyter Notebook** page. On the **Files** tab page, click **Upload** in the upper right corner to select a file from the local PC and upload it. - -.. _modelarts_23_0120__en-us_topic_0188347008_fig89015882019: - -.. figure:: /_static/images/en-us_image_0000001110920940.png - :alt: **Figure 3** Uploading a file - - - **Figure 3** Uploading a file - -Compiling a File ----------------- - -After a file is created, click the file name to go to the file compilation page. - -.. _modelarts_23_0120__en-us_topic_0188347008_fig65191088443: - -.. figure:: /_static/images/en-us_image_0000001110920938.png - :alt: **Figure 4** Compiling a file - - - **Figure 4** Compiling a file - -.. table:: **Table 1** Introduction to the file compilation page - - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | No. | Area | Description | - +=======================+==============================+=============================================================================================================================================================================================================================================================================================================================================================================================================================+ - | 1 | File name | You can enter a user-defined file name in this area. After the file name is changed and saved, the new file name is updated to the file list accordingly. | - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 2 | Menu bar | The menu bar provides rich functions such as File, Edit, View, Insert, Cell, Kernel, and Help. For details, see `Jupyter Notebook Documentation `__. The following toolbar provides common functions for compiling common Python running files. | - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 3 | Toolbar | The toolbar lists the common shortcut operations. From left to right, the shortcut operations are as follows: saving a file, adding a new cell, cutting a selected cell, copying a selected cell, pasting a selected cell, moving a selected cell upwards, moving a selected cell downwards, running a selected cell, terminating the kernel, restarting the kernel, and restarting the kernel and running all cells again. | - | | | | - | | | The **Code** drop-down list contains the following options: | - | | | | - | | | - Code: Write Python code. | - | | | - MarkDown: Write MarkDown code, which is usually used for comments. | - | | | - Raw NBConvert: conversion tool. | - | | | - Heading: Quickly add a MarkDown title. | - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 4 | AI engine and Python version | Displays the AI engine and Python version corresponding to the current file. For details about all AI engines and Python versions supported by ModelArts, see :ref:`Supported AI Engines `. | - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | 5 | Code cell | Each cell has two modes: command mode and editing mode. | - | | | | - | | | The blue bar on the left indicates the command mode, and the green bar indicates the editing mode (in this mode, the cursor exists in the cell and you can write code). In command mode, you can press **Enter** or click the code box to enter the editing mode. In editing mode, you can press **ESC** or click the left area of the code box to enter the command mode. | - | | | | - | | | |image1| | - +-----------------------+------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -Deleting a File or Folder -------------------------- - -To delete a file or folder from Jupyter Notebook, select the file or folder in the **Files** list and click the **Delete** button. - -.. note:: - - After the file or folder is deleted, click the **Refresh** button in the upper right corner to refresh the Jupyter page and clear the cache. - -.. _modelarts_23_0120__en-us_topic_0188347008_fig10721575216: - -.. figure:: /_static/images/en-us_image_0000001110761038.png - :alt: **Figure 5** Jupyter page - - - **Figure 5** Jupyter page - -.. |image1| image:: /_static/images/en-us_image_0000001110920936.png - diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/index.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/index.rst deleted file mode 100644 index 8f490d3d..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0327: - -============================================ -Configuring the Jupyter Notebook Environment -============================================ - -.. toctree:: - :maxdepth: 1 - - using_the_notebook_terminal_function - switching_the_cuda_version_on_the_terminal_page_of_a_gpu-based_notebook_instance - installing_external_libraries_and_kernels_in_notebook_instances diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/installing_external_libraries_and_kernels_in_notebook_instances.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/installing_external_libraries_and_kernels_in_notebook_instances.rst deleted file mode 100644 index 9e6ad567..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/installing_external_libraries_and_kernels_in_notebook_instances.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. _modelarts_23_0040: - -Installing External Libraries and Kernels in Notebook Instances -=============================================================== - -Multiple environments have been installed in ModelArts notebook instances, including TensorFlow. You can use **pip install** to install external libraries from a Jupyter notebook or terminal to facilitate use. - -Installing an External Library from a Jupyter Notebook ------------------------------------------------------- - -Assume that you want to install Shapely from a notebook instance. Follow the following instructions: - -#. In the left navigation pane of the ModelArts management console, choose **DevEnviron > Notebooks**. Open a notebook instance in the displayed notebook instance list. - -#. In the **Jupyter Notebook** page that is displayed, click **New** and select the required AI engine from the drop-down list. - -#. In the displayed window, type the following command in the code input bar to install Shapely: - - **pip install shapely** - -Installing an External Library from a Terminal ----------------------------------------------- - -Assume that you want to install Shapely from the terminal of a notebook instance by using pip. Follow the following instructions: - -#. In the left navigation pane of the ModelArts management console, choose **DevEnviron > Notebooks**. Open a notebook instance in the displayed notebook instance list. - -#. In the displayed Jupyter dashboard, click **New** and choose **Terminal** from the shortcut menu. - -#. For a notebook instance that does not use the AI engine of the **Multi-Engine** type, enter the following command in the code input bar to install Shapely: - - **/opt/conda/envs/python27_tf/bin/pip install Shapely** - -#. The **Multi-Engine** notebook instance can use multiple engines. By referring to the **README** file in the **/home/ma-user/** path, switch to the installation package of the corresponding engine environment and install Shapely. For example, you can install Shapely from TensorFlow-1.13.1 with the following code: - - .. code-block:: - - source /home/ma-user/anaconda3/bin/activate TensorFlow-1.13.1 - pip install shapely - -.. note:: - - When you create a ModelArts training job, a new independent running environment is started, which is not associated with the packages installed in the Notebook environment. Therefore, add **os.system('pip install xxx')** to the startup code before importing the installation package. - - For example, if you need to use the Shapely dependency in the training job, add the following code to the startup code: - - .. code-block:: - - os.system('pip install Shapely') - import Shapely diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/switching_the_cuda_version_on_the_terminal_page_of_a_gpu-based_notebook_instance.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/switching_the_cuda_version_on_the_terminal_page_of_a_gpu-based_notebook_instance.rst deleted file mode 100644 index 03a7d91f..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/switching_the_cuda_version_on_the_terminal_page_of_a_gpu-based_notebook_instance.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _modelarts_23_0280: - -Switching the CUDA Version on the Terminal Page of a GPU-based Notebook Instance -================================================================================ - -For a GPU-based notebook instance, you can switch different versions of CUDA on the **Terminal** page of Jupyter. - -CPU-based notebook instances do not use CUDA. Therefore, the following operations apply only to GPU-based notebook instances. - -#. Create and open a notebook instance or open an existing notebook instance in the notebook instance list. - -#. On the **Files** tab page of the Jupyter page, click **New** and select **Terminal**. The **Terminal** page is displayed. - -#. Run the following command to go to **/usr/local**: - - .. code-block:: - - cd /usr/local - -#. For example, to switch to CUDA 10, run the following command: - - .. code-block:: - - sudo ln -snf /usr/local/cuda-10.0 cuda - - .. _modelarts_23_0280__en-us_topic_0245881876_fig9219163419370: - - .. figure:: /_static/images/en-us_image_0000001156920929.png - :alt: **Figure 1** Example of switching the CUDA version - - - **Figure 1** Example of switching the CUDA version diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/using_the_notebook_terminal_function.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/using_the_notebook_terminal_function.rst deleted file mode 100644 index b3e6f606..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/configuring_the_jupyter_notebook_environment/using_the_notebook_terminal_function.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _modelarts_23_0117: - -Using the Notebook Terminal Function -==================================== - -For developers who are used to coding, the terminal function is very convenient and practical. This section describes how to enable the terminal function in a notebook instance and switch the engine environment in the terminal. - -Enabling the Notebook Terminal Function ---------------------------------------- - -#. In the notebook instance list, click **Open** in the **Operation** column of the target notebook instance to go to the **Jupyter Notebook** page. - -#. On the **Files** tab page of the Jupyter page, click **New** and select **Terminal**. The **Terminal** page is displayed. - - .. _modelarts_23_0117__en-us_topic_0190535990_fig98166612210: - - .. figure:: /_static/images/en-us_image_0000001110920980.png - :alt: **Figure 1** Going to the Terminal page - - - **Figure 1** Going to the Terminal page - -Switching Engine Environments on the Terminal ---------------------------------------------- - -You can switch to another AI engine environment in the terminal environment of Jupyter. - -#. Create and open a notebook instance or open an existing notebook instance in the notebook instance list. - -#. On the **Files** tab page of the Jupyter page, click **New** and select **Terminal**. The **Terminal** page is displayed. - -#. .. _modelarts_23_0117__en-us_topic_0190535990_fig161667313101: - - .. figure:: /_static/images/en-us_image_0000001110761076.png - :alt: **Figure 2** Output after command execution - - - **Figure 2** Output after command execution diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/index.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/index.rst deleted file mode 100644 index 66b72655..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_23_0035: - -====================== -Using Jupyter Notebook -====================== - -.. toctree:: - :maxdepth: 1 - - introduction_to_jupyter_notebook - common_operations_on_jupyter_notebook - configuring_the_jupyter_notebook_environment/index - synchronizing_files_with_obs - using_the_convert_to_python_file_function diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/introduction_to_jupyter_notebook.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/introduction_to_jupyter_notebook.rst deleted file mode 100644 index 2d25beae..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/introduction_to_jupyter_notebook.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_23_0326: - -Introduction to Jupyter Notebook -================================ - -Jupyter Notebook is a web-based application for interactive computing. It can be applied to full-process computing: development, documentation, running code, and presenting results. - -ModelArts integrates the open-source Jupyter Notebook. After creating a notebook instance, you can open the instance for development without the need for installation and configuration. - -Notebook Kernel ---------------- - -- A notebook kernel is an independent code execution environment. ModelArts Notebook supports multiple kernel types, such as TensorFlow 1.13.1 and PyTorch 1.0. A code execution environment contains the pre-installed and commissioned AI engines and dependencies. -- When a kernel is selected to open a notebook instance, an IPython process is started at the backend of the notebook instance as the running environment to execute the code and command input on the page. -- Each kernel type contains an independent Conda running environment to ensure that the AI engines are independent of each other. For example, if the Keras library is updated in a kernel of the TensorFlow type, the kernel of the MindSpore type will not be affected. - -Differences Between Notebook Kernels and Common Interactive Python Interpreters -------------------------------------------------------------------------------- - -A notebook kernel is an IPython running environment, which can be considered as an enhanced Python shell. Compared with a Python interpreter, a notebook kernel can execute shell scripts and integrate more visualized tools and magic commands. For details, see `IPython Documentation `__. diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/synchronizing_files_with_obs.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/synchronizing_files_with_obs.rst deleted file mode 100644 index 1b183085..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/synchronizing_files_with_obs.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _modelarts_23_0038: - -Synchronizing Files with OBS -============================ - -If you specify **Storage Path** during notebook instance creation, your compiled code will be automatically stored in your specified OBS bucket. If code invocation among different **.ipynb** files is required, you can use the Sync OBS function. - -The Sync OBS function is used to synchronize the objects selected in the list of notebook instance files from the OBS bucket to the current container directory **~/work**. - -Precautions ------------ - -- The maximum size of files to be synchronized at a time is 500 MB, and the maximum number of files to be synchronized at a time is 1,024. -- The total size of objects to be synchronized cannot exceed 5 GB. For example, if 2 GB files exist in the **~/work** container directory, you can use Sync OBS to synchronize a maximum of 3 GB files. -- The Sync OBS function only takes effect on notebook instances for which **Storage** is **OBS**. For notebook instances whose **Storage** is not **OBS**, all files are read and written in the **~/work** container directory. - -Procedure ---------- - -The Sync OBS function can be used in notebook instances. The following describes how to use the function. - -For example, if the **Example1.ipynb** file needs to call **module** in the **Example2.ipynb** file, select both files and click **Sync OBS**. - -.. _modelarts_23_0038__en-us_topic_0164900253_fig4940114710298: - -.. figure:: /_static/images/en-us_image_0000001156920981.png - :alt: **Figure 1** Using the Sync OBS function - - - **Figure 1** Using the Sync OBS function diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/using_the_convert_to_python_file_function.rst b/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/using_the_convert_to_python_file_function.rst deleted file mode 100644 index c6297300..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyter_notebook/using_the_convert_to_python_file_function.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _modelarts_23_0037: - -Using the Convert to Python File Function -========================================= - -After code compiling is finished, you can save the entered code as a **.py** file which can be used for starting training jobs. - -#. Create and open a notebook instance or open an existing notebook instance in the notebook instance list. - -#. On the **Files** tab page, click **New** and choose the required AI engine from the drop-down list to access the code development page. - -#. After code compiling is complete, click the save button in the upper left corner. Then, click **Convert to Python File** to convert the current **ipynb** file into a **Python** file. This function can be used to directly save your entered code as a **.py** file to the working directory. - - The generated **.py** file can be used to start ModelArts training jobs. - - .. _modelarts_23_0037__en-us_topic_0164804632_fig598812270439: - - .. figure:: /_static/images/en-us_image_0000001156920943.png - :alt: **Figure 1** Convert to Python File - - - **Figure 1** Convert to Python File - -#. In the dialog box that is displayed, enter the file name as required, and select or deselect **Force overwrite if file already exists**. By default, the item is not selected, indicating that the file will not be overwritten when a file with the same name exists in the directory. Click **Convert**. - - .. _modelarts_23_0037__en-us_topic_0164804632_fig857814328308: - - .. figure:: /_static/images/en-us_image_0000001110761072.png - :alt: **Figure 2** Setting and saving the configuration - - - **Figure 2** Setting and saving the configuration diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/index.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/index.rst deleted file mode 100644 index dbadef74..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0330: - -================ -Using JupyterLab -================ - -.. toctree:: - :maxdepth: 1 - - introduction_to_jupyterlab_and_common_operations - uploading_and_downloading_data/index - using_modelarts_sdks diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/introduction_to_jupyterlab_and_common_operations.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/introduction_to_jupyterlab_and_common_operations.rst deleted file mode 100644 index cb41bca0..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/introduction_to_jupyterlab_and_common_operations.rst +++ /dev/null @@ -1,224 +0,0 @@ -.. _modelarts_23_0209: - -Introduction to JupyterLab and Common Operations -================================================ - -JupyterLab is an interactive development environment. It is a next-generation product of Jupyter Notebook. JupyterLab enables you to compile notebooks, operate terminals, edit MarkDown text, open interaction modes, and view CSV files and images. - -JupyterLab will be a mainstream development environment for developers. JupyterLab supports more flexible and powerful project operations, but has the same components as Jupyter Notebook. - -ModelArts supports Jupyter Notebook and JupyterLab. You can use different tools to develop code in the same notebook instance. - -Opening JupyterLab ------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **DevEnviron > Notebooks** to switch to the **Notebooks** page. - -#. Select a notebook instance in the **Running** state and click **Open** in the **Operation** column to access the notebook instance. - -#. On the **Jupyter** page, click **Open JupyterLab** in the upper right corner to access the JupyterLab page of the notebook instance. - -#. The **Launcher** page is automatically displayed. You can use all open-source functions. For details, see `JupyterLab Documentation `__. - - .. _modelarts_23_0209__en-us_topic_0208766071_fig1727316104710: - - .. figure:: /_static/images/en-us_image_0000001110920930.png - :alt: **Figure 1** JupyterLab homepage - - - **Figure 1** JupyterLab homepage - -Creating and Opening a Notebook Instance ----------------------------------------- - -On the JupyterLab homepage, click an applicable AI engine in the **Notebook** area to create a notebook file with the selected framework. - -The AI framework supported by each notebook instance varies according to the working environment. The following figure is only an example. Select an AI framework based on the site requirements. For details about all framework versions and Python versions supported by ModelArts, see :ref:`Supported AI Engines `. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig812525717438: - -.. figure:: /_static/images/en-us_image_0000001157080871.png - :alt: **Figure 2** Selecting an AI engine and creating a notebook instance - - - **Figure 2** Selecting an AI engine and creating a notebook instance - -The created notebook file is displayed in the navigation pane on the left. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig6910322104612: - -.. figure:: /_static/images/en-us_image_0000001110920924.png - :alt: **Figure 3** Creating a notebook file - - - **Figure 3** Creating a notebook file - -Creating a Notebook File and Opening the Console ------------------------------------------------- - -A console is essentially a Python terminal, which is similar to the native IDE of Python, displaying the output after a statement is entered. - -On the JupyterLab homepage, click an applicable AI engine in the **Console** area to create a notebook file with the selected framework. - -The AI framework supported by each notebook instance varies according to the working environment. The following figure is only an example. Select an AI framework based on the site requirements. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig146903307496: - -.. figure:: /_static/images/en-us_image_0000001156920897.png - :alt: **Figure 4** Selecting an AI engine and creating a console - - - **Figure 4** Selecting an AI engine and creating a console - -After the file is created, the console page is displayed. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig12167335121119: - -.. figure:: /_static/images/en-us_image_0000001110761020.png - :alt: **Figure 5** Creating a notebook file (console) - - - **Figure 5** Creating a notebook file (console) - -.. _modelarts_23_0209__en-us_topic_0208766071_section172463910383: - -Uploading a File ----------------- - -On the JupyterLab page, you can click **Upload File** in the upper left corner and select a local file to upload. - -The size of the file to be uploaded using this method is limited. If the file size exceeds the limit, use other methods to upload the file. For details, see :ref:`Uploading Data to JupyterLab `. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig162661614164017: - -.. figure:: /_static/images/en-us_image_0000001110920918.png - :alt: **Figure 6** Uploading a file - - - **Figure 6** Uploading a file - -Editing a File --------------- - -JupyterLab allows you to open multiple notebook instances or files (such as HTML, TXT, and Markdown files) in the same window and displays them on different tab pages. - -Using JupyterLab, you can customize the display of multiple files. In the file display area on the right, you can drag a file to adjust its position. Multiple files can be concurrently displayed. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig6301121132215: - -.. figure:: /_static/images/en-us_image_0000001157080869.png - :alt: **Figure 7** Customized display of multiple files - - - **Figure 7** Customized display of multiple files - -When writing code in a notebook instance, you can create multiple views of a file to synchronously edit the file and view the execution result in real time. - -To open multiple views, open the file and choose **File** > **New View for Notebook**. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig9122203643213: - -.. figure:: /_static/images/en-us_image_0000001110920916.png - :alt: **Figure 8** Multiple views of a file - - - **Figure 8** Multiple views of a file - -Downloading a File to a Local Computer --------------------------------------- - -Files created in JupyterLab can be directly downloaded to a local computer. The size of the file to be downloaded using this method is limited. If the file size exceeds the limit, use other methods to download the file. For details, see :ref:`Downloading a File from JupyterLab `. - -In the JupyterLab file list, right-click the file to be downloaded and choose **Download** from the shortcut menu. The file is downloaded to the directory set for your browser. - -.. _modelarts_23_0209__en-us_topic_0208766071_fig115128616340: - -.. figure:: /_static/images/en-us_image_0000001157080879.png - :alt: **Figure 9** Downloading a file - - - **Figure 9** Downloading a file - -Common Icons and Plug-ins of JupyterLab ---------------------------------------- - -.. _modelarts_23_0209__en-us_topic_0208766071_fig18661212194314: - -.. figure:: /_static/images/en-us_image_0000001110761018.png - :alt: **Figure 10** Common icons and plug-ins of JupyterLab - - - **Figure 10** Common icons and plug-ins of JupyterLab - -.. table:: **Table 1** Icon description - - +----------+---------------------------------------------------------------------------------------------------------------------------+ - | Icon | Description | - +==========+===========================================================================================================================+ - | |image5| | Opens the Launcher page. Then you can quickly create notebook instances, consoles, or other files. | - +----------+---------------------------------------------------------------------------------------------------------------------------+ - | |image6| | Creates a folder. | - +----------+---------------------------------------------------------------------------------------------------------------------------+ - | |image7| | Uploads a file. For details, see :ref:`Uploading a File `. | - +----------+---------------------------------------------------------------------------------------------------------------------------+ - | |image8| | Updates a folder. | - +----------+---------------------------------------------------------------------------------------------------------------------------+ - -.. table:: **Table 2** Common plug-ins in the plug-in area - - +-----------+-------------------------------------------------------------------------------------------------------+ - | Plug-in | Description | - +===========+=======================================================================================================+ - | |image15| | Lists files. You can click here to display the list of all files in the notebook instance. | - +-----------+-------------------------------------------------------------------------------------------------------+ - | |image16| | Lists ModelArts examples. You can click any example in the list to view its code and version mapping. | - +-----------+-------------------------------------------------------------------------------------------------------+ - | |image17| | Displays the terminals and kernels that are running in the current instance. | - +-----------+-------------------------------------------------------------------------------------------------------+ - | |image18| | Quick start command. | - +-----------+-------------------------------------------------------------------------------------------------------+ - | |image19| | Displays the tab page listing the files that are being opened. | - +-----------+-------------------------------------------------------------------------------------------------------+ - | |image20| | Document organization. | - +-----------+-------------------------------------------------------------------------------------------------------+ - -.. |image1| image:: /_static/images/en-us_image_0000001110920920.png - -.. |image2| image:: /_static/images/en-us_image_0000001157080875.png - -.. |image3| image:: /_static/images/en-us_image_0000001156920903.png - -.. |image4| image:: /_static/images/en-us_image_0000001156920893.png - -.. |image5| image:: /_static/images/en-us_image_0000001110920920.png - -.. |image6| image:: /_static/images/en-us_image_0000001157080875.png - -.. |image7| image:: /_static/images/en-us_image_0000001156920903.png - -.. |image8| image:: /_static/images/en-us_image_0000001156920893.png - -.. |image9| image:: /_static/images/en-us_image_0000001110920934.png - -.. |image10| image:: /_static/images/en-us_image_0000001110761016.png - -.. |image11| image:: /_static/images/en-us_image_0000001157080873.png - -.. |image12| image:: /_static/images/en-us_image_0000001156920899.png - -.. |image13| image:: /_static/images/en-us_image_0000001156920901.png - -.. |image14| image:: /_static/images/en-us_image_0000001156920887.png - -.. |image15| image:: /_static/images/en-us_image_0000001110920934.png - -.. |image16| image:: /_static/images/en-us_image_0000001110761016.png - -.. |image17| image:: /_static/images/en-us_image_0000001157080873.png - -.. |image18| image:: /_static/images/en-us_image_0000001156920899.png - -.. |image19| image:: /_static/images/en-us_image_0000001156920901.png - -.. |image20| image:: /_static/images/en-us_image_0000001156920887.png - diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/downloading_a_file_from_jupyterlab.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/downloading_a_file_from_jupyterlab.rst deleted file mode 100644 index 0f2a44fe..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/downloading_a_file_from_jupyterlab.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. _modelarts_23_0333: - -Downloading a File from JupyterLab -================================== - -Only files within 100 MB in JupyterLab can be downloaded to a local PC. You can perform operations in different scenarios based on the storage location selected when creating a notebook instance. - -Notebook Instances with EVS Attached ------------------------------------- - -For notebook instances with EVS attached, you can perform the following operations to download large files to the local PC: - -#. In the notebook instance, create an **ipynb** file. Use MoXing to upload the large files from notebook instances to OBS. The sample code is as follows: - - +-----------------------------------+---------------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | import moxing as mox | - | 2 | mox.file.copy('/home/ma-user/work/obs_file.txt', 'obs://bucket_name/obs_file.txt') | - +-----------------------------------+---------------------------------------------------------------------------------------+ - - In the preceding code, **/home/ma-user/work/obs_file.txt** indicates a file storage path in a notebook instance, and **obs://bucket_name/obs_file.txt** indicates a file storage path on OBS. - -#. Use OBS or the ModelArts SDKs to download the files from OBS to the local PC. - -Notebook Instances Using OBS Storage ------------------------------------- - -For notebook instances that use OBS storage, you can use OBS or the ModelArts SDK to download files from OBS to a local PC. - -Use OBS for download. diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/index.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/index.rst deleted file mode 100644 index a039a38f..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0331: - -============================== -Uploading and Downloading Data -============================== - -.. toctree:: - :maxdepth: 1 - - uploading_data_to_jupyterlab - downloading_a_file_from_jupyterlab diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/uploading_data_to_jupyterlab.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/uploading_data_to_jupyterlab.rst deleted file mode 100644 index 5dfcfb16..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/uploading_and_downloading_data/uploading_data_to_jupyterlab.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _modelarts_23_0332: - -Uploading Data to JupyterLab -============================ - -On the **JupyterLab** page, click **Upload Files** to upload a file. For details, see :ref:`Uploading a File ` in :ref:`Introduction to JupyterLab and Common Operations `. If a message is displayed indicating that the size of the files to be uploaded exceeds the upper limit when uploading files to notebook instances or JupyterLab, you can upload the files to OBS and then download them to notebook instances. - -Step 1: Uploading Files to OBS ------------------------------- - -Use the OBS API to upload large files because OBS Console has restrictions on the file size and quantity. - -Step 2: Downloading Files from OBS to Notebook Instances --------------------------------------------------------- - -A notebook instance can be mounted to OBS or EVS as the storage location. The operation method varies depending on the instance types. - -- Downloading files to notebook instances with EVS attached - - - Use the following MoXing API to synchronize files from OBS to notebook instances. - - Read an OBS file. For example, if you read the **obs://bucket_name/obs_file.txt** file, the content is returned as strings. - - +-----------------------------------+---------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | file_str = mox.file.read('obs://bucket_name/obs_file.txt') | - +-----------------------------------+---------------------------------------------------------------+ - - You can also open the file object and read data from it. Both methods are equivalent. - - +-----------------------------------+--------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | with mox.file.File('obs://bucket_name/obs_file.txt', 'r') as f: | - | 2 | file_str = f.read() | - +-----------------------------------+--------------------------------------------------------------------+ - - - Use the OBS API in the ModelArts SDK to download data from OBS to notebook instances. - - .. note:: - - If the size of a single file exceeds 5 GB, the file cannot be uploaded in this mode. Use the MoXing API to upload large files. - - Sample code: - - +-----------------------------------+--------------------------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | from modelarts.session import Session | - | 2 | session = Session() | - | 3 | session.download_data(bucket_path="/bucket-name/dir1/sdk.txt", path="/home/user/sdk/obs.txt") | - +-----------------------------------+--------------------------------------------------------------------------------------------------+ - -- Downloading files to notebook instances using OBS for data storage - - Upload files to the OBS path specified during notebook instance creation and synchronize the files from OBS to the notebook instances using Sync OBS. diff --git a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/using_modelarts_sdks.rst b/modelarts/umn/result/devenviron_notebook/using_jupyterlab/using_modelarts_sdks.rst deleted file mode 100644 index a8db041e..00000000 --- a/modelarts/umn/result/devenviron_notebook/using_jupyterlab/using_modelarts_sdks.rst +++ /dev/null @@ -1,64 +0,0 @@ -.. _modelarts_23_0335: - -Using ModelArts SDKs -==================== - -In notebook instances, you can use ModelArts SDKs to manage OBS, training jobs, models, and real-time services. - -For details about how to use ModelArts SDKs, see *ModelArts SDK Reference*. - -Notebooks carry the authentication (AK/SK) and region information about login users. Therefore, SDK session authentication can be completed without entering parameters. - -Example Code ------------- - -- Creating a training job - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | from modelarts.session import Session | - | 2 | from modelarts.estimator import Estimator | - | 3 | session = Session() | - | 4 | estimator = Estimator( | - | 5 | modelarts_session=session, | - | 6 | framework_type='PyTorch', # AI engine name | - | 7 | framework_version='PyTorch-1.0.0-python3.6', # AI engine version | - | 8 | code_dir='/obs-bucket-name/src/', # Training script directory | - | 9 | boot_file='/obs-bucket-name/src/pytorch_sentiment.py', # Training startup script directory | - | 10 | log_url='/obs-bucket-name/log/', # Training log directory | - | 11 | hyperparameters=[ | - | 12 | {"label":"classes", | - | 13 | "value": "10"}, | - | 14 | {"label":"lr", | - | 15 | "value": "0.001"} | - | 16 | ], | - | 17 | output_path='/obs-bucket-name/output/', # Training output directory | - | 18 | train_instance_type='modelarts.vm.gpu.p100', # Training environment specifications | - | 19 | train_instance_count=1, # Number of training nodes | - | 20 | job_description='pytorch-sentiment with ModelArts SDK') # Training job description | - | 21 | job_instance = estimator.fit(inputs='/obs-bucket-name/data/train/', wait=False, job_name='my_training_job') | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------+ - -- Querying a model list - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | from modelarts.session import Session | - | 2 | from modelarts.model import Model | - | 3 | session = Session() | - | 4 | model_list_resp = Model.get_model_list(session, model_status="published", model_name="digit", order="desc") | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------+ - -- Querying service details - - +-----------------------------------+--------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | from modelarts.session import Session | - | 2 | from modelarts.model import Predictor | - | 3 | session = Session() | - | 4 | predictor_instance = Predictor(session, service_id="input your service_id") | - | 5 | predictor_info_resp = predictor_instance.get_service_info() | - +-----------------------------------+--------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/caffe.rst b/modelarts/umn/result/examples_of_custom_scripts/caffe.rst deleted file mode 100644 index 2100b079..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/caffe.rst +++ /dev/null @@ -1,413 +0,0 @@ -.. _modelarts_23_0176: - -Caffe -===== - -Training and Saving a Model ---------------------------- - -**lenet_train_test.prototxt** file - -+-----------------------------------+--------------------------------------------------+ -| :: | :: | -| | | -| 1 | name: "LeNet" | -| 2 | layer { | -| 3 | name: "mnist" | -| 4 | type: "Data" | -| 5 | top: "data" | -| 6 | top: "label" | -| 7 | include { | -| 8 | phase: TRAIN | -| 9 | } | -| 10 | transform_param { | -| 11 | scale: 0.00390625 | -| 12 | } | -| 13 | data_param { | -| 14 | source: "examples/mnist/mnist_train_lmdb" | -| 15 | batch_size: 64 | -| 16 | backend: LMDB | -| 17 | } | -| 18 | } | -| 19 | layer { | -| 20 | name: "mnist" | -| 21 | type: "Data" | -| 22 | top: "data" | -| 23 | top: "label" | -| 24 | include { | -| 25 | phase: TEST | -| 26 | } | -| 27 | transform_param { | -| 28 | scale: 0.00390625 | -| 29 | } | -| 30 | data_param { | -| 31 | source: "examples/mnist/mnist_test_lmdb" | -| 32 | batch_size: 100 | -| 33 | backend: LMDB | -| 34 | } | -| 35 | } | -| 36 | layer { | -| 37 | name: "conv1" | -| 38 | type: "Convolution" | -| 39 | bottom: "data" | -| 40 | top: "conv1" | -| 41 | param { | -| 42 | lr_mult: 1 | -| 43 | } | -| 44 | param { | -| 45 | lr_mult: 2 | -| 46 | } | -| 47 | convolution_param { | -| 48 | num_output: 20 | -| 49 | kernel_size: 5 | -| 50 | stride: 1 | -| 51 | weight_filler { | -| 52 | type: "xavier" | -| 53 | } | -| 54 | bias_filler { | -| 55 | type: "constant" | -| 56 | } | -| 57 | } | -| 58 | } | -| 59 | layer { | -| 60 | name: "pool1" | -| 61 | type: "Pooling" | -| 62 | bottom: "conv1" | -| 63 | top: "pool1" | -| 64 | pooling_param { | -| 65 | pool: MAX | -| 66 | kernel_size: 2 | -| 67 | stride: 2 | -| 68 | } | -| 69 | } | -| 70 | layer { | -| 71 | name: "conv2" | -| 72 | type: "Convolution" | -| 73 | bottom: "pool1" | -| 74 | top: "conv2" | -| 75 | param { | -| 76 | lr_mult: 1 | -| 77 | } | -| 78 | param { | -| 79 | lr_mult: 2 | -| 80 | } | -| 81 | convolution_param { | -| 82 | num_output: 50 | -| 83 | kernel_size: 5 | -| 84 | stride: 1 | -| 85 | weight_filler { | -| 86 | type: "xavier" | -| 87 | } | -| 88 | bias_filler { | -| 89 | type: "constant" | -| 90 | } | -| 91 | } | -| 92 | } | -| 93 | layer { | -| 94 | name: "pool2" | -| 95 | type: "Pooling" | -| 96 | bottom: "conv2" | -| 97 | top: "pool2" | -| 98 | pooling_param { | -| 99 | pool: MAX | -| 100 | kernel_size: 2 | -| 101 | stride: 2 | -| 102 | } | -| 103 | } | -| 104 | layer { | -| 105 | name: "ip1" | -| 106 | type: "InnerProduct" | -| 107 | bottom: "pool2" | -| 108 | top: "ip1" | -| 109 | param { | -| 110 | lr_mult: 1 | -| 111 | } | -| 112 | param { | -| 113 | lr_mult: 2 | -| 114 | } | -| 115 | inner_product_param { | -| 116 | num_output: 500 | -| 117 | weight_filler { | -| 118 | type: "xavier" | -| 119 | } | -| 120 | bias_filler { | -| 121 | type: "constant" | -| 122 | } | -| 123 | } | -| 124 | } | -| 125 | layer { | -| 126 | name: "relu1" | -| 127 | type: "ReLU" | -| 128 | bottom: "ip1" | -| 129 | top: "ip1" | -| 130 | } | -| 131 | layer { | -| 132 | name: "ip2" | -| 133 | type: "InnerProduct" | -| 134 | bottom: "ip1" | -| 135 | top: "ip2" | -| 136 | param { | -| 137 | lr_mult: 1 | -| 138 | } | -| 139 | param { | -| 140 | lr_mult: 2 | -| 141 | } | -| 142 | inner_product_param { | -| 143 | num_output: 10 | -| 144 | weight_filler { | -| 145 | type: "xavier" | -| 146 | } | -| 147 | bias_filler { | -| 148 | type: "constant" | -| 149 | } | -| 150 | } | -| 151 | } | -| 152 | layer { | -| 153 | name: "accuracy" | -| 154 | type: "Accuracy" | -| 155 | bottom: "ip2" | -| 156 | bottom: "label" | -| 157 | top: "accuracy" | -| 158 | include { | -| 159 | phase: TEST | -| 160 | } | -| 161 | } | -| 162 | layer { | -| 163 | name: "loss" | -| 164 | type: "SoftmaxWithLoss" | -| 165 | bottom: "ip2" | -| 166 | bottom: "label" | -| 167 | top: "loss" | -| 168 | } | -+-----------------------------------+--------------------------------------------------+ - -**lenet_solver.prototxt** file - -+-----------------------------------+---------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # The train/test net protocol buffer definition | -| 2 | net: "examples/mnist/lenet_train_test.prototxt" | -| 3 | # test_iter specifies how many forward passes the test should carry out. | -| 4 | # In the case of MNIST, we have test batch size 100 and 100 test iterations, | -| 5 | # covering the full 10,000 testing images. | -| 6 | test_iter: 100 | -| 7 | # Carry out testing every 500 training iterations. | -| 8 | test_interval: 500 | -| 9 | # The base learning rate, momentum and the weight decay of the network. | -| 10 | base_lr: 0.01 | -| 11 | momentum: 0.9 | -| 12 | weight_decay: 0.0005 | -| 13 | # The learning rate policy | -| 14 | lr_policy: "inv" | -| 15 | gamma: 0.0001 | -| 16 | power: 0.75 | -| 17 | # Display every 100 iterations | -| 18 | display: 100 | -| 19 | # The maximum number of iterations | -| 20 | max_iter: 1000 | -| 21 | # snapshot intermediate results | -| 22 | snapshot: 5000 | -| 23 | snapshot_prefix: "examples/mnist/lenet" | -| 24 | # solver mode: CPU or GPU | -| 25 | solver_mode: CPU | -+-----------------------------------+---------------------------------------------------------------------------------+ - -Train the model. - -.. code-block:: - - ./build/tools/caffe train --solver=examples/mnist/lenet_solver.prototxt - -The **caffemodel** file is generated after model training. Rewrite the **lenet_train_test.prototxt** file to the **lenet_deploy.prototxt** file used for deployment by modifying input and output layers. - -+-----------------------------------+-----------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | name: "LeNet" | -| 2 | layer { | -| 3 | name: "data" | -| 4 | type: "Input" | -| 5 | top: "data" | -| 6 | input_param { shape: { dim: 1 dim: 1 dim: 28 dim: 28 } } | -| 7 | } | -| 8 | layer { | -| 9 | name: "conv1" | -| 10 | type: "Convolution" | -| 11 | bottom: "data" | -| 12 | top: "conv1" | -| 13 | param { | -| 14 | lr_mult: 1 | -| 15 | } | -| 16 | param { | -| 17 | lr_mult: 2 | -| 18 | } | -| 19 | convolution_param { | -| 20 | num_output: 20 | -| 21 | kernel_size: 5 | -| 22 | stride: 1 | -| 23 | weight_filler { | -| 24 | type: "xavier" | -| 25 | } | -| 26 | bias_filler { | -| 27 | type: "constant" | -| 28 | } | -| 29 | } | -| 30 | } | -| 31 | layer { | -| 32 | name: "pool1" | -| 33 | type: "Pooling" | -| 34 | bottom: "conv1" | -| 35 | top: "pool1" | -| 36 | pooling_param { | -| 37 | pool: MAX | -| 38 | kernel_size: 2 | -| 39 | stride: 2 | -| 40 | } | -| 41 | } | -| 42 | layer { | -| 43 | name: "conv2" | -| 44 | type: "Convolution" | -| 45 | bottom: "pool1" | -| 46 | top: "conv2" | -| 47 | param { | -| 48 | lr_mult: 1 | -| 49 | } | -| 50 | param { | -| 51 | lr_mult: 2 | -| 52 | } | -| 53 | convolution_param { | -| 54 | num_output: 50 | -| 55 | kernel_size: 5 | -| 56 | stride: 1 | -| 57 | weight_filler { | -| 58 | type: "xavier" | -| 59 | } | -| 60 | bias_filler { | -| 61 | type: "constant" | -| 62 | } | -| 63 | } | -| 64 | } | -| 65 | layer { | -| 66 | name: "pool2" | -| 67 | type: "Pooling" | -| 68 | bottom: "conv2" | -| 69 | top: "pool2" | -| 70 | pooling_param { | -| 71 | pool: MAX | -| 72 | kernel_size: 2 | -| 73 | stride: 2 | -| 74 | } | -| 75 | } | -| 76 | layer { | -| 77 | name: "ip1" | -| 78 | type: "InnerProduct" | -| 79 | bottom: "pool2" | -| 80 | top: "ip1" | -| 81 | param { | -| 82 | lr_mult: 1 | -| 83 | } | -| 84 | param { | -| 85 | lr_mult: 2 | -| 86 | } | -| 87 | inner_product_param { | -| 88 | num_output: 500 | -| 89 | weight_filler { | -| 90 | type: "xavier" | -| 91 | } | -| 92 | bias_filler { | -| 93 | type: "constant" | -| 94 | } | -| 95 | } | -| 96 | } | -| 97 | layer { | -| 98 | name: "relu1" | -| 99 | type: "ReLU" | -| 100 | bottom: "ip1" | -| 101 | top: "ip1" | -| 102 | } | -| 103 | layer { | -| 104 | name: "ip2" | -| 105 | type: "InnerProduct" | -| 106 | bottom: "ip1" | -| 107 | top: "ip2" | -| 108 | param { | -| 109 | lr_mult: 1 | -| 110 | } | -| 111 | param { | -| 112 | lr_mult: 2 | -| 113 | } | -| 114 | inner_product_param { | -| 115 | num_output: 10 | -| 116 | weight_filler { | -| 117 | type: "xavier" | -| 118 | } | -| 119 | bias_filler { | -| 120 | type: "constant" | -| 121 | } | -| 122 | } | -| 123 | } | -| 124 | layer { | -| 125 | name: "prob" | -| 126 | type: "Softmax" | -| 127 | bottom: "ip2" | -| 128 | top: "prob" | -| 129 | } | -+-----------------------------------+-----------------------------------------------------------------+ - -Inference Code --------------- - -+-----------------------------------+-----------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from model_service.caffe_model_service import CaffeBaseService | -| 2 | | -| 3 | import numpy as np | -| 4 | | -| 5 | import os, json | -| 6 | | -| 7 | import caffe | -| 8 | | -| 9 | from PIL import Image | -| 10 | | -| 11 | | -| 12 | class LenetService(CaffeBaseService): | -| 13 | | -| 14 | def __init__(self, model_name, model_path): | -| 15 | # Call the inference method of the parent class. | -| 16 | super(LenetService, self).__init__(model_name, model_path) | -| 17 | | -| 18 | # Configure preprocessing information. | -| 19 | transformer = caffe.io.Transformer({'data': self.net.blobs['data'].data.shape}) | -| 20 | # Transform to NCHW. | -| 21 | transformer.set_transpose('data', (2, 0, 1)) | -| 22 | # Perform normalization. | -| 23 | transformer.set_raw_scale('data', 255.0) | -| 24 | | -| 25 | # If the batch size is set to 1, inference is supported for only one image. | -| 26 | self.net.blobs['data'].reshape(1, 1, 28, 28) | -| 27 | self.transformer = transformer | -| 28 | | -| 29 | # Define the class labels. | -| 30 | self.label = [0,1,2,3,4,5,6,7,8,9] | -| 31 | | -| 32 | | -| 33 | def _preprocess(self, data): | -| 34 | | -| 35 | for k, v in data.items(): | -| 36 | for file_name, file_content in v.items(): | -| 37 | im = caffe.io.load_image(file_content, color=False) | -| 38 | # Pre-process the images. | -| 39 | self.net.blobs['data'].data[...] = self.transformer.preprocess('data', im) | -| 40 | | -| 41 | return | -| 42 | | -| 43 | def _postprocess(self, data): | -| 44 | | -| 45 | data = data['prob'][0, :] | -| 46 | predicted = np.argmax(data) | -| 47 | predicted = {"predicted" : str(predicted) } | -| 48 | | -| 49 | return predicted | -+-----------------------------------+-----------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/index.rst b/modelarts/umn/result/examples_of_custom_scripts/index.rst deleted file mode 100644 index 0f3dcbce..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _modelarts_23_0172: - -========================== -Examples of Custom Scripts -========================== - -.. toctree:: - :maxdepth: 1 - - tensorflow - pytorch - caffe - xgboost - pyspark - scikit_learn diff --git a/modelarts/umn/result/examples_of_custom_scripts/pyspark.rst b/modelarts/umn/result/examples_of_custom_scripts/pyspark.rst deleted file mode 100644 index 89b36ff2..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/pyspark.rst +++ /dev/null @@ -1,90 +0,0 @@ -.. _modelarts_23_0178: - -PySpark -======= - -Training and Saving a Model ---------------------------- - -+-----------------------------------+------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from pyspark.ml import Pipeline, PipelineModel | -| 2 | from pyspark.ml.linalg import Vectors | -| 3 | from pyspark.ml.classification import LogisticRegression | -| 4 | | -| 5 | # Prepare training data using tuples. | -| 6 | # Prepare training data from a list of (label, features) tuples. | -| 7 | training = spark.createDataFrame([ | -| 8 | (1.0, Vectors.dense([0.0, 1.1, 0.1])), | -| 9 | (0.0, Vectors.dense([2.0, 1.0, -1.0])), | -| 10 | (0.0, Vectors.dense([2.0, 1.3, 1.0])), | -| 11 | (1.0, Vectors.dense([0.0, 1.2, -0.5]))], ["label", "features"]) | -| 12 | | -| 13 | # Create a training instance. The logistic regression algorithm is used for training. | -| 14 | # Create a LogisticRegression instance. This instance is an Estimator. | -| 15 | lr = LogisticRegression(maxIter=10, regParam=0.01) | -| 16 | | -| 17 | # Train the logistic regression model. | -| 18 | # Learn a LogisticRegression model. This uses the parameters stored in lr. | -| 19 | model = lr.fit(training) | -| 20 | | -| 21 | # Save the model to a local directory. | -| 22 | # Save model to local path. | -| 23 | model.save("/tmp/spark_model") | -+-----------------------------------+------------------------------------------------------------------------------------------+ - -After the model is saved, it must be uploaded to the OBS directory before being published. The **config.json** configuration and **customize_service.py** must be contained during publishing. For details about the definition method, see :ref:`Model Package Specifications `. - -Inference Code --------------- - -+-----------------------------------+------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # coding:utf-8 | -| 2 | import collections | -| 3 | import json | -| 4 | import traceback | -| 5 | | -| 6 | import model_service.log as log | -| 7 | from model_service.spark_model_service import SparkServingBaseService | -| 8 | from pyspark.ml.classification import LogisticRegression | -| 9 | | -| 10 | logger = log.getLogger(__name__) | -| 11 | | -| 12 | | -| 13 | class user_Service(SparkServingBaseService): | -| 14 | # Pre-process data. | -| 15 | def _preprocess(self, data): | -| 16 | logger.info("Begin to handle data from user data...") | -| 17 | # Read data. | -| 18 | req_json = json.loads(data, object_pairs_hook=collections.OrderedDict) | -| 19 | try: | -| 20 | # Convert data to the spark dataframe format. | -| 21 | predict_spdf = self.spark.createDataFrame(pd.DataFrame(req_json["data"]["req_data"])) | -| 22 | except Exception as e: | -| 23 | logger.error("check your request data does meet the requirements ?") | -| 24 | logger.error(traceback.format_exc()) | -| 25 | raise Exception("check your request data does meet the requirements ?") | -| 26 | return predict_spdf | -| 27 | | -| 28 | # Perform model inference. | -| 29 | def _inference(self, data): | -| 30 | try: | -| 31 | # Load a model file. | -| 32 | predict_model = LogisticRegression.load(self.model_path) | -| 33 | # Perform data inference. | -| 34 | prediction_result = predict_model.transform(data) | -| 35 | except Exception as e: | -| 36 | logger.error(traceback.format_exc()) | -| 37 | raise Exception("Unable to load model and do dataframe transformation.") | -| 38 | return prediction_result | -| 39 | | -| 40 | # Post-process data. | -| 41 | def _postprocess(self, pre_data): | -| 42 | logger.info("Get new data to respond...") | -| 43 | predict_str = pre_data.toPandas().to_json(orient='records') | -| 44 | predict_result = json.loads(predict_str) | -| 45 | return predict_result | -+-----------------------------------+------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/pytorch.rst b/modelarts/umn/result/examples_of_custom_scripts/pytorch.rst deleted file mode 100644 index cc01c222..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/pytorch.rst +++ /dev/null @@ -1,210 +0,0 @@ -.. _modelarts_23_0175: - -PyTorch -======= - -Training a Model ----------------- - -+-----------------------------------+------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from __future__ import print_function | -| 2 | import argparse | -| 3 | import torch | -| 4 | import torch.nn as nn | -| 5 | import torch.nn.functional as F | -| 6 | import torch.optim as optim | -| 7 | from torchvision import datasets, transforms | -| 8 | | -| 9 | # Define a network structure. | -| 10 | class Net(nn.Module): | -| 11 | def __init__(self): | -| 12 | super(Net, self).__init__() | -| 13 | # The second dimension of the input must be 784. | -| 14 | self.hidden1 = nn.Linear(784, 5120, bias=False) | -| 15 | self.output = nn.Linear(5120, 10, bias=False) | -| 16 | | -| 17 | def forward(self, x): | -| 18 | x = x.view(x.size()[0], -1) | -| 19 | x = F.relu((self.hidden1(x))) | -| 20 | x = F.dropout(x, 0.2) | -| 21 | x = self.output(x) | -| 22 | return F.log_softmax(x) | -| 23 | | -| 24 | def train(model, device, train_loader, optimizer, epoch): | -| 25 | model.train() | -| 26 | for batch_idx, (data, target) in enumerate(train_loader): | -| 27 | data, target = data.to(device), target.to(device) | -| 28 | optimizer.zero_grad() | -| 29 | output = model(data) | -| 30 | loss = F.cross_entropy(output, target) | -| 31 | loss.backward() | -| 32 | optimizer.step() | -| 33 | if batch_idx % 10 == 0: | -| 34 | print('Train Epoch: {} [{}/{} ({:.0f}%)]\tLoss: {:.6f}'.format( | -| 35 | epoch, batch_idx * len(data), len(train_loader.dataset), | -| 36 | 100. * batch_idx / len(train_loader), loss.item())) | -| 37 | | -| 38 | def test( model, device, test_loader): | -| 39 | model.eval() | -| 40 | test_loss = 0 | -| 41 | correct = 0 | -| 42 | with torch.no_grad(): | -| 43 | for data, target in test_loader: | -| 44 | data, target = data.to(device), target.to(device) | -| 45 | output = model(data) | -| 46 | test_loss += F.nll_loss(output, target, reduction='sum').item() # sum up batch loss | -| 47 | pred = output.argmax(dim=1, keepdim=True) # get the index of the max log-probability | -| 48 | correct += pred.eq(target.view_as(pred)).sum().item() | -| 49 | | -| 50 | test_loss /= len(test_loader.dataset) | -| 51 | | -| 52 | print('\nTest set: Average loss: {:.4f}, Accuracy: {}/{} ({:.0f}%)\n'.format( | -| 53 | test_loss, correct, len(test_loader.dataset), | -| 54 | 100. * correct / len(test_loader.dataset))) | -| 55 | | -| 56 | device = torch.device("cpu") | -| 57 | | -| 58 | batch_size=64 | -| 59 | | -| 60 | kwargs={} | -| 61 | | -| 62 | train_loader = torch.utils.data.DataLoader( | -| 63 | datasets.MNIST('.', train=True, download=True, | -| 64 | transform=transforms.Compose([ | -| 65 | transforms.ToTensor() | -| 66 | ])), | -| 67 | batch_size=batch_size, shuffle=True, **kwargs) | -| 68 | test_loader = torch.utils.data.DataLoader( | -| 69 | datasets.MNIST('.', train=False, transform=transforms.Compose([ | -| 70 | transforms.ToTensor() | -| 71 | ])), | -| 72 | batch_size=1000, shuffle=True, **kwargs) | -| 73 | | -| 74 | model = Net().to(device) | -| 75 | optimizer = optim.SGD(model.parameters(), lr=0.01, momentum=0.5) | -| 76 | optimizer = optim.Adam(model.parameters()) | -| 77 | | -| 78 | for epoch in range(1, 2 + 1): | -| 79 | train(model, device, train_loader, optimizer, epoch) | -| 80 | test(model, device, test_loader) | -+-----------------------------------+------------------------------------------------------------------------------------------------------+ - -Saving a Model --------------- - -+-----------------------------------+-----------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # The model must be saved using state_dict and can be deployed remotely. | -| 2 | torch.save(model.state_dict(), "pytorch_mnist/mnist_mlp.pt") | -+-----------------------------------+-----------------------------------------------------------------------------+ - -Inference Code --------------- - -+-----------------------------------+----------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from PIL import Image | -| 2 | import log | -| 3 | from model_service.pytorch_model_service import PTServingBaseService | -| 4 | import torch.nn.functional as F | -| 5 | | -| 6 | import torch.nn as nn | -| 7 | import torch | -| 8 | import json | -| 9 | | -| 10 | import numpy as np | -| 11 | | -| 12 | logger = log.getLogger(__name__) | -| 13 | | -| 14 | import torchvision.transforms as transforms | -| 15 | | -| 16 | # Define model preprocessing. | -| 17 | infer_transformation = transforms.Compose([ | -| 18 | transforms.Resize((28,28)), | -| 19 | # Transform to a PyTorch tensor. | -| 20 | transforms.ToTensor() | -| 21 | ]) | -| 22 | | -| 23 | | -| 24 | import os | -| 25 | | -| 26 | | -| 27 | class PTVisionService(PTServingBaseService): | -| 28 | | -| 29 | def __init__(self, model_name, model_path): | -| 30 | # Call the constructor of the parent class. | -| 31 | super(PTVisionService, self).__init__(model_name, model_path) | -| 32 | # Call the customized function to load the model. | -| 33 | self.model = Mnist(model_path) | -| 34 | # Load tags. | -| 35 | self.label = [0,1,2,3,4,5,6,7,8,9] | -| 36 | # Labels can also be loaded by label file. | -| 37 | # Store the label.json file in the model directory. The following information is read: | -| 38 | dir_path = os.path.dirname(os.path.realpath(self.model_path)) | -| 39 | with open(os.path.join(dir_path, 'label.json')) as f: | -| 40 | self.label = json.load(f) | -| 41 | | -| 42 | | -| 43 | def _preprocess(self, data): | -| 44 | | -| 45 | preprocessed_data = {} | -| 46 | for k, v in data.items(): | -| 47 | input_batch = [] | -| 48 | for file_name, file_content in v.items(): | -| 49 | with Image.open(file_content) as image1: | -| 50 | # Gray processing | -| 51 | image1 = image1.convert("L") | -| 52 | if torch.cuda.is_available(): | -| 53 | input_batch.append(infer_transformation(image1).cuda()) | -| 54 | else: | -| 55 | input_batch.append(infer_transformation(image1)) | -| 56 | input_batch_var = torch.autograd.Variable(torch.stack(input_batch, dim=0), volatile=True) | -| 57 | print(input_batch_var.shape) | -| 58 | preprocessed_data[k] = input_batch_var | -| 59 | | -| 60 | return preprocessed_data | -| 61 | | -| 62 | def _postprocess(self, data): | -| 63 | results = [] | -| 64 | for k, v in data.items(): | -| 65 | result = torch.argmax(v[0]) | -| 66 | result = {k: self.label[result]} | -| 67 | results.append(result) | -| 68 | return results | -| 69 | | -| 70 | class Net(nn.Module): | -| 71 | def __init__(self): | -| 72 | super(Net, self).__init__() | -| 73 | self.hidden1 = nn.Linear(784, 5120, bias=False) | -| 74 | self.output = nn.Linear(5120, 10, bias=False) | -| 75 | | -| 76 | def forward(self, x): | -| 77 | x = x.view(x.size()[0], -1) | -| 78 | x = F.relu((self.hidden1(x))) | -| 79 | x = F.dropout(x, 0.2) | -| 80 | x = self.output(x) | -| 81 | return F.log_softmax(x) | -| 82 | | -| 83 | | -| 84 | | -| 85 | def Mnist(model_path, **kwargs): | -| 86 | # Generate a network. | -| 87 | model = Net() | -| 88 | # Load the model. | -| 89 | if torch.cuda.is_available(): | -| 90 | device = torch.device('cuda') | -| 91 | model.load_state_dict(torch.load(model_path, map_location="cuda:0")) | -| 92 | else: | -| 93 | device = torch.device('cpu') | -| 94 | model.load_state_dict(torch.load(model_path, map_location=device)) | -| 95 | # CPU or GPU mapping | -| 96 | model.to(device) | -| 97 | # Declare an inference mode. | -| 98 | model.eval() | -| 99 | | -| 100 | return model | -+-----------------------------------+----------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/scikit_learn.rst b/modelarts/umn/result/examples_of_custom_scripts/scikit_learn.rst deleted file mode 100644 index 04b68533..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/scikit_learn.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. _modelarts_23_0179: - -Scikit Learn -============ - -Training and Saving a Model ---------------------------- - -+-----------------------------------+----------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | import json | -| 2 | import pandas as pd | -| 3 | from sklearn.datasets import load_iris | -| 4 | from sklearn.model_selection import train_test_split | -| 5 | from sklearn.linear_model import LogisticRegression | -| 6 | from sklearn.externals import joblib | -| 7 | iris = pd.read_csv('/data/iris.csv') | -| 8 | X = iris.drop(['virginica'],axis=1) | -| 9 | y = iris[['virginica']] | -| 10 | # Create a LogisticRegression instance and train model | -| 11 | logisticRegression = LogisticRegression(C=1000.0, random_state=0) | -| 12 | logisticRegression.fit(X,y) | -| 13 | # Save model to local path | -| 14 | joblib.dump(logisticRegression, '/tmp/sklearn.m') | -+-----------------------------------+----------------------------------------------------------------------+ - -After the model is saved, it must be uploaded to the OBS directory before being published. The **config.json** and **customize_service.py** files must be contained during publishing. For details about the definition method, see :ref:`Model Package Specifications `. - -Inference Code --------------- - -+-----------------------------------+------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # coding:utf-8 | -| 2 | import collections | -| 3 | import json | -| 4 | from sklearn.externals import joblib | -| 5 | from model_service.python_model_service import XgSklServingBaseService | -| 6 | | -| 7 | class user_Service(XgSklServingBaseService): | -| 8 | | -| 9 | # request data preprocess | -| 10 | def _preprocess(self, data): | -| 11 | list_data = [] | -| 12 | json_data = json.loads(data, object_pairs_hook=collections.OrderedDict) | -| 13 | for element in json_data["data"]["req_data"]: | -| 14 | array = [] | -| 15 | for each in element: | -| 16 | array.append(element[each]) | -| 17 | list_data.append(array) | -| 18 | return list_data | -| 19 | | -| 20 | # predict | -| 21 | def _inference(self, data): | -| 22 | sk_model = joblib.load(self.model_path) | -| 23 | pre_result = sk_model.predict(data) | -| 24 | pre_result = pre_result.tolist() | -| 25 | return pre_result | -| 26 | | -| 27 | # predict result process | -| 28 | def _postprocess(self,data): | -| 29 | resp_data = [] | -| 30 | for element in data: | -| 31 | resp_data.append({"predictresult": element}) | -| 32 | return resp_data | -+-----------------------------------+------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/tensorflow.rst b/modelarts/umn/result/examples_of_custom_scripts/tensorflow.rst deleted file mode 100644 index 85a26be4..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/tensorflow.rst +++ /dev/null @@ -1,405 +0,0 @@ -.. _modelarts_23_0173: - -TensorFlow -========== - -TensorFlow has two types of APIs: Keras and tf. Keras and tf use different code for training and saving models, but the same code for inference. - -Training a Model (Keras API) ----------------------------- - -+-----------------------------------+-----------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from keras.models import Sequential | -| 2 | model = Sequential() | -| 3 | from keras.layers import Dense | -| 4 | import tensorflow as tf | -| 5 | | -| 6 | # Import a training dataset. | -| 7 | mnist = tf.keras.datasets.mnist | -| 8 | (x_train, y_train),(x_test, y_test) = mnist.load_data() | -| 9 | x_train, x_test = x_train / 255.0, x_test / 255.0 | -| 10 | | -| 11 | print(x_train.shape) | -| 12 | | -| 13 | from keras.layers import Dense | -| 14 | from keras.models import Sequential | -| 15 | import keras | -| 16 | from keras.layers import Dense, Activation, Flatten, Dropout | -| 17 | | -| 18 | # Define a model network. | -| 19 | model = Sequential() | -| 20 | model.add(Flatten(input_shape=(28,28))) | -| 21 | model.add(Dense(units=5120,activation='relu')) | -| 22 | model.add(Dropout(0.2)) | -| 23 | | -| 24 | model.add(Dense(units=10, activation='softmax')) | -| 25 | | -| 26 | # Define an optimizer and loss functions. | -| 27 | model.compile(optimizer='adam', | -| 28 | loss='sparse_categorical_crossentropy', | -| 29 | metrics=['accuracy']) | -| 30 | | -| 31 | model.summary() | -| 32 | # Train the model. | -| 33 | model.fit(x_train, y_train, epochs=2) | -| 34 | # Evaluate the model. | -| 35 | model.evaluate(x_test, y_test) | -+-----------------------------------+-----------------------------------------------------------------+ - -Saving a Model (Keras API) --------------------------- - -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from keras import backend as K | -| 2 | | -| 3 | # K.get_session().run(tf.global_variables_initializer()) | -| 4 | | -| 5 | # Define the inputs and outputs of the prediction API. | -| 6 | # The key values of the inputs and outputs dictionaries are used as the index keys for the input and output tensors of the model. | -| 7 | # The input and output definitions of the model must match the custom inference script. | -| 8 | predict_signature = tf.saved_model.signature_def_utils.predict_signature_def( | -| 9 | inputs={"images" : model.input}, | -| 10 | outputs={"scores" : model.output} | -| 11 | ) | -| 12 | | -| 13 | # Define a save path. | -| 14 | builder = tf.saved_model.builder.SavedModelBuilder('./mnist_keras/') | -| 15 | | -| 16 | builder.add_meta_graph_and_variables( | -| 17 | | -| 18 | sess = K.get_session(), | -| 19 | # The tf.saved_model.tag_constants.SERVING tag needs to be defined for inference and deployment. | -| 20 | tags=[tf.saved_model.tag_constants.SERVING], | -| 21 | """ | -| 22 | signature_def_map: Only single items can exist, or the corresponding key needs to be defined as follows: | -| 23 | tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY | -| 24 | """ | -| 25 | signature_def_map={ | -| 26 | tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY: | -| 27 | predict_signature | -| 28 | } | -| 29 | | -| 30 | ) | -| 31 | builder.save() | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - -Training a Model (tf API) -------------------------- - -+-----------------------------------+--------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from __future__ import print_function | -| 2 | | -| 3 | import gzip | -| 4 | import os | -| 5 | import urllib | -| 6 | | -| 7 | import numpy | -| 8 | import tensorflow as tf | -| 9 | from six.moves import urllib | -| 10 | | -| 11 | # Training data is obtained from the Yann LeCun official website http://yann.lecun.com/exdb/mnist/. | -| 12 | SOURCE_URL = 'http://yann.lecun.com/exdb/mnist/' | -| 13 | TRAIN_IMAGES = 'train-images-idx3-ubyte.gz' | -| 14 | TRAIN_LABELS = 'train-labels-idx1-ubyte.gz' | -| 15 | TEST_IMAGES = 't10k-images-idx3-ubyte.gz' | -| 16 | TEST_LABELS = 't10k-labels-idx1-ubyte.gz' | -| 17 | VALIDATION_SIZE = 5000 | -| 18 | | -| 19 | | -| 20 | def maybe_download(filename, work_directory): | -| 21 | """Download the data from Yann's website, unless it's already here.""" | -| 22 | if not os.path.exists(work_directory): | -| 23 | os.mkdir(work_directory) | -| 24 | filepath = os.path.join(work_directory, filename) | -| 25 | if not os.path.exists(filepath): | -| 26 | filepath, _ = urllib.request.urlretrieve(SOURCE_URL + filename, filepath) | -| 27 | statinfo = os.stat(filepath) | -| 28 | print('Successfully downloaded %s %d bytes.' % (filename, statinfo.st_size)) | -| 29 | return filepath | -| 30 | | -| 31 | | -| 32 | def _read32(bytestream): | -| 33 | dt = numpy.dtype(numpy.uint32).newbyteorder('>') | -| 34 | return numpy.frombuffer(bytestream.read(4), dtype=dt)[0] | -| 35 | | -| 36 | | -| 37 | def extract_images(filename): | -| 38 | """Extract the images into a 4D uint8 numpy array [index, y, x, depth].""" | -| 39 | print('Extracting %s' % filename) | -| 40 | with gzip.open(filename) as bytestream: | -| 41 | magic = _read32(bytestream) | -| 42 | if magic != 2051: | -| 43 | raise ValueError( | -| 44 | 'Invalid magic number %d in MNIST image file: %s' % | -| 45 | (magic, filename)) | -| 46 | num_images = _read32(bytestream) | -| 47 | rows = _read32(bytestream) | -| 48 | cols = _read32(bytestream) | -| 49 | buf = bytestream.read(rows * cols * num_images) | -| 50 | data = numpy.frombuffer(buf, dtype=numpy.uint8) | -| 51 | data = data.reshape(num_images, rows, cols, 1) | -| 52 | return data | -| 53 | | -| 54 | | -| 55 | def dense_to_one_hot(labels_dense, num_classes=10): | -| 56 | """Convert class labels from scalars to one-hot vectors.""" | -| 57 | num_labels = labels_dense.shape[0] | -| 58 | index_offset = numpy.arange(num_labels) * num_classes | -| 59 | labels_one_hot = numpy.zeros((num_labels, num_classes)) | -| 60 | labels_one_hot.flat[index_offset + labels_dense.ravel()] = 1 | -| 61 | return labels_one_hot | -| 62 | | -| 63 | | -| 64 | def extract_labels(filename, one_hot=False): | -| 65 | """Extract the labels into a 1D uint8 numpy array [index].""" | -| 66 | print('Extracting %s' % filename) | -| 67 | with gzip.open(filename) as bytestream: | -| 68 | magic = _read32(bytestream) | -| 69 | if magic != 2049: | -| 70 | raise ValueError( | -| 71 | 'Invalid magic number %d in MNIST label file: %s' % | -| 72 | (magic, filename)) | -| 73 | num_items = _read32(bytestream) | -| 74 | buf = bytestream.read(num_items) | -| 75 | labels = numpy.frombuffer(buf, dtype=numpy.uint8) | -| 76 | if one_hot: | -| 77 | return dense_to_one_hot(labels) | -| 78 | return labels | -| 79 | | -| 80 | | -| 81 | class DataSet(object): | -| 82 | """Class encompassing test, validation and training MNIST data set.""" | -| 83 | | -| 84 | def __init__(self, images, labels, fake_data=False, one_hot=False): | -| 85 | """Construct a DataSet. one_hot arg is used only if fake_data is true.""" | -| 86 | | -| 87 | if fake_data: | -| 88 | self._num_examples = 10000 | -| 89 | self.one_hot = one_hot | -| 90 | else: | -| 91 | assert images.shape[0] == labels.shape[0], ( | -| 92 | 'images.shape: %s labels.shape: %s' % (images.shape, | -| 93 | labels.shape)) | -| 94 | self._num_examples = images.shape[0] | -| 95 | | -| 96 | # Convert shape from [num examples, rows, columns, depth] | -| 97 | # to [num examples, rows*columns] (assuming depth == 1) | -| 98 | assert images.shape[3] == 1 | -| 99 | images = images.reshape(images.shape[0], | -| 100 | images.shape[1] * images.shape[2]) | -| 101 | # Convert from [0, 255] -> [0.0, 1.0]. | -| 102 | images = images.astype(numpy.float32) | -| 103 | images = numpy.multiply(images, 1.0 / 255.0) | -| 104 | self._images = images | -| 105 | self._labels = labels | -| 106 | self._epochs_completed = 0 | -| 107 | self._index_in_epoch = 0 | -| 108 | | -| 109 | @property | -| 110 | def images(self): | -| 111 | return self._images | -| 112 | | -| 113 | @property | -| 114 | def labels(self): | -| 115 | return self._labels | -| 116 | | -| 117 | @property | -| 118 | def num_examples(self): | -| 119 | return self._num_examples | -| 120 | | -| 121 | @property | -| 122 | def epochs_completed(self): | -| 123 | return self._epochs_completed | -| 124 | | -| 125 | def next_batch(self, batch_size, fake_data=False): | -| 126 | """Return the next `batch_size` examples from this data set.""" | -| 127 | if fake_data: | -| 128 | fake_image = [1] * 784 | -| 129 | if self.one_hot: | -| 130 | fake_label = [1] + [0] * 9 | -| 131 | else: | -| 132 | fake_label = 0 | -| 133 | return [fake_image for _ in range(batch_size)], [ | -| 134 | fake_label for _ in range(batch_size) | -| 135 | ] | -| 136 | start = self._index_in_epoch | -| 137 | self._index_in_epoch += batch_size | -| 138 | if self._index_in_epoch > self._num_examples: | -| 139 | # Finished epoch | -| 140 | self._epochs_completed += 1 | -| 141 | # Shuffle the data | -| 142 | perm = numpy.arange(self._num_examples) | -| 143 | numpy.random.shuffle(perm) | -| 144 | self._images = self._images[perm] | -| 145 | self._labels = self._labels[perm] | -| 146 | # Start next epoch | -| 147 | start = 0 | -| 148 | self._index_in_epoch = batch_size | -| 149 | assert batch_size <= self._num_examples | -| 150 | end = self._index_in_epoch | -| 151 | return self._images[start:end], self._labels[start:end] | -| 152 | | -| 153 | | -| 154 | def read_data_sets(train_dir, fake_data=False, one_hot=False): | -| 155 | """Return training, validation and testing data sets.""" | -| 156 | | -| 157 | class DataSets(object): | -| 158 | pass | -| 159 | | -| 160 | data_sets = DataSets() | -| 161 | | -| 162 | if fake_data: | -| 163 | data_sets.train = DataSet([], [], fake_data=True, one_hot=one_hot) | -| 164 | data_sets.validation = DataSet([], [], fake_data=True, one_hot=one_hot) | -| 165 | data_sets.test = DataSet([], [], fake_data=True, one_hot=one_hot) | -| 166 | return data_sets | -| 167 | | -| 168 | local_file = maybe_download(TRAIN_IMAGES, train_dir) | -| 169 | train_images = extract_images(local_file) | -| 170 | | -| 171 | local_file = maybe_download(TRAIN_LABELS, train_dir) | -| 172 | train_labels = extract_labels(local_file, one_hot=one_hot) | -| 173 | | -| 174 | local_file = maybe_download(TEST_IMAGES, train_dir) | -| 175 | test_images = extract_images(local_file) | -| 176 | | -| 177 | local_file = maybe_download(TEST_LABELS, train_dir) | -| 178 | test_labels = extract_labels(local_file, one_hot=one_hot) | -| 179 | | -| 180 | validation_images = train_images[:VALIDATION_SIZE] | -| 181 | validation_labels = train_labels[:VALIDATION_SIZE] | -| 182 | train_images = train_images[VALIDATION_SIZE:] | -| 183 | train_labels = train_labels[VALIDATION_SIZE:] | -| 184 | | -| 185 | data_sets.train = DataSet(train_images, train_labels) | -| 186 | data_sets.validation = DataSet(validation_images, validation_labels) | -| 187 | data_sets.test = DataSet(test_images, test_labels) | -| 188 | return data_sets | -| 189 | | -| 190 | training_iteration = 1000 | -| 191 | | -| 192 | modelarts_example_path = './modelarts-mnist-train-save-deploy-example' | -| 193 | | -| 194 | export_path = modelarts_example_path + '/model/' | -| 195 | data_path = './' | -| 196 | | -| 197 | print('Training model...') | -| 198 | mnist = read_data_sets(data_path, one_hot=True) | -| 199 | sess = tf.InteractiveSession() | -| 200 | serialized_tf_example = tf.placeholder(tf.string, name='tf_example') | -| 201 | feature_configs = {'x': tf.FixedLenFeature(shape=[784], dtype=tf.float32), } | -| 202 | tf_example = tf.parse_example(serialized_tf_example, feature_configs) | -| 203 | x = tf.identity(tf_example['x'], name='x') # use tf.identity() to assign name | -| 204 | y_ = tf.placeholder('float', shape=[None, 10]) | -| 205 | w = tf.Variable(tf.zeros([784, 10])) | -| 206 | b = tf.Variable(tf.zeros([10])) | -| 207 | sess.run(tf.global_variables_initializer()) | -| 208 | y = tf.nn.softmax(tf.matmul(x, w) + b, name='y') | -| 209 | cross_entropy = -tf.reduce_sum(y_ * tf.log(y)) | -| 210 | train_step = tf.train.GradientDescentOptimizer(0.01).minimize(cross_entropy) | -| 211 | values, indices = tf.nn.top_k(y, 10) | -| 212 | table = tf.contrib.lookup.index_to_string_table_from_tensor( | -| 213 | tf.constant([str(i) for i in range(10)])) | -| 214 | prediction_classes = table.lookup(tf.to_int64(indices)) | -| 215 | for _ in range(training_iteration): | -| 216 | batch = mnist.train.next_batch(50) | -| 217 | train_step.run(feed_dict={x: batch[0], y_: batch[1]}) | -| 218 | correct_prediction = tf.equal(tf.argmax(y, 1), tf.argmax(y_, 1)) | -| 219 | accuracy = tf.reduce_mean(tf.cast(correct_prediction, 'float')) | -| 220 | print('training accuracy %g' % sess.run( | -| 221 | accuracy, feed_dict={ | -| 222 | x: mnist.test.images, | -| 223 | y_: mnist.test.labels | -| 224 | })) | -| 225 | print('Done training!') | -+-----------------------------------+--------------------------------------------------------------------------------------------------------+ - -Saving a Model (tf API) ------------------------ - -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # Export the model. | -| 2 | # The model needs to be saved using the saved_model API. | -| 3 | print('Exporting trained model to', export_path) | -| 4 | builder = tf.saved_model.builder.SavedModelBuilder(export_path) | -| 5 | | -| 6 | tensor_info_x = tf.saved_model.utils.build_tensor_info(x) | -| 7 | tensor_info_y = tf.saved_model.utils.build_tensor_info(y) | -| 8 | | -| 9 | # Define the inputs and outputs of the prediction API. | -| 10 | # The key values of the inputs and outputs dictionaries are used as the index keys for the input and output tensors of the model. | -| 11 | # The input and output definitions of the model must match the custom inference script. | -| 12 | prediction_signature = ( | -| 13 | tf.saved_model.signature_def_utils.build_signature_def( | -| 14 | inputs={'images': tensor_info_x}, | -| 15 | outputs={'scores': tensor_info_y}, | -| 16 | method_name=tf.saved_model.signature_constants.PREDICT_METHOD_NAME)) | -| 17 | | -| 18 | legacy_init_op = tf.group(tf.tables_initializer(), name='legacy_init_op') | -| 19 | builder.add_meta_graph_and_variables( | -| 20 | # Set tag to serve/tf.saved_model.tag_constants.SERVING. | -| 21 | sess, [tf.saved_model.tag_constants.SERVING], | -| 22 | signature_def_map={ | -| 23 | 'predict_images': | -| 24 | prediction_signature, | -| 25 | }, | -| 26 | legacy_init_op=legacy_init_op) | -| 27 | | -| 28 | builder.save() | -| 29 | | -| 30 | print('Done exporting!') | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+ - -Inference Code (Keras and tf APIs) ----------------------------------- - -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | from PIL import Image | -| 2 | import numpy as np | -| 3 | from model_service.tfserving_model_service import TfServingBaseService | -| 4 | | -| 5 | | -| 6 | class mnist_service(TfServingBaseService): | -| 7 | | -| 8 | # Match the model input with the user's HTTPS API input during preprocessing. | -| 9 | # The model input corresponding to the preceding training part is {"images":}. | -| 10 | def _preprocess(self, data): | -| 11 | | -| 12 | preprocessed_data = {} | -| 13 | images = [] | -| 14 | # Iterate the input data. | -| 15 | for k, v in data.items(): | -| 16 | for file_name, file_content in v.items(): | -| 17 | image1 = Image.open(file_content) | -| 18 | image1 = np.array(image1, dtype=np.float32) | -| 19 | image1.resize((1,784)) | -| 20 | images.append(image1) | -| 21 | # Return the numpy array. | -| 22 | images = np.array(images,dtype=np.float32) | -| 23 | # Perform batch processing on multiple input samples and ensure that the shape is the same as that inputted during training. | -| 24 | images.resize((len(data), 784)) | -| 25 | preprocessed_data['images'] = images | -| 26 | return preprocessed_data | -| 27 | | -| 28 | # Processing logic of the inference for invoking the parent class. | -| 29 | | -| 30 | # The output corresponding to model saving in the preceding training part is {"scores":}. | -| 31 | # Postprocess the HTTPS output. | -| 32 | def _postprocess(self, data): | -| 33 | infer_output = {"mnist_result": []} | -| 34 | # Iterate the model output. | -| 35 | for output_name, results in data.items(): | -| 36 | for result in results: | -| 37 | infer_output["mnist_result"].append(result.index(max(result))) | -| 38 | return infer_output | -+-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/examples_of_custom_scripts/xgboost.rst b/modelarts/umn/result/examples_of_custom_scripts/xgboost.rst deleted file mode 100644 index c104da35..00000000 --- a/modelarts/umn/result/examples_of_custom_scripts/xgboost.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _modelarts_23_0177: - -XGBoost -======= - -Training and Saving a Model ---------------------------- - -+-----------------------------------+---------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | import pandas as pd | -| 2 | import xgboost as xgb | -| 3 | from sklearn.model_selection import train_test_split | -| 4 | | -| 5 | # Prepare training data and setting parameters | -| 6 | iris = pd.read_csv('/data/iris.csv') | -| 7 | X = iris.drop(['virginica'],axis=1) | -| 8 | y = iris[['virginica']] | -| 9 | X_train, X_test, y_train, y_test = train_test_split(X, y, test_size=0.2, random_state=1234565) | -| 10 | params = { | -| 11 | 'booster': 'gbtree', | -| 12 | 'objective': 'multi:softmax', | -| 13 | 'num_class': 3, | -| 14 | 'gamma': 0.1, | -| 15 | 'max_depth': 6, | -| 16 | 'lambda': 2, | -| 17 | 'subsample': 0.7, | -| 18 | 'colsample_bytree': 0.7, | -| 19 | 'min_child_weight': 3, | -| 20 | 'silent': 1, | -| 21 | 'eta': 0.1, | -| 22 | 'seed': 1000, | -| 23 | 'nthread': 4, | -| 24 | } | -| 25 | plst = params.items() | -| 26 | dtrain = xgb.DMatrix(X_train, y_train) | -| 27 | num_rounds = 500 | -| 28 | model = xgb.train(plst, dtrain, num_rounds) | -| 29 | model.save_model('/tmp/xgboost.m') | -+-----------------------------------+---------------------------------------------------------------------------------------------------+ - -After the model is saved, it must be uploaded to the OBS directory before being published. The **config.json** and **customize_service.py** files must be contained during publishing. For details about the definition method, see :ref:`Model Package Specifications `. - -Inference Code --------------- - -.. code-block:: - - # coding:utf-8 - import collections - import json - import xgboost as xgb - from model_service.python_model_service import XgSklServingBaseService - class user_Service(XgSklServingBaseService): - - # request data preprocess - def _preprocess(self, data): - list_data = [] - json_data = json.loads(data, object_pairs_hook=collections.OrderedDict) - for element in json_data["data"]["req_data"]: - array = [] - for each in element: - array.append(element[each]) - list_data.append(array) - return list_data - - # predict - def _inference(self, data): - xg_model = xgb.Booster(model_file=self.model_path) - pre_data = xgb.DMatrix(data) - pre_result = xg_model.predict(pre_data) - pre_result = pre_result.tolist() - return pre_result - - # predict result process - def _postprocess(self,data): - resp_data = [] - for element in data: - resp_data.append({"predictresult": element}) - return resp_data diff --git a/modelarts/umn/result/exeml/image_classification/creating_a_project.rst b/modelarts/umn/result/exeml/image_classification/creating_a_project.rst deleted file mode 100644 index a14e197c..00000000 --- a/modelarts/umn/result/exeml/image_classification/creating_a_project.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _modelarts_21_0004: - -Creating a Project -================== - -ModelArts ExeML supports image classification and object detection projects. You can create any of them based on your needs. Perform the following operations to create an ExeML project. - -Procedure ---------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **ExeML**. The **ExeML** page is displayed. - -#. Click **Create Project** in the box of your desired project. The page for creating an ExeML project is displayed. - -#. On the displayed page, set the parameters by referring to :ref:`Table 1 `. - - .. _modelarts_21_0004__en-us_topic_0284258833_en-us_topic_0169446153_table14961618163816: - - .. table:: **Table 1** Parameters - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==============================================================================================================================================================================================================================================================================================+ - | Name | Name of an ExeML project | - | | | - | | - Enter a maximum of 20 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. This parameter is mandatory. | - | | - The name must start with a letter. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of a project | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Dataset Source | You can create a dataset or specify an existing dataset. | - | | | - | | - **Create**: Configure parameters such as **Dataset Name**, **Input Dataset Path**, **Output Dataset Path**, and **Label Set**. | - | | - **Specify**: Select a dataset of the same type from ModelArts Data Management to create an ExeML project. Only datasets of the same type are displayed in the **Dataset Name** drop-down list. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Dataset Name | If you select **Create** for **Dataset Source**, enter a dataset name based on required rules in the text box on the right. If you select **Specify** for **Dataset Source**, select one from available datasets of the same type under the current account displayed in the drop-down list. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input Dataset Path | Select the OBS path to the input dataset. For details about dataset input specifications, see :ref:`Preparing Data `. | - | | | - | | - Except the files and folders described in **Preparing Data > Requirements for Files Uploaded to OBS**, no other files or folders can be saved in the training data path. Otherwise, an error will be reported. | - | | - Do not modify the files in the training data path. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path for storing the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. It is a good practice to select an empty directory in **Output Dataset Path**. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set | - **Label Name**: Enter a label name. The label name can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-), which contains 1 to 32 characters. | - | | | - | | - **Add Label**: Click **Add Label** to add one or more labels. | - | | | - | | - Set the label color: You need to set label colors for object detection datasets, but you do not need to set label colors for image classification datasets. Select a color from the color palette on the right of a label, or enter the hexadecimal color code to set the color. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. Click **Create Project**. The system displays a message indicating that the project has been created. Then, the **Label Data** tab page is displayed. Alternatively, view the created project on the **ExeML** page and click the project name to go to the **Label Data** page. diff --git a/modelarts/umn/result/exeml/image_classification/deploying_a_model_as_a_service.rst b/modelarts/umn/result/exeml/image_classification/deploying_a_model_as_a_service.rst deleted file mode 100644 index 2c234975..00000000 --- a/modelarts/umn/result/exeml/image_classification/deploying_a_model_as_a_service.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _modelarts_21_0007: - -Deploying a Model as a Service -============================== - -Deploying a Model ------------------ - -You can deploy a model as a real-time service that provides a real-time test UI and monitoring capabilities. After model training is complete, you can deploy a version with the ideal accuracy and in the **Successful** status as a service. The procedure is as follows: - -#. On the **Train Model** tab page, wait until the training status changes to **Successful**. Click **Deploy** in the **Version Manager** pane to deploy the model as a real-time service. - -#. In the **Deploy** dialog box, select resource flavor, set the **Auto Stop** function, and click **OK** to start the deployment. - - - **Specifications**: The GPU specifications are better, and the CPU specifications are more cost-effective. - - **Compute Nodes**: The default value is **1** and cannot be changed. - - **Auto Stop**: After this function is enabled and the auto stop time is set, a service automatically stops at the specified time. - - The options are **1 hour later**, **2 hours later**, **4 hours later**, **6 hours later**, and **Custom**. If you select **Custom**, you can enter any integer from 1 to 24 hours in the text box on the right. - -#. After the model deployment is started, view the deployment status on the **Service Deployment** page. - - It takes a certain period of time to deploy a model. When the status in the **Version Manager** pane changes from **Deploying** to **Running**, the deployment is complete. - - .. note:: - - On the **ExeML** page, trained models can only be deployed as real-time services. For details about how to deploy them as batch services, see :ref:`Where Are Models Generated by ExeML Stored? What Other Operations Are Supported? ` - -Testing a Service ------------------ - -- On the **Service Deployment** page, select a service type. For example, on the ExeML page, the image classification model is deployed as a real-time service by default. On the **Real-Time Services** page, click **Prediction** in the **Operation** column of the target service to perform a service test. For details, see "Testing a Service". -- You can also use code to test a service. For details, see "Accessing a Real-Time Service". -- The following describes the procedure for performing a service test after the image classification model is deployed as a service on the ExeML page. - - #. After the model is deployed, test the service using an image. On the **ExeML** page, click the target project, go to the **Deploy Service** tab page, select the service version in the **Running** status, click **Upload** in the service test area, and upload a local image to perform the test. - - #. Click **Prediction** to conduct the test. After the prediction is complete, label **sunflowers** and its detection score are displayed in the prediction result area on the right. If the model accuracy does not meet your expectation, add images on the **Label Data** tab page, label the images, and train and deploy the model again. :ref:`Table 1 ` describes the parameters in the prediction result. If you are satisfied with the model prediction result, call the API to access the real-time service as prompted. For details, see Accessing a Real-Time Service. - - Currently, only JPG, JPEG, BMP, and PNG images are supported. - - .. _modelarts_21_0007__en-us_topic_0284258836_en-us_topic_0169446156_table27341946101510: - - .. table:: **Table 1** Parameters in the prediction result - - ============= ===================================== - Parameter Description - ============= ===================================== - predict_label Image prediction label - scores Prediction confidence of top 5 labels - ============= ===================================== - - .. note:: - - A running real-time service keeps consuming resources. If you do not need to use the real-time service, click **Stop** in the **Version Manager** pane to stop the service. If you want to use the service again, click **Start**. diff --git a/modelarts/umn/result/exeml/image_classification/index.rst b/modelarts/umn/result/exeml/image_classification/index.rst deleted file mode 100644 index 7d06f205..00000000 --- a/modelarts/umn/result/exeml/image_classification/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_21_0002: - -==================== -Image Classification -==================== - -.. toctree:: - :maxdepth: 1 - - preparing_data - creating_a_project - labeling_data - training_a_model - deploying_a_model_as_a_service diff --git a/modelarts/umn/result/exeml/image_classification/labeling_data.rst b/modelarts/umn/result/exeml/image_classification/labeling_data.rst deleted file mode 100644 index e2432c98..00000000 --- a/modelarts/umn/result/exeml/image_classification/labeling_data.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _modelarts_21_0005: - -Labeling Data -============= - -Model training requires a large number of labeled images. Therefore, before model training, add labels to the images that are not labeled. ModelArts allows you to add labels in batches by one click. You can also modify or delete labels that have been added to images. Prepare at least two classes of images for training. Each class contains at least five images. To achieve better effect, prepare at least 50 images for each class. If the image classes are similar, more images are required. - -Labeling Images ---------------- - -#. On the **Label Data** tab page, click the **Unlabeled** tab. All unlabeled images are displayed. Select the images to be labeled in sequence, or tick **Select Current Page** to select all images on the page, and then add labels to the images in the right pane. -#. After selecting an image, input a label in the **Label** text box, or select an existing label from the drop-down list. Click **OK**. The selected image is labeled. For example, you can select multiple images containing tulips and add label **tulips** to them. Then select other unlabeled images and label them as **sunflowers** and **roses**. After the labeling is complete, the images are saved on the **Labeled** tab page. - - a. You can add multiple labels to an image. - b. A label name can contain a maximum of 32 characters, including Chinese characters, letters, digits, hyphens (-), and underscores (_). - -#. After all the images are labeled, view them on the **Labeled** tab page or view **All Labels** in the right pane to check the name and quantity of the labels. - -Synchronizing or Adding Images ------------------------------- - -On the **ExeML** page, click the project name. The **Label Data** tab page is displayed. When creating a project, you can add images from a local PC or synchronize image data from OBS. - -- **Add Image**: You can quickly add images on a local PC to ModelArts and synchronize the images to the OBS path specified during project creation. Click **Add Image**. In the dialog box that is displayed, click **Add Image** and add images. The total size of all images uploaded in one attempt cannot exceed 8 MB. The size of a single image cannot exceed 5 MB. -- **Synchronize Data Source**: You can upload images to the OBS directory specified during project creation and click **Synchronize Data Source** to quickly add the images in the OBS directory to ModelArts. -- **Delete Image**: You can delete images one by one, or tick **Select Current Page** to delete all images on the page. - - .. note:: - - The deleted images cannot be recovered. Exercise caution when performing this operation. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify the labeled data on the **Labeled** tab page. - -- **Modifying based on images** - - On the data labeling page, click the **Labeled** tab, and select one or more images to be modified from the image list. Modify the image information in the label information area on the right. - - - Adding a label: In the **Label** text box, select an existing label, or enter a new label name and click **OK** to add the label to the selected image. - - Modifying a label: In the **File Labels** area, click the editing icon in the **Operation** column, enter the correct label name in the text box, and click the check mark icon to complete the modification. - - Deleting a label: In the **Labels of Selected Image** area, click |image1| in the **Operation** column to delete the label. - -- **Modifying based on labels** - - On the dataset labeling page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Modifying a label: Click the editing icon in the **Operation** column. In the dialog box that is displayed, enter the new label name and click **OK**. After the modification, the images that have been added with the label use the new label name. - - Deleting a label: Click the deletion icon in the **Operation** column. In the displayed dialog box, select **Delete label**, **Delete label and images with only the label (Do not delete source files)**, or **Delete label and images with only the label (Delete source files)**, and click **OK**. - -.. |image1| image:: /_static/images/en-us_image_0000001110760936.png - diff --git a/modelarts/umn/result/exeml/image_classification/preparing_data.rst b/modelarts/umn/result/exeml/image_classification/preparing_data.rst deleted file mode 100644 index 693d492c..00000000 --- a/modelarts/umn/result/exeml/image_classification/preparing_data.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _modelarts_21_0003: - -Preparing Data -============== - -Before using ModelArts ExeML to build a model, upload data to an OBS bucket. - -Uploading Data to OBS ---------------------- - -This operation uses the OBS console to upload data. For more information about how to create a bucket and upload files, see Creating a Bucket and Uploading an Object. - -Perform the following operations to import data to the dataset for model training and building. - -#. Log in to OBS Console and create a bucket. -#. Upload the local data to the OBS bucket. If you have a large amount of data, use OBS Browser+ to upload data or folders. The uploaded data must meet the dataset requirements of the ExeML project. - -Requirements on Datasets ------------------------- - -- The name of files in a dataset cannot contain Chinese characters, plus signs (+), spaces, or tabs. -- Ensure that no damaged image exists. The supported image formats include JPG, JPEG, BMP, and PNG. -- Do not store data of different projects in the same dataset. -- Prepare sufficient data and balance each class of data. To achieve better results, prepare at least 100 images of each class in a training set for image classification. -- To ensure the prediction accuracy of models, the training samples must be similar to the actual application scenarios. -- To ensure the generalization capability of models, datasets should cover all possible scenarios. - -Requirements for Files Uploaded to OBS --------------------------------------- - -- If you do not need to upload training data in advance, create an empty folder to store files generated in the future, for example, **/bucketName/data-cat**. -- If you need to upload images to be labeled in advance, create an empty folder and save the images in the folder. An example of the image directory structure is **/bucketName/data-cat/cat.jpg**. -- If you want to upload labeled images to the OBS bucket, upload them according to the following specifications: - - - The dataset for image classification requires storing labeled objects and their label files (in one-to-one relationship with the labeled objects) in the same directory. For example, if the name of the labeled object is **10.jpg**, the name of the label file must be **10.txt**. - - Example of data files: - - .. code-block:: - - ├─ - │ 10.jpg - │ 10.txt - │ 11.jpg - │ 11.txt - │ 12.jpg - │ 12.txt - - - Images in JPG, JPEG, PNG, and BMP formats are supported. When uploading images on the ModelArts management console, ensure that the size of an image does not exceed 5 MB and the total size of images to be uploaded in one attempt does not exceed 8 MB. If the data volume is large, use OBS Browser+ to upload images. - - - A label name can contain a maximum of 32 characters, including Chinese characters, letters, digits, hyphens (-), and underscores (_). - - - Image classification label file (**.txt**) rule: - - Each row contains only one label. - - .. code-block:: - - cat - dog - ... diff --git a/modelarts/umn/result/exeml/image_classification/training_a_model.rst b/modelarts/umn/result/exeml/image_classification/training_a_model.rst deleted file mode 100644 index 0e4d6623..00000000 --- a/modelarts/umn/result/exeml/image_classification/training_a_model.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _modelarts_21_0006: - -Training a Model -================ - -After labeling the images, you can train a model. You can perform model training to obtain the required image classification model. Training images must be classified into at least two classes, and each class must contain at least five images. Before training, ensure that the labeled images meet the requirements. Otherwise, the **Train** button is unavailable. - -Procedure ---------- - -#. On the **ExeML** page, click the name of the project that is successfully created. The **Label Data** tab page is displayed. - -#. On the **Label Data** tab page, click **Train** in the upper right corner. In the displayed **Training Configuration** dialog box, set related parameters. :ref:`Table 1 ` describes the parameters. - - .. _modelarts_21_0006__en-us_topic_0284258835_en-us_topic_0169446155_table56110116164: - - .. table:: **Table 1** Parameter description - - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Parameter | Description | Default Value | - +=================================+=======================================================================================================================================================================================================================================================================================================+=================================+ - | Dataset Version | This version is the one when the dataset is published in **Data Management**. In an ExeML project, when a training job is started, the dataset is published as a version based on the previous data labeling. | Randomly provided by the system | - | | | | - | | The system automatically provides a version number. You can change it to the version number that you want. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Training and Validation Ratios | The labeled sample is randomly divided into a training set and a validation set. By default, the ratio for the training set is 0.8, and that for the validation set is 0.2. The **usage** field in the manifest file records the set type. The value ranges from 0 to 1. | 0.8 | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Incremental Training Version | Select the version with the highest precision to perform training again. This accelerates model convergence and improves training precision. | None | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Max. Training Duration (Minute) | If training is not completed within the maximum training duration, the model is saved and training stops. To prevent the model from exiting before convergence, set this parameter to a large value. The value ranges from 6 to 6000. It is a good practice to properly extend the training duration. | 60 | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Training Preference | - **performance_first**: performance first. The training duration is short and the generated model is small. | balance | - | | - **balance**: balanced performance and precision | | - | | - **accuracy_first**: precision first. The training duration is long and the generated model is large. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Instance Flavor | Select the resource specifications used for training. By default, the following specifications are supported: | **ExeML (GPU)** | - | | | | - | | - **Compute-intensive instance (GPU)** | | - | | | | - | | The compute flavors are for reference only. Obtain the flavors on the management console. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - -#. After configuring training parameters, click **Next** to go to the configuration page, confirm the specifications, and click **Submit** to start auto model training. The training takes a certain period of time. Wait until the training is complete. If you close or exit this page, the system still performs the training operation. - -#. On the **Train Model** tab page, wait until the training status changes from **Running** to **Completed**. - -#. View the training details, such as **Accuracy**, **Evaluation Result**, **Training Parameters**, and **Classification Statistics**. For details about the evaluation result parameters, see :ref:`Table 2 `. - - .. _modelarts_21_0006__en-us_topic_0284258835_en-us_topic_0169446155_table19888201216: - - .. table:: **Table 2** Evaluation result parameters - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+=================================================================================================================================================+ - | Recall | Fraction of correctly predicted samples over all samples predicted as a class. It shows the ability of a model to distinguish positive samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Precision | Fraction of correctly predicted samples over all samples predicted as a class. It shows the ability of a model to distinguish negative samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Accuracy | Fraction of correctly predicted samples over all samples. It shows the general ability of a model to recognize samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | F1 Score | Harmonic average of the precision and recall of a model. It is used to evaluate the quality of a model. A high F1 score indicates a good model. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. note:: - - An ExeML project supports multiple rounds of training, and each round generates a version. For example, the first training version is **V001 (**\ *xxx*\ **)**, and the next version is **V002 (**\ *xxx*\ **)**. The trained models can be managed by training version. After the trained model meets your requirements, deploy the model as a service. diff --git a/modelarts/umn/result/exeml/index.rst b/modelarts/umn/result/exeml/index.rst deleted file mode 100644 index 6e2702d1..00000000 --- a/modelarts/umn/result/exeml/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_21_0000: - -===== -ExeML -===== - -.. toctree:: - :maxdepth: 1 - - introduction_to_exeml - image_classification/index - object_detection/index - tips/index diff --git a/modelarts/umn/result/exeml/introduction_to_exeml.rst b/modelarts/umn/result/exeml/introduction_to_exeml.rst deleted file mode 100644 index 08cbc67b..00000000 --- a/modelarts/umn/result/exeml/introduction_to_exeml.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _modelarts_21_0001: - -Introduction to ExeML -===================== - -ExeML ------ - -ModelArts ExeML is a customized code-free model development tool that helps users start AI application development from scratch with high flexibility. ExeML automates model design, parameter tuning and training, and model compression and deployment with the labeled data. Developers do not need to develop basic and encoding capabilities, but only to upload data and complete model training and deployment as prompted by ExeML. - -Currently, you can use ExeML to quickly create image classification, and object detection models. It can be widely used in industrial, retail, and security fields. - -- Image classification classifies and identifies objects in images. -- Object detection identifies the position and class of each object in images. - -ExeML Usage Process -------------------- - -With ModelArts ExeML, you can develop AI models without coding. You only need to upload data, create a project, label the data, publish training, and deploy the trained model. Up to 100 ExeML projects can be created. For details, see :ref:`Figure 1 `. - -.. _modelarts_21_0001__en-us_topic_0284258830_en-us_topic_0169445434_fig3917183328: - -.. figure:: /_static/images/en-us_image_0000001110921482.png - :alt: **Figure 1** Usage process of ExeML - - - **Figure 1** Usage process of ExeML - -ExeML Projects --------------- - -- **Image Classification** - - An image classification project aims to classify images. You only need to add images and label the images. After the images are labeled, an image classification model can be quickly generated. It can automatically classify offerings, vehicle types, and defective goods. For example, in the quality check scenario, you can upload a product image, label the image as qualified or unqualified, and train and deploy a model to inspect product quality. - -- **Object Detection** - - An object detection project aims to identify the class and location of objects in images. You only need to add images and label objects in the images with proper bounding boxes. The labled images will be used as the training set for creating a model. The model can identify multiple objects and count the number of objects in a single image, as well as inspect employees' dress code and perform unattended inspection of article placement. diff --git a/modelarts/umn/result/exeml/object_detection/creating_a_project.rst b/modelarts/umn/result/exeml/object_detection/creating_a_project.rst deleted file mode 100644 index dac33218..00000000 --- a/modelarts/umn/result/exeml/object_detection/creating_a_project.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _modelarts_21_0010: - -Creating a Project -================== - -ModelArts ExeML supports image classification and object detection projects. You can create any of them based on your needs. Perform the following operations to create an ExeML project. - -Procedure ---------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **ExeML**. The **ExeML** page is displayed. - -#. Click **Create Project** in the box of your desired project. The page for creating an ExeML project is displayed. - -#. On the displayed page, set the parameters by referring to :ref:`Table 1 `. - - .. _modelarts_21_0010__en-us_topic_0284258839_en-us_topic_0169446159_en-us_topic_0169446153_table14961618163816: - - .. table:: **Table 1** Parameters - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==============================================================================================================================================================================================================================================================================================+ - | Name | Name of an ExeML project | - | | | - | | - Enter a maximum of 20 characters. Only digits, letters, underscores (_), and hyphens (-) are allowed. This parameter is mandatory. | - | | - The name must start with a letter. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of a project | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Dataset Source | You can create a dataset or specify an existing dataset. | - | | | - | | - **Create**: Configure parameters such as **Dataset Name**, **Input Dataset Path**, **Output Dataset Path**, and **Label Set**. | - | | - **Specify**: Select a dataset of the same type from ModelArts Data Management to create an ExeML project. Only datasets of the same type are displayed in the **Dataset Name** drop-down list. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Dataset Name | If you select **Create** for **Dataset Source**, enter a dataset name based on required rules in the text box on the right. If you select **Specify** for **Dataset Source**, select one from available datasets of the same type under the current account displayed in the drop-down list. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input Dataset Path | Select the OBS path to the input dataset. For details about dataset input specifications, see :ref:`Preparing Data `. | - | | | - | | - Except the files and folders described in **Preparing Data > Requirements for Files Uploaded to OBS**, no other files or folders can be saved in the training data path. Otherwise, an error will be reported. | - | | - Do not modify the files in the training data path. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Dataset Path | Select the OBS path for storing the output dataset. | - | | | - | | .. note:: | - | | | - | | The output dataset path cannot be the same as the input dataset path or cannot be the subdirectory of the input dataset path. It is a good practice to select an empty directory in **Output Dataset Path**. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label Set | - **Label Name**: Enter a label name. The label name can contain only Chinese characters, letters, digits, underscores (_), and hyphens (-), which contains 1 to 32 characters. | - | | | - | | - **Add Label**: Click **Add Label** to add one or more labels. | - | | | - | | - Set the label color: You need to set label colors for object detection datasets, but you do not need to set label colors for image classification datasets. Select a color from the color palette on the right of a label, or enter the hexadecimal color code to set the color. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. Click **Create Project**. The system displays a message indicating that the project has been created. Then, the **Label Data** tab page is displayed. Alternatively, view the created project on the **ExeML** page and click the project name to go to the **Label Data** page. diff --git a/modelarts/umn/result/exeml/object_detection/deploying_a_model_as_a_service.rst b/modelarts/umn/result/exeml/object_detection/deploying_a_model_as_a_service.rst deleted file mode 100644 index 76de984e..00000000 --- a/modelarts/umn/result/exeml/object_detection/deploying_a_model_as_a_service.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. _modelarts_21_0013: - -Deploying a Model as a Service -============================== - -Deploying a Model ------------------ - -You can deploy a model as a real-time service that provides a real-time test UI and monitoring capabilities. After model training is complete, you can deploy a version with the ideal accuracy and in the **Successful** status as a service. The procedure is as follows: - -#. On the **Train Model** tab page, wait until the training status changes to **Successful**. Click **Deploy** in the **Version Manager** pane to deploy the model as a real-time service. - -#. In the **Deploy** dialog box, select resource flavor, set the **Auto Stop** function, and click **OK** to start the deployment. - - - **Specifications**: The GPU specifications are better, and the CPU specifications are more cost-effective. - - **Compute Nodes**: The default value is **1** and cannot be changed. - - **Auto Stop**: After this function is enabled and the auto stop time is set, a service automatically stops at the specified time. - - The options are **1 hour later**, **2 hours later**, **4 hours later**, **6 hours later**, and **Custom**. If you select **Custom**, you can enter any integer from 1 to 24 hours in the text box on the right. - -#. After the model deployment is started, view the deployment status on the **Service Deployment** page. - - It takes a certain period of time to deploy a model. When the status in the **Version Manager** pane changes from **Deploying** to **Running**, the deployment is complete. - - .. note:: - - On the **ExeML** page, trained models can only be deployed as real-time services. For details about how to deploy them as batch services, see :ref:`Where Are Models Generated by ExeML Stored? What Other Operations Are Supported? ` - -Testing a Service ------------------ - -- On the **Service Deployment** page, select a service type. For example, on the ExeML page, the object detection model is deployed as a real-time service by default. On the **Real-Time Services** page, click **Prediction** in the **Operation** column of the target service to perform a service test. For details, see "Testing a Service". -- You can also use code to test a service. For details, see "Accessing a Real-Time Service". -- The following describes the procedure for performing a service test after the object detection model is deployed as a service on the ExeML page. - - #. After the model is deployed, test the service using an image. On the **ExeML** page, click the target project, go to the **Deploy Service** tab page, select the service version in the **Running** status, click **Upload** in the service test area, and upload a local image to perform the test. - - #. Click **Predict** to perform the test. After the prediction is complete, the result is displayed in the **Test Result** pane on the right. If the model accuracy does not meet your expectation, add images on the **Label Data** tab page, label the images, and train and deploy the model again. :ref:`Table 1 ` describes the parameters in the prediction result. If you are satisfied with the model prediction result, call the API to access the real-time service as prompted. For details, see "Accessing a Real-Time Service". - - Currently, only JPG, JPEG, BMP, and PNG images are supported. - - .. _modelarts_21_0013__en-us_topic_0284258842_en-us_topic_0169446262_table27971626122015: - - .. table:: **Table 1** Parameters in the prediction result - - +-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================+====================================================================================================================================================================================================+ - | detection_classes | Label of each detection box | - +-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | detection_boxes | Coordinates of four points (y_min, x_min, y_max, and x_max) of each detection box, as shown in :ref:`Figure 1 ` | - +-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | detection_scores | Confidence of each detection box | - +-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_21_0013__en-us_topic_0284258842_en-us_topic_0169446262_fig8987811133012: - - .. figure:: /_static/images/en-us_image_0000001157080853.png - :alt: **Figure 1** Illustration for coordinates of four points of a detection box - - - **Figure 1** Illustration for coordinates of four points of a detection box - - .. note:: - - A running real-time service keeps consuming resources. If you do not need to use the real-time service, click **Stop** in the **Version Manager** pane to stop the service. If you want to use the service again, click **Start**. - - If you enable the auto stop function, the service automatically stops after the specified time and no fee is generated. diff --git a/modelarts/umn/result/exeml/object_detection/index.rst b/modelarts/umn/result/exeml/object_detection/index.rst deleted file mode 100644 index b859bb81..00000000 --- a/modelarts/umn/result/exeml/object_detection/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_21_0008: - -================ -Object Detection -================ - -.. toctree:: - :maxdepth: 1 - - preparing_data - creating_a_project - labeling_data - training_a_model - deploying_a_model_as_a_service diff --git a/modelarts/umn/result/exeml/object_detection/labeling_data.rst b/modelarts/umn/result/exeml/object_detection/labeling_data.rst deleted file mode 100644 index 2b63e8da..00000000 --- a/modelarts/umn/result/exeml/object_detection/labeling_data.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _modelarts_21_0011: - -Labeling Data -============= - -Before data labeling, consider how to design labels. The labels must correspond to the distinct characteristics of the detected images and are easy to identify (the detected object in an image is highly distinguished from the background). Each label specifies the expected recognition result of the detected images. After the label design is complete, prepare images based on the designed labels. It is recommended that the number of all images to be detected be greater than 100. If the labels of some images are similar, prepare more images. - -- During labeling, the variance of a class should be as small as possible. That is, the labeled objects of the same class should be as similar as possible. The labeled objects of different classes should be as different as possible. -- The contrast between the labeled objects and the image background should be as stark as possible. -- In object detection labeling, a target object must be entirely contained within a labeling box. If there are multiple objects in an image, do not relabel or miss any objects. - -Labeling Images ---------------- - -#. On the **Label Data** tab page, click the **Unlabeled** tab. All unlabeled images are displayed. Click an image to go to the labeling page. - -#. Left-click and drag the mouse to select the area where the target object is located. In the dialog box that is displayed, select the label color, enter the label name, and press **Enter**. After the labeling is complete, the status of the images changes to **Labeled**. - - More descriptions of data labeling are as follows: - - - You can click the arrow keys in the upper and lower parts of the image, or press the left and right arrow keys on the keyboard to select another image. Then, repeat the preceding operations to label the image. If an image contains more than one object, you can label all the objects. - - You can add multiple labels with different colors for an object detection ExeML project for easy identification. After selecting an object, select a new color and enter a new label name in the dialog box that is displayed to add a new label. - - In an ExeML project, object detection supports only rectangular labeling boxes. In the **Data Management** function, more types of labeling boxes are supported for object detection datasets. - - In the **Label Data** window, you can scroll the mouse to zoom in or zoom out on the image to quickly locate the object. - -#. After all images in the image directory are labeled, click **ExeML** in the upper left corner. In the dialog box that is displayed, click **OK** to save the labeling information. The **Label Data** page is displayed. On the **Labeled** tab page, you can view the labeled images or view the label names and quantity in the right pane. - -Synchronizing or Adding Images ------------------------------- - -On the **ExeML** page, click the project name. The **Label Data** tab page is displayed. When creating a project, you can add images from a local PC or synchronize image data from OBS. - -- **Add**: You can quickly add images on a local PC to ModelArts and synchronize the images to the OBS path specified during project creation. Click **Add**. In the dialog box that is displayed, click **Add Image** and add images. The total size of all images uploaded in one attempt cannot exceed 8 MB. The size of a single image cannot exceed 5 MB. -- **Synchronize Data Source**: You can upload images to the OBS directory specified during project creation and click **Synchronize Data Source** to quickly add the images in the OBS directory to ModelArts. -- **Delete**: You can delete images one by one, or select **Select Images on Current Page** to delete all images on the page. - - .. note:: - - The deleted images cannot be recovered. Exercise caution when performing this operation. - -Modifying Labeled Data ----------------------- - -After labeling data, you can modify labeled data on the **Labeled** tab page. - -- **Modifying based on images** - - On the dataset details page, click the **Labeled** tab, click the image to be modified. The labeling page is displayed. Modify the image information in the label information area on the right. - - - Modifying a label: In the **Labeling** area, click the edit icon, enter the correct label name in the text box, and click the check mark to complete the modification. The label color cannot be modified. - - - Deleting a label: In the **Labeling** area, click the deletion icon to delete a label from the image. - - After the label is deleted, click the project name in the upper left corner of the page to exit the labeling page. The image will be returned to the **Unlabeled** tab page. - -- **Modifying based on labels** - - On the dataset details page, click the **Labeled** tab. The information about all labels is displayed on the right. - - - Modifying a label: Click the edit icon in the **Operation** column. In the dialog box that is displayed, enter the new label name and click **OK**. After the modification, the images that have been added with the label use the new label name. - - Deleting a label: Click the deletion icon in the **Operation** column. In the displayed dialog box, select the object to be deleted as prompted and click **OK**. diff --git a/modelarts/umn/result/exeml/object_detection/preparing_data.rst b/modelarts/umn/result/exeml/object_detection/preparing_data.rst deleted file mode 100644 index c70164ee..00000000 --- a/modelarts/umn/result/exeml/object_detection/preparing_data.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. _modelarts_21_0009: - -Preparing Data -============== - -Before using ModelArts ExeML to build a model, upload data to an OBS bucket. - -Uploading Data to OBS ---------------------- - -This operation uses the OBS console to upload data. For more information about how to create a bucket and upload files, see Creating a Bucket and Uploading an Object. - -Perform the following operations to import data to the dataset for model training and building. - -#. Log in to OBS Console and create a bucket. -#. Upload the local data to the OBS bucket. If you have a large amount of data, use OBS Browser+ to upload data or folders. The uploaded data must meet the dataset requirements of the ExeML project. - -Requirements on Datasets ------------------------- - -- The name of files in a dataset cannot contain Chinese characters, plus signs (+), spaces, or tabs. -- Ensure that no damaged image exists. The supported image formats include JPG, JPEG, BMP, and PNG. -- Do not store data of different projects in the same dataset. -- To ensure the prediction accuracy of models, the training samples must be similar to the actual application scenarios. -- To ensure the generalization capability of models, datasets should cover all possible scenarios. -- In an object detection dataset, if the coordinates of the bounding box exceed the boundaries of an image, the image cannot be identified as a labeled image. - -Requirements for Files Uploaded to OBS --------------------------------------- - -- If you do not need to upload training data in advance, create an empty folder to store files generated in the future, for example, **/bucketName/data-cat**. -- If you need to upload images to be labeled in advance, create an empty folder and save the images in the folder. An example of the image directory structure is **/bucketName/data-cat/cat.jpg**. -- If you want to upload labeled images to the OBS bucket, upload them according to the following specifications: - - - The dataset for object detection requires storing labeled objects and their label files (in one-to-one relationship with the labeled objects) in the same directory. For example, if the name of the labeled object is **IMG_20180919_114745.jpg**, the name of the label file must be **IMG_20180919_114745.xml**. - - The label files for object detection must be in PASCAL VOC format. For details about the format, see :ref:`Table 1 `. - - Example of data files: - - .. code-block:: - - ├─ - │ IMG_20180919_114732.jpg - │ IMG_20180919_114732.xml - │ IMG_20180919_114745.jpg - │ IMG_20180919_114745.xml - │ IMG_20180919_114945.jpg - │ IMG_20180919_114945.xml - - - Images in JPG, JPEG, PNG, and BMP formats are supported. When uploading images on the ModelArts console, ensure that the size of an image does not exceed 5 MB and the total size of images to be uploaded in one attempt does not exceed 8 MB. If the data volume is large, use OBS Browser+ to upload images. - - - A label name can contain a maximum of 32 characters, including letters, digits, hyphens (-), and underscores (_). - - .. _modelarts_21_0009__en-us_topic_0284258838_en-us_topic_0169446158_table18220153119617: - - .. table:: **Table 1** PASCAL VOC format description - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Field | Mandatory | Description | - +=======================+=======================+================================================================================================================================================================================================================+ - | folder | Yes | Directory where the data source is located | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | filename | Yes | Name of the file to be labeled | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | size | Yes | Image pixel | - | | | | - | | | - **width**: image width. This parameter is mandatory. | - | | | - **height**: image height. This parameter is mandatory. | - | | | - **depth**: number of image channels. This parameter is mandatory. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | segmented | Yes | Segmented or not | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | object | Yes | Object detection information. Multiple **object{}** functions are generated for multiple objects. | - | | | | - | | | - **name**: class of the labeled object. This parameter is mandatory. | - | | | - **pose**: shooting angle of the labeled object. This parameter is mandatory. | - | | | - **truncated**: whether the labeled object is truncated (**0** indicates that the object is not truncated). This parameter is mandatory. | - | | | - **occluded**: whether the labeled object is occluded (**0** indicates that the object is not occluded). This parameter is mandatory. | - | | | - **difficult**: whether the labeled object is difficult to identify (**0** indicates that the object is easy to identify). This parameter is mandatory. | - | | | - **confidence**: confidence score of the labeled object. The value range is 0 to 1. This parameter is optional. | - | | | - **bndbox**: bounding box type. This parameter is mandatory. For details about the possible values, see :ref:`Table 2 `. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_21_0009__en-us_topic_0284258838_en-us_topic_0169446158_table102211311866: - - .. table:: **Table 2** Description of bounding box types - - +-----------------------+-----------------------+------------------------------------------------------+ - | type | Shape | Labeling Information | - +=======================+=======================+======================================================+ - | bndbox | Rectangle | Coordinates of the upper left and lower right points | - | | | | - | | | 100 | - | | | | - | | | 100 | - | | | | - | | | 200 | - | | | | - | | | 200 | - +-----------------------+-----------------------+------------------------------------------------------+ - - Example of the label file in KITTI format: - - .. code-block:: - - - test_data - 260730932.jpg - - 767 - 959 - 3 - - 0 - - bag - Unspecified - 0 - 0 - 0 - - 108 - 101 - 251 - 238 - - - diff --git a/modelarts/umn/result/exeml/object_detection/training_a_model.rst b/modelarts/umn/result/exeml/object_detection/training_a_model.rst deleted file mode 100644 index 64c1cac7..00000000 --- a/modelarts/umn/result/exeml/object_detection/training_a_model.rst +++ /dev/null @@ -1,67 +0,0 @@ -.. _modelarts_21_0012: - -Training a Model -================ - -After labeling the images, perform auto training to obtain an appropriate model version. - -Procedure ---------- - -#. On the **ExeML** page, click the name of the project that is successfully created. The **Label Data** tab page is displayed. - -#. On the **Label Data** tab page, click **Train** in the upper right corner. In the displayed **Training Configuration** dialog box, set related parameters. :ref:`Table 1 ` describes the parameters. - - .. _modelarts_21_0012__en-us_topic_0284258841_en-us_topic_0169446261_table56110116164: - - .. table:: **Table 1** Parameter description - - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Parameter | Description | Default Value | - +=================================+=====================================================================================================================================================================================================================================================================================================================================================================================+=================================+ - | Dataset Version | This version is the one when the dataset is published in **Data Management**. In an ExeML project, when a training job is started, the dataset is published as a version based on the previous data labeling. | Randomly provided by the system | - | | | | - | | The system automatically provides a version number. You can change it to the version number that you want. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Training and Validation Ratios | The labeled sample is randomly divided into a training set and a validation set. By default, the ratio for the training set is 0.8, and that for the validation set is 0.2. The **usage** field in the manifest file records the set type. The value ranges from 0 to 1. | 0.8 | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Incremental Training Version | Select the version with the highest precision to perform training again. This accelerates model convergence and improves training precision. | None | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Max. Training Duration (Minute) | If training is not completed within the maximum training duration, the model is saved and training stops. To prevent the model from exiting before convergence, set this parameter to a large value. The value ranges from 6 to 6000. You are advised to properly extend the training duration. Set the training duration to more than 1 hour for a training set with 2,000 images. | 60 | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Training Preference | - **performance_first**: performance first. The training duration is short and the generated model is small. | balance | - | | - **balance**: balanced performance and precision | | - | | - **accuracy_first**: precision first. The training duration is long and the generated model is large. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - | Instance Flavor | Select the resource specifications used for training. By default, the following specifications are supported: | **ExeML (GPU)** | - | | | | - | | - **Compute-intensive instance (GPU)** | | - | | | | - | | The compute flavors are for reference only. Obtain the flavors on the management console. | | - +---------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------+ - -#. After configuring training parameters, click **Next** to go to the configuration page, confirm the specifications, and click **Submit** to start auto model training. The training takes a certain period of time. Wait until the training is complete. If you close or exit this page, the system still performs the training operation. - -#. On the **Train Model** tab page, wait until the training status changes from **Running** to **Completed**. - -#. View the training details, such as **Accuracy**, **Evaluation Result**, **Training Parameters**, and **Classification Statistics**. For details about the evaluation result parameters, see :ref:`Table 2 `. - - .. _modelarts_21_0012__en-us_topic_0284258841_en-us_topic_0169446261_table15870125755817: - - .. table:: **Table 2** Evaluation result parameters - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===========+=================================================================================================================================================+ - | Recall | Fraction of correctly predicted samples over all samples predicted as a class. It shows the ability of a model to distinguish positive samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Precision | Fraction of correctly predicted samples over all samples predicted as a class. It shows the ability of a model to distinguish negative samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | Accuracy | Fraction of correctly predicted samples over all samples. It shows the general ability of a model to recognize samples. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - | F1 Score | Harmonic average of the precision and recall of a model. It is used to evaluate the quality of a model. A high F1 score indicates a good model. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. note:: - - An ExeML project supports multiple rounds of training, and each round generates a version. For example, the first training version is **V001 (**\ *xxx*\ **)**, and the next version is **V002 (**\ *xxx*\ **)**. The trained models can be managed by training version. After the trained model meets your requirements, deploy the model as a service. diff --git a/modelarts/umn/result/exeml/tips/how_do_i_perform_incremental_training_in_an_exeml_project.rst b/modelarts/umn/result/exeml/tips/how_do_i_perform_incremental_training_in_an_exeml_project.rst deleted file mode 100644 index faea4649..00000000 --- a/modelarts/umn/result/exeml/tips/how_do_i_perform_incremental_training_in_an_exeml_project.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _modelarts_21_0033: - -How Do I Perform Incremental Training in an ExeML Project? -========================================================== - -Each round of training generates a training version in an ExeML project. If a training result is unsatisfactory (for example, if the precision is not good enough), you can add high-quality data or add or delete labels, and perform training again. - -.. note:: - - - For better training results, use high-quality data for incremental training to improve data labeling performance. - -Incremental Training Procedure ------------------------------- - -#. Log in to the ModelArts console, and click **ExeML** in the left navigation pane. - -#. On the **ExeML** page, click a project name. The ExeML details page of the project is displayed. - -#. On the **Label Data** page, click the **Unlabeled** tab. On the **Unlabeled** tab page, you can add images or add or delete labels. - - If you add images, label the added images again. If you add or delete labels, check all images and label them again. You also need to check whether new labels need to be added for the labeled data. - -#. After all images are labeled, click **Train** in the upper right corner. In the **Training Configuration** dialog box that is displayed, set **Incremental Training Version** to the training version that has been completed to perform incremental training based on this version. Set other parameters as prompted. - - After the settings are complete, click **Yes** to start incremental training. The system automatically switches to the **Train Model** page. After the training is complete, you can view the training details, such as training precision, evaluation result, and training parameters. diff --git a/modelarts/umn/result/exeml/tips/how_do_i_quickly_create_an_obs_bucket_and_a_folder_when_creating_a_project.rst b/modelarts/umn/result/exeml/tips/how_do_i_quickly_create_an_obs_bucket_and_a_folder_when_creating_a_project.rst deleted file mode 100644 index bd8af090..00000000 --- a/modelarts/umn/result/exeml/tips/how_do_i_quickly_create_an_obs_bucket_and_a_folder_when_creating_a_project.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _modelarts_21_0031: - -How Do I Quickly Create an OBS Bucket and a Folder When Creating a Project? -=========================================================================== - -When creating a project, select a training data path. This section describes how to quickly create an OBS bucket and folder when you select the training data path. - -#. On the page for creating an ExeML project, click |image1| on the right of **Input Dataset Path**. The **Input Dataset Path** dialog box is displayed. - -#. Click **Create Bucket**. The **Create Bucket** page is displayed. For details about how to create a bucket, see **Creating a Bucket** in the *Object Storage Service Console Operation Guide*. - - .. _modelarts_21_0031__en-us_topic_0284258862_en-us_topic_0219614203_fig1365441355315: - - .. figure:: /_static/images/en-us_image_0000001157080895.png - :alt: **Figure 1** Creating an OBS bucket - - - **Figure 1** Creating an OBS bucket - -#. Select the bucket, and click **Create Folder**. In the dialog box that is displayed, enter the folder name and click **OK**. - - - The name cannot contain the following special characters: \\/:*?"<>\| - - The name cannot start or end with a period (.) or slash (/). - - The absolute path of a folder cannot exceed 1,023 characters. - - Any single slash (/) separates and creates multiple levels of folders at once. - -.. |image1| image:: /_static/images/en-us_image_0000001157080897.png - diff --git a/modelarts/umn/result/exeml/tips/how_do_i_view_the_added_data_in_an_exeml_project.rst b/modelarts/umn/result/exeml/tips/how_do_i_view_the_added_data_in_an_exeml_project.rst deleted file mode 100644 index 1f7ef160..00000000 --- a/modelarts/umn/result/exeml/tips/how_do_i_view_the_added_data_in_an_exeml_project.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _modelarts_21_0032: - -How Do I View the Added Data in an ExeML Project? -================================================= - -To add data for an existing project, perform the following operations. The operations described in this section apply only to object detection and image classification projects. - -Obtaining the Data Source of an ExeML Project ---------------------------------------------- - -#. Log in to the ModelArts management console and choose **ExeML** from the left navigation pane. -#. In the ExeML project list, you can view the data source corresponding to the project in the **Data Source** column. Click your desired data source link to go to the dataset selected or created during project creation. - -Uploading New Data to OBS -------------------------- - -Log in to OBS Console, access the data storage path, and upload new data to OBS. - -For details about how to upload files to OBS, see **Uploading an Object**. - -Synchronizing Data to ModelArts -------------------------------- - -#. After data is uploaded to OBS, go to the **ExeML** page on the ModelArts management console. - -#. In the ExeML project list, select the project to which data is to be added and click the project name. The **Label Data** page is displayed. - -#. On the **Label Data** page, click **Synchronize Data Source**. - - It takes several minutes to complete data synchronization. After the synchronization is complete, the new data is synchronized to the **Unlabeled** or **Labeled** tab page. diff --git a/modelarts/umn/result/exeml/tips/index.rst b/modelarts/umn/result/exeml/tips/index.rst deleted file mode 100644 index ec548458..00000000 --- a/modelarts/umn/result/exeml/tips/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_21_0030: - -==== -Tips -==== - -.. toctree:: - :maxdepth: 1 - - how_do_i_quickly_create_an_obs_bucket_and_a_folder_when_creating_a_project - how_do_i_view_the_added_data_in_an_exeml_project - how_do_i_perform_incremental_training_in_an_exeml_project - where_are_models_generated_by_exeml_stored_what_other_operations_are_supported diff --git a/modelarts/umn/result/exeml/tips/where_are_models_generated_by_exeml_stored_what_other_operations_are_supported.rst b/modelarts/umn/result/exeml/tips/where_are_models_generated_by_exeml_stored_what_other_operations_are_supported.rst deleted file mode 100644 index c5d799f9..00000000 --- a/modelarts/umn/result/exeml/tips/where_are_models_generated_by_exeml_stored_what_other_operations_are_supported.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. _modelarts_21_0034: - -Where Are Models Generated by ExeML Stored? What Other Operations Are Supported? -================================================================================ - -Unified Model Management ------------------------- - -For an ExeML project, after the model training is complete, the generated model is automatically displayed on the **Model Management > Models** page. The model name is automatically generated by the system. Its prefix is the same as the name of the ExeML project for easy identification. - -.. caution:: - - Models generated by ExeML cannot be downloaded. - -What Other Operations Are Supported for Models Generated by ExeML? ------------------------------------------------------------------- - -- **Deploying models as real-time and batch services** - - On the **ExeML** page, models can only be deployed as real-time services. You can deploy models as batch services on the **Model Management > Models** page. - - It should be noted that resources with other specifications can be used when you create a model deployment task on the **Model Management > Models** page. On the ExeML project page, only **Compute-intensive 2 instance (NPU)** can be used to deploy models. - -- **Creating a version** - - When creating a new version, you can select a meta model only from a ModelArts training job, OBS, model template, or custom image. You cannot create a version from the original ExeML project. - -- **Deleting a model or its version** diff --git a/modelarts/umn/result/faqs/data_management/index.rst b/modelarts/umn/result/faqs/data_management/index.rst deleted file mode 100644 index afe4ff65..00000000 --- a/modelarts/umn/result/faqs/data_management/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_05_0101: - -=============== -Data Management -=============== - -.. toctree:: - :maxdepth: 1 - - why_does_data_fail_to_be_imported_using_the_manifest_file diff --git a/modelarts/umn/result/faqs/data_management/why_does_data_fail_to_be_imported_using_the_manifest_file.rst b/modelarts/umn/result/faqs/data_management/why_does_data_fail_to_be_imported_using_the_manifest_file.rst deleted file mode 100644 index 29613365..00000000 --- a/modelarts/umn/result/faqs/data_management/why_does_data_fail_to_be_imported_using_the_manifest_file.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_05_0103: - -Why Does Data Fail to Be Imported Using the Manifest File? -========================================================== - -Symptom -------- - -Failed to use the manifest file of the published dataset to import data again. - -Possible Cause --------------- - -Data has been changed in the OBS directory of the published dataset, for example, images have been deleted. Therefore, the manifest file is inconsistent with data in the OBS directory. As a result, an error occurs when the manifest file is used to import data again. - -Solution --------- - -- Method 1 (recommended): Publish a new version of the dataset again and use the new manifest file to import data. -- Method 2: Modify the manifest file on your local PC, search for data changes in the OBS directory, and modify the manifest file accordingly. Ensure that the manifest file is consistent with data in the OBS directory, and then import data using the new manifest file. diff --git a/modelarts/umn/result/faqs/development_environment/index.rst b/modelarts/umn/result/faqs/development_environment/index.rst deleted file mode 100644 index dd33dba4..00000000 --- a/modelarts/umn/result/faqs/development_environment/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_05_0020: - -======================= -Development Environment -======================= - -.. toctree:: - :maxdepth: 1 - - notebook/index diff --git a/modelarts/umn/result/faqs/development_environment/notebook/do_files_in__cache_still_exist_after_a_notebook_instance_is_stopped_or_restarted_how_do_i_avoid_a_restart.rst b/modelarts/umn/result/faqs/development_environment/notebook/do_files_in__cache_still_exist_after_a_notebook_instance_is_stopped_or_restarted_how_do_i_avoid_a_restart.rst deleted file mode 100644 index 9b601c51..00000000 --- a/modelarts/umn/result/faqs/development_environment/notebook/do_files_in__cache_still_exist_after_a_notebook_instance_is_stopped_or_restarted_how_do_i_avoid_a_restart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _modelarts_05_0080: - -Do Files in /cache Still Exist After a Notebook Instance is Stopped or Restarted? How Do I Avoid a Restart? -=========================================================================================================== - -**/cache** is a temporary directory and will not be saved. After an instance using OBS storage is stopped, data in the **~work** directory will be deleted. After a notebook instance is restarted, all cached data except the data in the OBS bucket is lost, and your model or code is unavailable. - -To avoid a restart, do not train heavy-load jobs that consume large amounts of CPU, GPU, or memory resources in DevEnviron. diff --git a/modelarts/umn/result/faqs/development_environment/notebook/how_do_i_enable_the_terminal_function_in_devenviron_of_modelarts.rst b/modelarts/umn/result/faqs/development_environment/notebook/how_do_i_enable_the_terminal_function_in_devenviron_of_modelarts.rst deleted file mode 100644 index 7a30ef57..00000000 --- a/modelarts/umn/result/faqs/development_environment/notebook/how_do_i_enable_the_terminal_function_in_devenviron_of_modelarts.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _modelarts_05_0071: - -How Do I Enable the Terminal Function in DevEnviron of ModelArts? -================================================================= - -#. Log in to the ModelArts management console, and choose **DevEnviron > Notebooks**. - -#. In the notebook list, click **Open** in the **Operation** column of the target notebook instance to go to the **Jupyter** page. - -#. On the **Files** tab page of the Jupyter page, click **New** and select **Terminal**. The **Terminal** page is displayed. - - .. _modelarts_05_0071__en-us_topic_0000001096866491_en-us_topic_0285164851_en-us_topic_0198006089_fig18352418612: - - .. figure:: /_static/images/en-us_image_0000001110760910.png - :alt: **Figure 1** Going to the **Terminal** page - - - **Figure 1** Going to the **Terminal** page diff --git a/modelarts/umn/result/faqs/development_environment/notebook/index.rst b/modelarts/umn/result/faqs/development_environment/notebook/index.rst deleted file mode 100644 index b6bab5d0..00000000 --- a/modelarts/umn/result/faqs/development_environment/notebook/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_05_0067: - -======== -Notebook -======== - -.. toctree:: - :maxdepth: 1 - - how_do_i_enable_the_terminal_function_in_devenviron_of_modelarts - where_will_the_data_be_uploaded_to - do_files_in__cache_still_exist_after_a_notebook_instance_is_stopped_or_restarted_how_do_i_avoid_a_restart - where_is_data_stored_after_the_sync_obs_function_is_used diff --git a/modelarts/umn/result/faqs/development_environment/notebook/where_is_data_stored_after_the_sync_obs_function_is_used.rst b/modelarts/umn/result/faqs/development_environment/notebook/where_is_data_stored_after_the_sync_obs_function_is_used.rst deleted file mode 100644 index 69e867df..00000000 --- a/modelarts/umn/result/faqs/development_environment/notebook/where_is_data_stored_after_the_sync_obs_function_is_used.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_05_0081: - -Where Is Data Stored After the Sync OBS Function Is Used? -========================================================= - -#. Log in to the ModelArts management console, and choose **DevEnviron > Notebooks**. - -#. In the **Operation** column of the target notebook instance in the notebook list, click **Open** to go to the **Jupyter** page. - -#. On the **Files** tab page of the **Jupyter** page, select the target file and click **Sync OBS** in the upper part of the page to synchronize the file. The file is stored in the **~/work** directory of the instance. - -#. On the **Files** tab page of the **Jupyter** page, click **New** and select **Terminal**. The **Terminal** page is displayed. - -#. Run the following command to go to the **~/work** directory. - - .. code-block:: - - cd work - -#. Run the **ls** command in the **~/work** directory to view the files. diff --git a/modelarts/umn/result/faqs/development_environment/notebook/where_will_the_data_be_uploaded_to.rst b/modelarts/umn/result/faqs/development_environment/notebook/where_will_the_data_be_uploaded_to.rst deleted file mode 100644 index d505db0f..00000000 --- a/modelarts/umn/result/faqs/development_environment/notebook/where_will_the_data_be_uploaded_to.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_05_0045: - -Where Will the Data Be Uploaded to? -=================================== - -Data may be stored in OBS or EVS, depending on which kind of storage you have configured for your Notebook instances: - -- OBS - - After you click **upload**, the data is directly uploaded to the target OBS path specified when the notebook instance was created. - -- EVS - - After you click **upload**, the data is uploaded to the instance container, that is, the **~/work** directory on the **Terminal** page. diff --git a/modelarts/umn/result/faqs/exeml/can_i_add_multiple_labels_to_an_image_for_an_object_detection_project.rst b/modelarts/umn/result/faqs/exeml/can_i_add_multiple_labels_to_an_image_for_an_object_detection_project.rst deleted file mode 100644 index 45877aa8..00000000 --- a/modelarts/umn/result/faqs/exeml/can_i_add_multiple_labels_to_an_image_for_an_object_detection_project.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_05_0006: - -Can I Add Multiple Labels to an Image for an Object Detection Project? -====================================================================== - -Yes. You can add multiple labels to an image. diff --git a/modelarts/umn/result/faqs/exeml/index.rst b/modelarts/umn/result/faqs/exeml/index.rst deleted file mode 100644 index 09a8f127..00000000 --- a/modelarts/umn/result/faqs/exeml/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _modelarts_05_0015: - -===== -ExeML -===== - -.. toctree:: - :maxdepth: 1 - - what_is_exeml - what_are_image_classification_and_object_detection - what_should_i_do_when_the_train_button_is_unavailable_after_i_create_an_image_classification_project_and_label_the_images - can_i_add_multiple_labels_to_an_image_for_an_object_detection_project - what_type_of_service_is_deployed_in_exeml - what_formats_of_images_are_supported_by_object_detection_or_image_classification_projects diff --git a/modelarts/umn/result/faqs/exeml/what_are_image_classification_and_object_detection.rst b/modelarts/umn/result/faqs/exeml/what_are_image_classification_and_object_detection.rst deleted file mode 100644 index e0c33664..00000000 --- a/modelarts/umn/result/faqs/exeml/what_are_image_classification_and_object_detection.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_05_0018: - -What Are Image Classification and Object Detection? -=================================================== - -Image classification is an image processing method that separates different classes of targets according to the features reflected in the images. With quantitative analysis on images, it classifies an image or each pixel or area in an image into different categories to replace human visual interpretation. In general, image classification aims to identify a class, status, or scene in an image. It is applicable to scenarios where an image contains only one object. :ref:`Figure 1 ` shows an example of identifying a car in an image. - -.. _modelarts_05_0018__en-us_topic_0000001096467407_en-us_topic_0285164820_en-us_topic_0147657895_fig630464819155: - -.. figure:: /_static/images/en-us_image_0000001156920931.png - :alt: **Figure 1** Image classification - - - **Figure 1** Image classification - -Object detection is one of the classical problems in computer vision. It intends to label objects with frames and identify the object classes in an image. Generally, if an image contains multiple objects, object detection can identify the location, quantity, and name of each object in the image. It is suitable for scenarios where an image contains multiple objects. :ref:`Figure 2 ` shows an example of identifying a tree and a car in an image. - -.. _modelarts_05_0018__en-us_topic_0000001096467407_en-us_topic_0285164820_en-us_topic_0147657895_fig522176141613: - -.. figure:: /_static/images/en-us_image_0000001110920962.png - :alt: **Figure 2** Object detection - - - **Figure 2** Object detection diff --git a/modelarts/umn/result/faqs/exeml/what_formats_of_images_are_supported_by_object_detection_or_image_classification_projects.rst b/modelarts/umn/result/faqs/exeml/what_formats_of_images_are_supported_by_object_detection_or_image_classification_projects.rst deleted file mode 100644 index 0074c869..00000000 --- a/modelarts/umn/result/faqs/exeml/what_formats_of_images_are_supported_by_object_detection_or_image_classification_projects.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_05_0010: - -What Formats of Images Are Supported by Object Detection or Image Classification Projects? -========================================================================================== - -Images in JPG, JPEG, PNG, or BMP format are supported. diff --git a/modelarts/umn/result/faqs/exeml/what_is_exeml.rst b/modelarts/umn/result/faqs/exeml/what_is_exeml.rst deleted file mode 100644 index 85cdc5b1..00000000 --- a/modelarts/umn/result/faqs/exeml/what_is_exeml.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _modelarts_05_0002: - -What Is ExeML? -============== - -ExeML is the process of automating model design, parameter tuning, and model training, compression, and deployment with the labeled data. The process is free of coding and does not require developers' experience in model development. - -Users who do not have encoding capability can use the labeling, one-click model training, and model deployment functions of ExeML to build AI models. diff --git a/modelarts/umn/result/faqs/exeml/what_should_i_do_when_the_train_button_is_unavailable_after_i_create_an_image_classification_project_and_label_the_images.rst b/modelarts/umn/result/faqs/exeml/what_should_i_do_when_the_train_button_is_unavailable_after_i_create_an_image_classification_project_and_label_the_images.rst deleted file mode 100644 index 260278d2..00000000 --- a/modelarts/umn/result/faqs/exeml/what_should_i_do_when_the_train_button_is_unavailable_after_i_create_an_image_classification_project_and_label_the_images.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_05_0005: - -What Should I Do When the Train Button Is Unavailable After I Create an Image Classification Project and Label the Images? -========================================================================================================================== - -The **Train** button turns to be available when the training images for an image classification project are classified into at least two categories, and each category contains at least five images. diff --git a/modelarts/umn/result/faqs/exeml/what_type_of_service_is_deployed_in_exeml.rst b/modelarts/umn/result/faqs/exeml/what_type_of_service_is_deployed_in_exeml.rst deleted file mode 100644 index 95e768f5..00000000 --- a/modelarts/umn/result/faqs/exeml/what_type_of_service_is_deployed_in_exeml.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _modelarts_05_0008: - -What Type of Service Is Deployed in ExeML? -========================================== - -Models created in ExeML are deployed as real-time services. You can add images or compile code to test the services, as well as call the APIs using the URLs. - -After model development is successful, you can choose **Service Deployment** > **Real-Time Services** in the left navigation pane of the ModelArts console to view running services, and stop or delete services. diff --git a/modelarts/umn/result/faqs/general_issues/how_do_i_obtain_access_keys.rst b/modelarts/umn/result/faqs/general_issues/how_do_i_obtain_access_keys.rst deleted file mode 100644 index 34cab12e..00000000 --- a/modelarts/umn/result/faqs/general_issues/how_do_i_obtain_access_keys.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_05_0004: - -How Do I Obtain Access Keys? -============================ - -Obtaining an Access Key ------------------------ - -#. Log in to the console, enter the **My Credentials** page, and choose **Access Keys** > **Create Access Key**. -#. In the **Create Access Key** dialog box that is displayed, use the login password for verification. -#. Click **OK**, open the **credentials.csv** file, and save the key file as prompted. The access key file is saved in the default download folder of the browser. Then, the access key (**Access Key Id** and **Secret Access Key**) is obtained. diff --git a/modelarts/umn/result/faqs/general_issues/how_do_i_upload_data_to_obs.rst b/modelarts/umn/result/faqs/general_issues/how_do_i_upload_data_to_obs.rst deleted file mode 100644 index da5398d7..00000000 --- a/modelarts/umn/result/faqs/general_issues/how_do_i_upload_data_to_obs.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_05_0013: - -How Do I Upload Data to OBS? -============================ - -Before using ModelArts to develop AI models, data needs to be uploaded to an OBS bucket. You can log in to the OBS console to create an OBS bucket, create a folder, and upload data. For details about how to upload data, see *Object Storage Service Getting Started*. diff --git a/modelarts/umn/result/faqs/general_issues/index.rst b/modelarts/umn/result/faqs/general_issues/index.rst deleted file mode 100644 index 0a9e0c2a..00000000 --- a/modelarts/umn/result/faqs/general_issues/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_05_0014: - -============== -General Issues -============== - -.. toctree:: - :maxdepth: 1 - - what_is_modelarts - what_are_the_relationships_between_modelarts_and_other_services - how_do_i_obtain_access_keys - how_do_i_upload_data_to_obs - which_ai_frameworks_does_modelarts_support diff --git a/modelarts/umn/result/faqs/general_issues/what_are_the_relationships_between_modelarts_and_other_services.rst b/modelarts/umn/result/faqs/general_issues/what_are_the_relationships_between_modelarts_and_other_services.rst deleted file mode 100644 index f32ef367..00000000 --- a/modelarts/umn/result/faqs/general_issues/what_are_the_relationships_between_modelarts_and_other_services.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_05_0003: - -What Are the Relationships Between ModelArts and Other Services -=============================================================== - -OBS ---- - -ModelArts uses Object Storage Service (OBS) to store data and model backups and snapshots. OBS provides secure, reliable, low-cost storage. For more details, see *Object Storage Service Console Function Overview*. - -CCE ---- - -ModelArts uses Cloud Container Engine (CCE) to deploy models as real-time services. CCE enables high concurrency and provides elastic scaling. For more information about CCE, see *Cloud Container Engine User Guide*. - -SWR ---- - -To use an AI framework that is not supported by ModelArts, use SoftWare Repository for Container (SWR) to customize an image and import the image to ModelArts for training or inference. For more details, see . - -Cloud Eye ---------- - -ModelArts uses Cloud Eye to monitor online services and model loads in real time and send alarms and notifications automatically. For details about Cloud Eye, see *Cloud Eye User Guide*. diff --git a/modelarts/umn/result/faqs/general_issues/what_is_modelarts.rst b/modelarts/umn/result/faqs/general_issues/what_is_modelarts.rst deleted file mode 100644 index 959aa6f2..00000000 --- a/modelarts/umn/result/faqs/general_issues/what_is_modelarts.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_05_0001: - -What Is ModelArts? -================== - -ModelArts is a one-stop development platform for AI developers. With data preprocessing, semi-automated data labeling, distributed training, automated model building, and model deployment, ModelArts helps you build models quickly and manage the lifecycle of AI development. - -The one-stop ModelArts platform covers all stages of AI development, including data processing and model training and deployment. The underlying layer of ModelArts supports various heterogeneous computing resources. You can flexibly select and use the resources without having to consider the underlying technologies. In addition, ModelArts supports popular open-source AI development frameworks such as TensorFlow. Developers can also use self-developed algorithm frameworks to match their usage habits. - -ModelArts aims to simplify AI development. diff --git a/modelarts/umn/result/faqs/general_issues/which_ai_frameworks_does_modelarts_support.rst b/modelarts/umn/result/faqs/general_issues/which_ai_frameworks_does_modelarts_support.rst deleted file mode 100644 index 6aefa25e..00000000 --- a/modelarts/umn/result/faqs/general_issues/which_ai_frameworks_does_modelarts_support.rst +++ /dev/null @@ -1,132 +0,0 @@ -.. _modelarts_05_0128: - -Which AI Frameworks Does ModelArts Support? -=========================================== - -Supported AI frameworks and versions of ModelArts vary slightly based on the development environment, training jobs, and model inference (model management and deployment). The following describes the AI frameworks supported by each module. - -Development Environment ------------------------ - -Notebook instances in the development environment support different AI engines and versions based on specific work environments (that is, different Python versions). After creating a notebook instance in the corresponding work environment, create a file based on the corresponding version in :ref:`Table 1 `. ModelArts notebook instances support multiple engines. That is, a notebook instance can use all supported engines. Different engines can be switched quickly and conveniently. - -.. _modelarts_05_0128__en-us_topic_0246510446_table4362414101: - -.. table:: **Table 1** AI engines - - +------------------------------------------+--------------------------------+----------------+ - | Work Environment | Built-in AI Engine and Version | Supported Chip | - +==========================================+================================+================+ - | Multi-Engine 1.0 (Python 3, Recommended) | MXNet-1.2.1 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | PySpark-2.3.2 | CPU | - +------------------------------------------+--------------------------------+----------------+ - | | Pytorch-1.0.0 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-1.13.1 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | XGBoost-Sklearn | CPU | - +------------------------------------------+--------------------------------+----------------+ - | Multi-Engine 2.0 (Python3) | Pytorch-1.4.0 | GPU | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-2.1.0 | CPU/GPU | - +------------------------------------------+--------------------------------+----------------+ - | Ascend-Powered-Engine 1.0 (Python3) | MindSpore-1.1.1 | Ascend 910 | - +------------------------------------------+--------------------------------+----------------+ - | | TensorFlow-1.15.0 | Ascend 910 | - +------------------------------------------+--------------------------------+----------------+ - -Training Jobs -------------- - -Supported AI engines and versions when creating training jobs are as follows: - -.. table:: **Table 2** AI engines supported by training jobs - - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Environment | Supported Chip | System Architecture | System Version | AI Engine and Version | Supported CUDA or Ascend Version | - +=======================+================+=====================+================+===================================+==================================+ - | TensorFlow | CPU and GPU | x86_64 | Ubuntu 16.04 | TF-1.13.1-python3.6 | CUDA 10.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | TF-2.1.0-python3.6 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Caffe | CPU and GPU | x86_64 | Ubuntu 16.04 | Caffe-1.0.0-python2.7 | CUDA 8.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Spark_MLlib | CPU | x86_64 | Ubuntu 16.04 | Spark-2.3.2-python3.6 | N/A | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | XGBoost-Sklearn | CPU | x86_64 | Ubuntu 16.04 | Scikit_Learn-0.18.1-python3.6 | N/A | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | PyTorch | CPU and GPU | x86_64 | Ubuntu 16.04 | PyTorch-1.3.0-python3.6 | CUDA 10.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | PyTorch-1.4.0-python3.6 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Ascend-Powered-Engine | Ascend 910 | AArch64 | EulerOS 2.8 | Mindspore-1.1.1-python3.7-aarch64 | C76 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | TF-1.15-python3.7-aarch64 | C76 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | MindSpore-GPU | CPU and GPU | x86_64 | Ubuntu 18.04 | MindSpore-1.1.0-python3.7 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - -Model Inference ---------------- - -For imported models and model inference is completed on ModelArts, supported engines and their runtime are as follows: - -.. table:: **Table 3** Supported AI engines and their runtime - - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Engine | Runtime | Precautions | - +=======================+=========================+============================================================================================================================================================================================================================================================================================+ - | TensorFlow | python3.6 | - TensorFlow 1.8.0 is used in **python2.7** and **python3.6**. | - | | | - **python3.6**, **python2.7**, and **tf2.1-python3.7** indicate that the model can run on both CPUs and GPUs. For other runtime values, if the suffix contains **cpu** or **gpu**, the model can run only on CPUs or GPUs. | - | | python2.7 | - The default runtime is **python2.7**. | - | | | | - | | tf1.13-python2.7-gpu | | - | | | | - | | tf1.13-python2.7-cpu | | - | | | | - | | tf1.13-python3.6-gpu | | - | | | | - | | tf1.13-python3.6-cpu | | - | | | | - | | tf1.13-python3.7-cpu | | - | | | | - | | tf1.13-python3.7-gpu | | - | | | | - | | tf2.1-python3.7 | | - | | | | - | | tf1.15-aarch64-c76-d910 | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | MXNet | python3.7 | - MXNet 1.2.1 is used in **python3.6** and **python3.7**. | - | | | - **python3.6** and **python3.7** indicate that the model can run on both CPUs and GPUs. | - | | python3.6 | - The default runtime is **python3.6**. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Caffe | python3.6 | - Caffe 1.0.0 is used in **python3.6**, **python3.7**, **python3.6-gpu**, **python3.7-gpu**, **python3.6-cpu**, and **python3.7-cpu**. | - | | | - **python 3.6** and **python3.7** can only be used to run models on CPUs. For other runtime values, if the suffix contains **cpu** or **gpu**, the model can run only on CPUs or GPUs. Use the runtime of **python3.6-gpu**, **python3.7-gpu**, **python3.6-cpu**, or **python3.7-cpu**. | - | | python3.7 | - The default runtime is **python3.6**. | - | | | | - | | python3.6-gpu | | - | | | | - | | python3.7-gpu | | - | | | | - | | python3.6-cpu | | - | | | | - | | python3.7-cpu | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Spark_MLlib | python3.6 | - Spark_MLlib 2.3.2 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Scikit_Learn | python3.6 | - Scikit_Learn 0.18.1 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | XGBoost | python3.6 | - XGBoost 0.80 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | PyTorch | python3.6 | - PyTorch 1.0 is used in **python3.6** and **python3.7**. | - | | | - **python3.6**, **python3.7**, and **pytorch1.4-python3.7** indicate that the model can run on both CPUs and GPUs. | - | | python3.7 | - The default runtime is **python3.6**. | - | | | | - | | pytorch1.4-python3.7 | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | MindSpore | ms1.1-python3.7-c76 | MindSpore 1.1.1 is used. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/faqs/index.rst b/modelarts/umn/result/faqs/index.rst deleted file mode 100644 index a391ba40..00000000 --- a/modelarts/umn/result/faqs/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _modelarts_05_0000: - -==== -FAQs -==== - -.. toctree:: - :maxdepth: 1 - - general_issues/index - exeml/index - data_management/index - development_environment/index - training_jobs/index - model_management/index - service_deployment/index diff --git a/modelarts/umn/result/faqs/model_management/how_do_i_import_a_model_downloaded_from_obs_to_modelarts.rst b/modelarts/umn/result/faqs/model_management/how_do_i_import_a_model_downloaded_from_obs_to_modelarts.rst deleted file mode 100644 index 9639ff5e..00000000 --- a/modelarts/umn/result/faqs/model_management/how_do_i_import_a_model_downloaded_from_obs_to_modelarts.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _modelarts_05_0124: - -How Do I Import a Model Downloaded from OBS to ModelArts? -========================================================= - -ModelArts allows you to upload local models to OBS or import models stored in OBS directly into ModelArts. - -For details about how to import a model from OBS, see Importing a Meta Model from OBS. diff --git a/modelarts/umn/result/faqs/model_management/index.rst b/modelarts/umn/result/faqs/model_management/index.rst deleted file mode 100644 index 0da2c25a..00000000 --- a/modelarts/umn/result/faqs/model_management/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _modelarts_05_0016: - -================ -Model Management -================ - -.. toctree:: - :maxdepth: 1 - - how_do_i_import_a_model_downloaded_from_obs_to_modelarts diff --git a/modelarts/umn/result/faqs/service_deployment/how_do_i_describe_the_dependencies_between_installation_packages_and_model_configuration_files_when_a_model_is_imported.rst b/modelarts/umn/result/faqs/service_deployment/how_do_i_describe_the_dependencies_between_installation_packages_and_model_configuration_files_when_a_model_is_imported.rst deleted file mode 100644 index cb5d8685..00000000 --- a/modelarts/umn/result/faqs/service_deployment/how_do_i_describe_the_dependencies_between_installation_packages_and_model_configuration_files_when_a_model_is_imported.rst +++ /dev/null @@ -1,61 +0,0 @@ -.. _modelarts_05_0161: - -How Do I Describe the Dependencies Between Installation Packages and Model Configuration Files When a Model Is Imported? -======================================================================================================================== - -Symptom -------- - -When importing a model from OBS or a container image, compile a model configuration file. The model configuration file describes the model usage, computing framework, precision, inference code dependency package, and model API. The configuration file must be in JSON format. In the configuration file, **dependencies** indicates the packages that the model inference code depends on. Model developers need to provide the package name, installation mode, and version constraints. For details about the parameters, see . The dependency structure array needs to be set for the **dependencies** parameter. - -Solution --------- - -When the installation package has dependency relationships, the **dependencies** parameter in the model configuration file supports multiple **dependency** structure arrays, which are entered in list format. - -The dependencies in list format must be installed in sequence. For example, install **Cython**, **pytest-runner**, and **pytest** before installing **mmcv-full**. When entering the installation packages in list format in the configuration file, write **Cython**, **pytest-runner**, and **pytest** in front of the **mmcv-full** structure array. - -Example: - -.. code-block:: - - "dependencies": [ - { - "installer": "pip", - "packages": [ - { - "package_name": "Cython" - }, - { - "package_name": "pytest-runner" - }, - { - "package_name": "pytest" - }] - }, - - { - "installer": "pip", - "packages": [ - { - "restraint": "ATLEAST", - "package_version": "5.0.0", - "package_name": "Pillow" - }, - { - "restraint": "ATLEAST", - "package_version": "1.4.0", - "package_name": "torch" - }, - { - "restraint": "ATLEAST", - "package_version": "1.19.1", - "package_name": "numpy" - }, - { - "restraint": "ATLEAST", - "package_version": "1.2.0", - "package_name": "mmcv-full" - }] - } - ] diff --git a/modelarts/umn/result/faqs/service_deployment/index.rst b/modelarts/umn/result/faqs/service_deployment/index.rst deleted file mode 100644 index 6511c49d..00000000 --- a/modelarts/umn/result/faqs/service_deployment/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_05_0017: - -================== -Service Deployment -================== - -.. toctree:: - :maxdepth: 1 - - what_types_of_services_can_models_be_deployed_as_on_modelarts - what_should_i_do_if_a_conflict_occurs_when_deploying_a_model_as_a_real-time_service - how_do_i_describe_the_dependencies_between_installation_packages_and_model_configuration_files_when_a_model_is_imported diff --git a/modelarts/umn/result/faqs/service_deployment/what_should_i_do_if_a_conflict_occurs_when_deploying_a_model_as_a_real-time_service.rst b/modelarts/umn/result/faqs/service_deployment/what_should_i_do_if_a_conflict_occurs_when_deploying_a_model_as_a_real-time_service.rst deleted file mode 100644 index 8146959f..00000000 --- a/modelarts/umn/result/faqs/service_deployment/what_should_i_do_if_a_conflict_occurs_when_deploying_a_model_as_a_real-time_service.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. _modelarts_05_0100: - -What Should I Do If a Conflict Occurs When Deploying a Model As a Real-Time Service? -==================================================================================== - -Before importing a model, you need to place the corresponding inference code and configuration file in the model folder. When encoding with Python, you are advised to use a relative import (Python import) to import custom packages. - -If the relative import mode is not used, a conflict will occur once a package with the same name exists in a real-time service. As a result, model deployment or prediction fails. diff --git a/modelarts/umn/result/faqs/service_deployment/what_types_of_services_can_models_be_deployed_as_on_modelarts.rst b/modelarts/umn/result/faqs/service_deployment/what_types_of_services_can_models_be_deployed_as_on_modelarts.rst deleted file mode 100644 index feb13be2..00000000 --- a/modelarts/umn/result/faqs/service_deployment/what_types_of_services_can_models_be_deployed_as_on_modelarts.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. _modelarts_05_0012: - -What Types of Services Can Models Be Deployed as on ModelArts? -============================================================== - -Currently, models can only be deployed as real-time services and batch services. diff --git a/modelarts/umn/result/faqs/training_jobs/error_message_no_such_file_or_directory_displayed_in_training_job_logs.rst b/modelarts/umn/result/faqs/training_jobs/error_message_no_such_file_or_directory_displayed_in_training_job_logs.rst deleted file mode 100644 index 69a5276b..00000000 --- a/modelarts/umn/result/faqs/training_jobs/error_message_no_such_file_or_directory_displayed_in_training_job_logs.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _modelarts_05_0032: - -Error Message "No such file or directory" Displayed in Training Job Logs -======================================================================== - -Issue Analysis --------------- - -When you use ModelArts, your data is stored in the OBS bucket. The data has a corresponding OBS path, for example, **bucket_name/dir/image.jpg**. ModelArts training jobs run in containers, and if they need to access OBS data, they need to know what path to access it from. If ModelArts cannot find the configured path, it is possible that the selected data storage path was configured incorrectly when the training job was created or that the OBS path in the code file is incorrect. - -Solution --------- - -#. Confirm that the OBS path in the log exists. - - Locate the incorrect OBS path in the log, for example, **obs-test/ModelArts/examples/**. There are two methods to check whether it exists. - - - On OBS Console, check whether the OBS path exists. - - Log in to OBS console using the current account, and check whether the OBS buckets, folders, and files exist in the OBS path displayed in the log. For example, you can confirm that a given bucket is there and then check if that bucket contains the folder you are looking for based on the configured path. - - - If the file path exists, go to :ref:`2 `. - - If it does not exist, change the path configured for the training job to an OBS bucket path that is actually there. - - - Create a notebook instance, and use an API to check whether the directory exists. In an existing notebook instance or after creating a new notebook instance, run the following command to check whether the directory exists: - - .. code-block:: - - import moxing as mox - mox.file.exists('obs://obs-test/ModelArts/examples/') - - - If it exists, go to :ref:`2 `. - - If it does not exist, change it to an available OBS bucket path in the training job. - -#. .. _modelarts_05_0032__en-us_topic_0000001096606439_en-us_topic_0285164857_en-us_topic_0166743701_li77081222112915: - - After confirming that the path exists, check whether OBS and ModelArts are in the same region and whether the OBS bucket belongs to another account. - - Log in to the ModelArts console and view the region where ModelArts resides. Log in to the OBS console and view the region where the OBS bucket resides. Check whether they reside in the same region and whether the OBS bucket belongs to another account. - - - If they are in the same region and the OBS bucket does not belong to another account, go to :ref:`3 `. - - If they are not in the same region or the OBS bucket belongs to another account, create a bucket and a folder in OBS that is in the same region as ModelArts using the same account, and upload data to the bucket. - -#. .. _modelarts_05_0032__en-us_topic_0000001096606439_en-us_topic_0285164857_en-us_topic_0166743701_li166204369185: - - In the script of the training job, check whether the API for reading the OBS path in the code file is correct. diff --git a/modelarts/umn/result/faqs/training_jobs/how_do_i_create_a_training_job_when_a_dependency_package_is_referenced_in_a_model.rst b/modelarts/umn/result/faqs/training_jobs/how_do_i_create_a_training_job_when_a_dependency_package_is_referenced_in_a_model.rst deleted file mode 100644 index 9bb4c8ea..00000000 --- a/modelarts/umn/result/faqs/training_jobs/how_do_i_create_a_training_job_when_a_dependency_package_is_referenced_in_a_model.rst +++ /dev/null @@ -1,50 +0,0 @@ -.. _modelarts_05_0063: - -How Do I Create a Training Job When a Dependency Package Is Referenced in a Model? -================================================================================== - -When a model references a dependency package, select a frequently-used framework to create training jobs. In addition, place the required file or installation package in the code directory. The requirements vary based on the dependency package that you use. - -- **Open-source installation package** - - .. note:: - - It is not allowed to install the package using the GitHub source code. - - Create a file named **pip-requirements.txt** in the code directory. In this file, specify the name and version of the dependency package in the format of *Package name*\ **==**\ *Version*. - - For example, the OBS path specified by **Code Directory** contains model files and the **pip-requirements.txt** file. The following shows the code directory structure: - - .. code-block:: - - |---OBS path to the model boot file - |---model.py #Model boot file - |---pip-requirements.txt #Customized configuration file, which specifies the name and version of the dependency package - - The following shows the content of the **pip-requirements.txt** file: - - .. code-block:: - - alembic==0.8.6 - bleach==1.4.3 - click==6.6 - -- **Customized WHL file** - - When you use a customized .whl file, the system cannot automatically download and install the file. Place the .whl file in the code directory, create a file named **pip-requirements.txt**, and specify the name of the .whl file in the created file. The dependency package must be a .whl file. - - For example, the OBS path specified by **Code Directory** contains model files, .whl file, and **pip-requirements.txt** file. The following shows the code directory structure: - - .. code-block:: - - |---OBS path to the model boot file - |---model.py #Model boot file - |---XXX.whl #Dependency package. If multiple dependencies are required, place all of them here. - |---pip-requirements.txt #Customized configuration file, which specifies the name of the dependency package - - The following shows the content of the **pip-requirements.txt** file: - - .. code-block:: - - numpy-1.15.4-cp36-cp36m-manylinux1_x86_64.whl - tensorflow-1.8.0-cp36-cp36m-manylinux1_x86_64.whl diff --git a/modelarts/umn/result/faqs/training_jobs/index.rst b/modelarts/umn/result/faqs/training_jobs/index.rst deleted file mode 100644 index dc362877..00000000 --- a/modelarts/umn/result/faqs/training_jobs/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_05_0030: - -============= -Training Jobs -============= - -.. toctree:: - :maxdepth: 1 - - what_can_i_do_if_the_message_object_directory_size_quantity_exceeds_the_limit_is_displayed_when_i_create_a_training_job - error_message_no_such_file_or_directory_displayed_in_training_job_logs - how_do_i_create_a_training_job_when_a_dependency_package_is_referenced_in_a_model - what_are_sizes_of_the__cache_directories_for_different_resource_specifications_in_the_training_environment diff --git a/modelarts/umn/result/faqs/training_jobs/what_are_sizes_of_the__cache_directories_for_different_resource_specifications_in_the_training_environment.rst b/modelarts/umn/result/faqs/training_jobs/what_are_sizes_of_the__cache_directories_for_different_resource_specifications_in_the_training_environment.rst deleted file mode 100644 index 3e304e09..00000000 --- a/modelarts/umn/result/faqs/training_jobs/what_are_sizes_of_the__cache_directories_for_different_resource_specifications_in_the_training_environment.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _modelarts_05_0090: - -What Are Sizes of the /cache Directories for Different Resource Specifications in the Training Environment? -=========================================================================================================== - -When creating a training job, you can select CPU, GPU, or Ascend resources based on the size of the training job. - -ModelArts mounts the disk to the **/cache** directory. You can use this directory to store temporary files. The **/cache** directory shares resources with the code directory. The directory has different capacities for different resource specifications. - -- GPU resources - - .. table:: **Table 1** Capacities of the cache directories for GPU resources - - ================== ======================== - GPU Specifications cache Directory Capacity - ================== ======================== - V100 800G - 8*V100 3T - P100 800G - ================== ======================== - -- CPU resources - - .. table:: **Table 2** Capacities of the cache directories for CPU resources - - ================== ======================== - CPU Specifications cache Directory Capacity - ================== ======================== - 2 vCPUs \| 8 GiB 50G - 8 vCPUs \| 32 GiB 50G - ================== ======================== - -- Ascend resources - - .. table:: **Table 3** Capacities of the cache directories for Ascend resources - - ===================== ======================== - Ascend Specifications cache Directory Capacity - ===================== ======================== - Ascend 910 3T - ===================== ======================== diff --git a/modelarts/umn/result/faqs/training_jobs/what_can_i_do_if_the_message_object_directory_size_quantity_exceeds_the_limit_is_displayed_when_i_create_a_training_job.rst b/modelarts/umn/result/faqs/training_jobs/what_can_i_do_if_the_message_object_directory_size_quantity_exceeds_the_limit_is_displayed_when_i_create_a_training_job.rst deleted file mode 100644 index 98c99ffc..00000000 --- a/modelarts/umn/result/faqs/training_jobs/what_can_i_do_if_the_message_object_directory_size_quantity_exceeds_the_limit_is_displayed_when_i_create_a_training_job.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_05_0031: - -What Can I Do If the Message "Object directory size/quantity exceeds the limit" Is Displayed When I Create a Training Job? -========================================================================================================================== - -Issue Analysis --------------- - -The code directory for creating a training job has limits on the size and number of files. - -Solution --------- - -Delete the files except the code from the code directory or save the files in other directories. Ensure that the size of the code directory does not exceed 128 MB and the number of files does not exceed 4,096. diff --git a/modelarts/umn/result/index.rst b/modelarts/umn/result/index.rst deleted file mode 100644 index 3e184d1c..00000000 --- a/modelarts/umn/result/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -========== -Main Index -========== - -.. toctree:: - :maxdepth: 1 - - service_overview/index - preparations/index - exeml/index - data_management/index - devenviron_notebook/index - training_management/index - model_management/index - model_deployment/index - resource_pools - custom_images/index - model_package_specifications/index - model_templates/index - examples_of_custom_scripts/index - permissions_management/index - monitoring/index - faqs/index - change_history diff --git a/modelarts/umn/result/model_deployment/batch_services/deploying_a_model_as_a_batch_service.rst b/modelarts/umn/result/model_deployment/batch_services/deploying_a_model_as_a_batch_service.rst deleted file mode 100644 index 14e15803..00000000 --- a/modelarts/umn/result/model_deployment/batch_services/deploying_a_model_as_a_batch_service.rst +++ /dev/null @@ -1,248 +0,0 @@ -.. _modelarts_23_0066: - -Deploying a Model as a Batch Service -==================================== - -After a model is prepared, you can deploy it as a batch service. The **Service Deployment > Batch Services** page lists all batch services. You can enter a service name in the search box in the upper right corner and click |image1| to query the service. - -Prerequisites -------------- - -- Data has been prepared. Specifically, you have created a model in the **Normal** state in ModelArts. -- Data to be batch processed is ready and has been upload to an OBS directory. -- At least one empty folder has been created on OBS for storing the output. - -Background ----------- - -- A maximum of 1,000 batch services can be created. -- Based on the input request (JSON or other file) defined by the model, different parameter are entered. If the model input is a JSON file, a configuration file is required to generate a mapping file. If the model input is other file, no mapping file is required. -- Batch services can only be deployed in a public resource pool, but not a dedicated resource pool. - -Procedure ---------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Service Deployment** > **Batch Services**. By default, the **Batch Services** page is displayed. - -#. In the batch service list, click **Deploy** in the upper left corner. The **Deploy** page is displayed. - -#. Set parameters for a batch service. - - a. Set the basic information, including **Name** and **Description**. The name is generated by default, for example, **service-bc0d**. You can specify **Name** and **Description** according to actual requirements. - - b. Set other parameters, including model configurations. For details, see :ref:`Table 1 `. - - .. _modelarts_23_0066__en-us_topic_0171858292_table1029041641314: - - .. table:: **Table 1** Parameters - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+======================================================================================================================================================================================================================================================================================================================================================================+ - | Model and Version | Select the model and version that are in the **Normal** state. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input Path | Select the OBS directory where the data is to be uploaded. Select a folder or a **.manifest** file. For details about the specifications of the **.manifest** file, see :ref:`Manifest File Specifications `. | - | | | - | | .. note:: | - | | | - | | - If the input data is an image, ensure that the size of a single image is less than 10 MB. | - | | - If the input data is in CSV format, ensure that no Chinese character is included. To use Chinese, set the file encoding format to UTF-8. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Request Path | API URI of a batch service. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Mapping Relationship | If the model input is in JSON format, the system automatically generates the mapping based on the configuration file corresponding to the model. If the model input is other file, mapping is not required. | - | | | - | | Automatically generated mapping file. Enter the field index corresponding to each parameter in the CSV file. The index starts from 0. | - | | | - | | Mapping rule: The mapping rule comes from the input parameter (**request**) in the model configuration file **config.json**. When **type** is set to **string/number/integer/boolean**, you are required to set the index parameter. For details about the mapping rule, see :ref:`Example Mapping `. | - | | | - | | The index must be a positive integer starting from 0. If the value of index does not comply with the rule, this parameter is ignored in the request. After the mapping rule is configured, the corresponding CSV data must be separated by commas (,). | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Output Path | Select the path for saving the batch prediction result. You can select the empty folder that you create. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Specifications | Select available specifications based on the list displayed on the console. The specifications in gray cannot be used at the current site. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Compute Nodes | Set the number of instances for the current model version. If you set **Instances** to **1**, the standalone computing mode is used. If you set **Instances** to a value greater than 1, the distributed computing mode is used. Select a computing mode based on the actual requirements. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Environment Variable | Set environment variables and inject them to the container instance. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. After setting the parameters, deploy the model as a batch service as prompted. Generally, service deployment jobs run for a period of time, which may be several minutes or tens of minutes depending on the amount of your selected data and resources. - - You can go to the batch service list to view the basic information about the batch service. In the batch service list, after the status of the newly deployed service changes from **Deploying** to **Running**, the service is deployed successfully. - -.. _modelarts_23_0066__en-us_topic_0171858292_section190619315314: - -Manifest File Specifications ----------------------------- - -Batch services of the inference platform support the manifest file. The manifest file describes the input and output of data. - -**Example input manifest file** - -- File name: **test.manifest** - -- File content: - - .. code-block:: - - {"source": "/test/data/1.jpg"} - {"source": "https://infers-data.obs.xxx.com:443/xgboosterdata/data.csv?AccessKeyId=2Q0V0TQ461N26DDL18RB&Expires=1550611914&Signature=wZBttZj5QZrReDhz1uDzwve8GpY%3D&x-obs-security-token=gQpzb3V0aGNoaW5hixvY8V9a1SnsxmGoHYmB1SArYMyqnQT-ZaMSxHvl68kKLAy5feYvLDM..."} - -- File requirements: - - #. The file name extension must be **.manifest**. - #. The file content is in JSON format. Each row describes a piece of input data, which must be accurate to a file instead of a folder. - -**Example output manifest file** - -If you use an input manifest file, the output directory will contain an output manifest file. - -- Assume that the output path is **//test-bucket/test/**. The result is stored in the following path: - - .. code-block:: - - OBS bucket/directory name - ├── test-bucket - │ ├── test - │ │ ├── infer-result-0.manifest - │ │ ├── infer-result - │ │ │ ├── 1.jpg_result.txt - │ │ │ ├── 2.jpg_result.txt - -- Content of the **infer-result-0.manifest** file: - - .. code-block:: - - {"source": "/obs-data-bucket/test/data/1.jpg", "inference-loc": "/test-bucket/test/infer-result/1.jpg_result.txt"} - {"source ": "https://infers-data.obs.xxx.com:443/xgboosterdata/2.jpg?AccessKeyId=2Q0V0TQ461N26DDL18RB&Expires=1550611914&Signature=wZBttZj5QZrReDhz1uDzwve8GpY%3D&x-obs-security-token=gQpzb3V0aGNoaW5hixvY8V9a1SnsxmGoHYmB1SArYMyqnQT-ZaMSxHvl68kKLAy5feYvLDMNZWxzhBZ6Q-3HcoZMh9gISwQOVBwm4ZytB_m8sg1fL6isU7T3CnoL9jmvDGgT9VBC7dC1EyfSJrUcqfB...", "inference-loc": "obs://test-bucket/test/infer-result/2.jpg_result.txt"} - -- File format: - - #. The file name is **infer-result-{{index}}.manifest**, where **index** is the instance ID. Each running instance of a batch service generates a manifest file. - #. The **infer-result** directory is created in the manifest directory to store the result. - #. The file content is in JSON format. Each row describes the output result of a piece of input data. - #. The content contains two fields: - - a. **source**: input data description, which is the same as that of the input manifest file - b. **inference-loc**: output result path in the format of **/{{Bucket name}}/{{Object name}}** - -.. _modelarts_23_0066__en-us_topic_0171858292_section119024213518: - -Example Mapping ---------------- - -The following example shows the relationship between the configuration file, mapping rule, CSV data, and inference request. - -Assume that the **apis** parameter in the configuration file used by your model is as follows: - -+-----------------------------------+-----------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | [ | -| 2 | { | -| 3 | "protocol": "http", | -| 4 | "method": "post", | -| 5 | "url": "/", | -| 6 | "request": { | -| 7 | "type": "object", | -| 8 | "properties": { | -| 9 | "data": { | -| 10 | "type": "object", | -| 11 | "properties": { | -| 12 | "req_data": { | -| 13 | "type": "array", | -| 14 | "items": [ | -| 15 | { | -| 16 | "type": "object", | -| 17 | "properties": { | -| 18 | "input_1": { | -| 19 | "type": "number" | -| 20 | }, | -| 21 | "input_2": { | -| 22 | "type": "number" | -| 23 | }, | -| 24 | "input_3": { | -| 25 | "type": "number" | -| 26 | }, | -| 27 | "input_4": { | -| 28 | "type": "number" | -| 29 | } | -| 30 | } | -| 31 | } | -| 32 | ] | -| 33 | } | -| 34 | } | -| 35 | } | -| 36 | } | -| 37 | } | -| 38 | } | -| 39 | ] | -+-----------------------------------+-----------------------------------------------------------------+ - -At this point, the corresponding mapping relationship is shown below. The ModelArts management console automatically resolves the mapping relationship from the configuration file. When calling a ModelArts API, write the mapping relationship by yourself according to the rule. - -.. code-block:: - - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "req_data": { - "type": "array", - "items": [ - { - "type": "object", - "properties": { - "input_1": { - "type": "number", - "index": 0 - }, - "input_2": { - "type": "number", - "index": 1 - }, - "input_3": { - "type": "number", - "index": 2 - }, - "input_4": { - "type": "number", - "index": 3 - } - } - } - ] - } - } - } - } - } - -The data for inference, that is, the CSV data, is in the following format. The data must be separated by commas (,). - -.. code-block:: - - 5.1,3.5,1.4,0.2 - 4.9,3.0,1.4,0.2 - 4.7,3.2,1.3,0.2 - -Depending on the defined mapping relationship, the inference request is shown below. The format is similar to the format used by the real-time service. - -.. code-block:: - - { - "data": { - "req_data": [{ - "input_1": 5.1, - "input_2": 3.5, - "input_3": 1.4, - "input_4": 0.2 - }] - } - } - -.. |image1| image:: /_static/images/en-us_image_0000001110760970.png - diff --git a/modelarts/umn/result/model_deployment/batch_services/index.rst b/modelarts/umn/result/model_deployment/batch_services/index.rst deleted file mode 100644 index a34f09c0..00000000 --- a/modelarts/umn/result/model_deployment/batch_services/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0065: - -============== -Batch Services -============== - -.. toctree:: - :maxdepth: 1 - - deploying_a_model_as_a_batch_service - viewing_the_batch_service_prediction_result diff --git a/modelarts/umn/result/model_deployment/batch_services/viewing_the_batch_service_prediction_result.rst b/modelarts/umn/result/model_deployment/batch_services/viewing_the_batch_service_prediction_result.rst deleted file mode 100644 index 0596df52..00000000 --- a/modelarts/umn/result/model_deployment/batch_services/viewing_the_batch_service_prediction_result.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_23_0067: - -Viewing the Batch Service Prediction Result -=========================================== - -When deploying a batch service, you can select the location of the output data directory. You can view the running result of the batch service that is in the **Running completed** status. - -Procedure ---------- - -#. Log in to the ModelArts management console and choose **Service Deployment** > **Batch Services**. -#. Click the name of the target service in the **Running completed** status. The service details page is displayed. - - - You can view the service name, status, ID, input path, output path, and description. - - You can click |image1| in the **Description** area to edit the description. - -#. Obtain the detailed OBS path next to **Output Path**, switch to the path and obtain the batch service prediction result. - - - If images are entered, a result file is generated for each image in the *Image name*\ **\__result.txt** format, for example, **IMG_20180919_115016.jpg_result.txt**. - - If audio files are entered, a result file is generated for each audio file in the *Audio file name*\ **\__result.txt** format, for example, **1-36929-A-47.wav_result.txt**. - - If table data is entered, the result file is generated in the *Table name*\ **\__result.txt** format, for example, **train.csv_result.txt**. - -.. |image1| image:: /_static/images/en-us_image_0000001157080919.png - diff --git a/modelarts/umn/result/model_deployment/deleting_a_service.rst b/modelarts/umn/result/model_deployment/deleting_a_service.rst deleted file mode 100644 index 5b574417..00000000 --- a/modelarts/umn/result/model_deployment/deleting_a_service.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _modelarts_23_0073: - -Deleting a Service -================== - -If a service is no longer in use, you can delete it to release resources. - -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. - - a. For a real-time service, choose **More > Delete** in the **Operation** column to delete it. - b. For a batch service, click **Delete** in the **Operation** column to delete it. - - .. note:: - - A deleted service cannot be recovered. Exercise caution when performing this operation. diff --git a/modelarts/umn/result/model_deployment/index.rst b/modelarts/umn/result/model_deployment/index.rst deleted file mode 100644 index bd3c7823..00000000 --- a/modelarts/umn/result/model_deployment/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _modelarts_23_0057: - -================ -Model Deployment -================ - -.. toctree:: - :maxdepth: 1 - - introduction_to_model_deployment - real-time_services/index - batch_services/index - modifying_a_service - starting_or_stopping_a_service - deleting_a_service diff --git a/modelarts/umn/result/model_deployment/introduction_to_model_deployment.rst b/modelarts/umn/result/model_deployment/introduction_to_model_deployment.rst deleted file mode 100644 index 6cfb2302..00000000 --- a/modelarts/umn/result/model_deployment/introduction_to_model_deployment.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_23_0058: - -Introduction to Model Deployment -================================ - -After a training job is complete and a model is generated, you can deploy the model on the **Service Deployment** page. You can also deploy the model imported from OBS. ModelArts supports the following deployment types: - -- :ref:`Real-Time Services ` - - Deploy a model as a web service to provide real-time test UI and monitoring capabilities. - -- :ref:`Batch Services ` - - A batch service can perform inference on batch data. After data processing is complete, the batch service automatically stops. diff --git a/modelarts/umn/result/model_deployment/modifying_a_service.rst b/modelarts/umn/result/model_deployment/modifying_a_service.rst deleted file mode 100644 index 85d42416..00000000 --- a/modelarts/umn/result/model_deployment/modifying_a_service.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _modelarts_23_0071: - -Modifying a Service -=================== - -For a deployed service, you can modify its basic information to match service changes. You can modify the basic information about a service in either of the following ways: - -:ref:`Method 1: Modify Service Information on the Service Management Page ` - -:ref:`Method 2: Modify Service Information on the Service Details Page ` - -Prerequisites -------------- - -A service has been deployed. - -.. _modelarts_23_0071__en-us_topic_0172547189_section6987155265816: - -Method 1: Modify Service Information on the Service Management Page -------------------------------------------------------------------- - -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. -#. In the service list, click **Modify** in the **Operation** column of the target service, modify basic service information, and click **OK**. - - - For details about the real-time service parameters, see :ref:`Deploying a Model as a Real-Time Service `. - - For details about the batch service parameters, see :ref:`Deploying a Model as a Batch Service `. - - .. note:: - - Services in the **Deploying** status cannot be modified. - -.. _modelarts_23_0071__en-us_topic_0172547189_section12604201617210: - -Method 2: Modify Service Information on the Service Details Page ----------------------------------------------------------------- - -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. -#. Click the name of the target service. The service details page is displayed. -#. Click **Modify** in the upper right corner of the page, modify the service details, and click **OK**. - - - For details about the real-time service parameters, see :ref:`Deploying a Model as a Real-Time Service `. - - For details about the batch service parameters, see :ref:`Deploying a Model as a Batch Service `. diff --git a/modelarts/umn/result/model_deployment/real-time_services/accessing_a_real-time_service_token-based_authentication.rst b/modelarts/umn/result/model_deployment/real-time_services/accessing_a_real-time_service_token-based_authentication.rst deleted file mode 100644 index e5a0c87a..00000000 --- a/modelarts/umn/result/model_deployment/real-time_services/accessing_a_real-time_service_token-based_authentication.rst +++ /dev/null @@ -1,87 +0,0 @@ -.. _modelarts_23_0063: - -Accessing a Real-Time Service (Token-based Authentication) -========================================================== - -If a real-time service is in the **Running** state, the real-time service has been deployed successfully. This service provides a standard RESTful API for users to call. Before integrating the API to the production environment, commission the API. You can use either of the following methods to send an inference request to the real-time service: - -:ref:`Method 1: Use GUI-based Software for Inference (Postman) ` (Postman is recommended for Windows.) - -:ref:`Method 2: Run the cURL Command to Send an Inference Request ` (curl commands are recommended for Linux.) - -.. _modelarts_23_0063__en-us_topic_0165025308_section959354162911: - -Method 1: Use GUI-based Software for Inference (Postman) --------------------------------------------------------- - -#. Download Postman and install it, or install the Postman Chrome extension. Alternatively, use other software that can send POST requests. Postman 7.24.0 is recommended. -#. Open Postman. -#. Set parameters on Postman. The following uses image classification as an example. - - - Select a POST task and copy the API URL to the POST text box. To obtain the API URL of the real-time service, switch to the **Usage Guides** tab on the page providing details about the real-time service. On the **Headers** tab page, set **Key** to **X-Auth-Token** and **Value** to the obtained token. - - On the **Body** tab page, file input and text input are available. - - - **File input** - - Select **form-data**. Set **KEY** to the input parameter of the model, for example, **images**. Set **VALUE** to an image to be inferred (only one image can be inferred). - - - **Text input** - - Select **raw** and then **JSON(application/json)**. Enter the request body in the text box below. An example request body is as follows: - - .. code-block:: - - { - "meta": { - "uuid": "10eb0091-887f-4839-9929-cbc884f1e20e" - }, - "data": { - "req_data": [ - { - "sepal_length": 3, - "sepal_width": 1, - "petal_length": 2.2, - "petal_width": 4 - } - ] - } - } - - **meta** can carry a universally unique identifier (UUID). When you call an API, the system provides a UUID. When the inference result is returned, the UUID is returned to trace the request. If you do not need this function, leave **meta** blank. **data** contains a **req_data** array for one or multiple pieces of input data. The parameters of each piece of data are determined by the model, such as **sepal_length** and **sepal_width** in this example. - -#. After setting the parameters, click **Send** to send the request. The result is displayed in the response. - - - Inference result using file input: The field values in the return result vary with the model. - - Inference result using text input: The request body contains **meta** and **data**. If the request contains **uuid**, **uuid** will be returned in the response. Otherwise, **uuid** is left blank. **data** contains a **resp_data** array for the inference results of one or multiple pieces of input data. The parameters of each result are determined by the model, for example, **sepal_length** and **predictresult** in this example. - -.. _modelarts_23_0063__en-us_topic_0165025308_section104131434203114: - -Method 2: Run the cURL Command to Send an Inference Request ------------------------------------------------------------ - -The command for sending inference requests can be input as a file or text. - -#. File input - - .. code-block:: - - curl -k -F 'images=@Image path' -H 'X-Auth-Token:Token value' -X POST Real-time service URL - - - **-k** indicates that SSL websites can be accessed without using a security certificate. - - **-F** indicates file input. In this example, the parameter name is **images**, which can be changed as required. The image storage path follows **@**. - - **-H** indicates the header of the POST command. **X-Auth-Token** is the **KEY** value on the **Headers** page. *Token value* indicates the obtained token. For details about how to obtain the token, see . - - **POST** is followed by the API URL of the real-time service. - - The following is an example of the cURL command for inference with file input: - - .. code-block:: - - curl -k -F 'images=@/home/data/test.png' -H 'X-Auth-Token:MIISkAY***80T9wHQ==' -X POST https://modelarts-infers-1.xxx/v1/infers/eb3e0c54-3dfa-4750-af0c-95c45e5d3e83 - -#. Text input - - .. code-block:: - - curl -k -d '{"data":{"req_data":[{"sepal_length":3,"sepal_width":1,"petal_length":2.2,"petal_width":4}]}}' -H 'X-Auth-Token:MIISkAY***80T9wHQ==' -H 'Content-type: application/json' -X POST https://modelarts-infers-1.xxx/v1/infers/eb3e0c54-3dfa-4750-af0c-95c45e5d3e83 - - **-d** indicates the text input of the request body. diff --git a/modelarts/umn/result/model_deployment/real-time_services/deploying_a_model_as_a_real-time_service.rst b/modelarts/umn/result/model_deployment/real-time_services/deploying_a_model_as_a_real-time_service.rst deleted file mode 100644 index 748bb780..00000000 --- a/modelarts/umn/result/model_deployment/real-time_services/deploying_a_model_as_a_real-time_service.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. _modelarts_23_0060: - -Deploying a Model as a Real-Time Service -======================================== - -After a model is prepared, you can deploy the model as a real-time service and predict and call the service. - -.. note:: - - A maximum of 20 real-time services can be deployed by a user. - -Prerequisites -------------- - -- Data has been prepared. Specifically, you have created a model in the **Normal** state in ModelArts. - -Procedure ---------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Service Deployment** > **Real-Time Services**. By default, the system switches to the **Real-Time Services** page. - -#. In the real-time service list, click **Deploy** in the upper left corner. The **Deploy** page is displayed. - -#. Set parameters for a real-time service. - - a. Set basic information about model deployment. For details about the parameters, see :ref:`Table 1 `. - - .. _modelarts_23_0060__en-us_topic_0165025304_table16373156155613: - - .. table:: **Table 1** Basic parameters of model deployment - - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+================================================================================================================================================================================================================+ - | Name | Name of the real-time service. Set this parameter as prompted. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Auto Stop | After this parameter is enabled and the auto stop time is set, a service automatically stops at the specified time. The auto stop function is enabled by default, and the default value is **1 hour later**. | - | | | - | | The options are **1 hour later**, **2 hours later**, **4 hours later**, **6 hours later**, and **Custom**. If you select **Custom**, you can enter any integer from 1 to 24 hours in the textbox on the right. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of the real-time service. | - +-----------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Enter key information including the resource pool and model configurations. For details, see :ref:`Table 2 `. - - .. _modelarts_23_0060__en-us_topic_0165025304_table10352134481117: - - .. table:: **Table 2** Parameters - - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Sub-Parameter | Description | - +=========================+=============================+============================================================================================================================================================================================================================================================================================+ - | Resource Pool | Public resource pools | Instances in the public resource pool can be of the CPU or GPU type. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Resource Pool | Dedicated resource pools | For details about how to create a dedicated resource pool, see :ref:`Creating a Dedicated Resource Pool `. You can select a specification from the resource pool specifications. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Model and Configuration | Model Source | You can select **My Models** or **My Subscriptions** based on site requirements. The models that match the model sources are displayed. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Model | The system automatically associates with the list of available models. Select a model in the **Normal** status and its version. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Traffic Ratio (%) | Set the traffic proportion of the current instance node. Service calling requests are allocated to the current version based on this proportion. | - | | | | - | | | If you deploy only one version of a model, set this parameter to **100%**. If you select multiple versions for gated launch, ensure that the sum of the traffic ratios of multiple versions is **100%**. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Specifications | If you select **Public resource pools**, you can select the CPU or GPU resources based on site requirements. For details, see :ref:`Table 3 `. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Compute Nodes | Set the number of instances for the current model version. If you set **Instances** to **1**, the standalone computing mode is used. If you set **Instances** to a value greater than 1, the distributed computing mode is used. Select a computing mode based on the actual requirements. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Environment Variable | Set environment variables and inject them to the container instance. To ensure data security, do not enter sensitive information, such as plaintext passwords, in environment variables. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Add Model and Configuration | ModelArts supports multiple model versions and flexible traffic policies. You can use gated launch to smoothly upgrade the model version. | - | | | | - | | | .. note:: | - | | | | - | | | If the selected model has only one version, the system does not display **Add Model Version and Configuration**. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Traffic Limit | N/A | Maximum number of times a service can be accessed within a second. You can set this parameter as needed. | - +-------------------------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_23_0060__en-us_topic_0165025304_table117211414482: - - .. table:: **Table 3** Supported specifications - - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | Specifications | Description | - +================================================+===========================================================================================+ - | ExeML specifications (CPU) | Only be used by models trained in ExeML projects. | - | | | - | ExeML specifications (GPU) | | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | CPU: 2 vCPUs \| 8 GiB | Suitable for models with only CPU loads. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | CPU: 8 vCPUs \| 64 GiB GPU: 1 x V100 | Suitable for running GPU models. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | CPU: 8 vCPUs \| 32 GiB GPU: 1 x T4 | Suitable for models requiring CPU and GPU (NVIDIA T4) resources. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | Arm: 3 vCPUs \| 6 GiB Ascend: 1 x Ascend 310 | Carrying one Ascend 310 chip, suitable for models requiring Ascend 310 chip resources. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | Ascend: 1 x Ascend 910 CPU: 24 vCPUs \| 96 GiB | Carrying one Ascend 910 chip, suitable for models requiring Ascend 910 chip resources. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - | Ascend: 8 Ascend 910 CPU: 192 vCPUs \| 720 GiB | Carrying eight Ascend 910 chips, suitable for models requiring Ascend 910 chip resources. | - +------------------------------------------------+-------------------------------------------------------------------------------------------+ - -#. After confirming the entered information, complete service deployment as prompted. Generally, service deployment jobs run for a period of time, which may be several minutes or tens of minutes depending on the amount of your selected data and resources. - - .. note:: - - After a real-time service is deployed, it is started immediately. - - You can go to the real-time service list to view the basic information about the real-time service. In the real-time service list, after the status of the newly deployed service changes from **Deploying** to **Running**, the service is deployed successfully. diff --git a/modelarts/umn/result/model_deployment/real-time_services/index.rst b/modelarts/umn/result/model_deployment/real-time_services/index.rst deleted file mode 100644 index 9ae0bcde..00000000 --- a/modelarts/umn/result/model_deployment/real-time_services/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0059: - -================== -Real-Time Services -================== - -.. toctree:: - :maxdepth: 1 - - deploying_a_model_as_a_real-time_service - viewing_service_details - testing_a_service - accessing_a_real-time_service_token-based_authentication diff --git a/modelarts/umn/result/model_deployment/real-time_services/testing_a_service.rst b/modelarts/umn/result/model_deployment/real-time_services/testing_a_service.rst deleted file mode 100644 index 48997a92..00000000 --- a/modelarts/umn/result/model_deployment/real-time_services/testing_a_service.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _modelarts_23_0062: - -Testing a Service -================= - -After a model is deployed as a real-time service, you can debug code or add files for testing on the **Prediction** tab page. Based on the input request (JSON text or file) defined by the model, the service can be tested in either of the following ways: - -#. :ref:`JSON Text Prediction `: If the input type of the model of the deployed service is JSON text, that is, the input does not contain files, you can enter the JSON code on the **Prediction** tab page for service testing. -#. :ref:`File Prediction (Images and Audios) `: If the input type of the model of the deployed service is file, including images, audios, and videos, you can add images on the **Prediction** tab page for service testing. - -.. note:: - - - If the input type is image, the size of a single image must be less than 10 MB. - - The following image types are supported: png, psd, jpg, jpeg, bmp, gif, webp, psd, svg, and tiff. - -Input Parameters ----------------- - -For the service that you have deployed, you can learn about its input parameters of the service, that is, the input request type mentioned above, on the **Usage Guides** tab page of the service details page. - -The input parameters displayed on the **Usage Guides** tab page depend on the model source that you select. - -- If your model comes from ExeML or a built-in algorithm, the input and output parameters are defined by ModelArts. For details, see the **Usage Guides** tab page. On the **Prediction** tab page, enter the corresponding JSON text or file for service testing. - -- If you use a custom model with the inference code and configuration file compiled by yourself (:ref:`Specifications for Compiling the Model Configuration File `), the **Usage Guides** tab page only visualizes your data. The following figure shows the mapping between the input parameters displayed on the **Usage Guides** tab page and the configuration file. - - .. _modelarts_23_0062__en-us_topic_0165025306_fig668522620125: - - .. figure:: /_static/images/en-us_image_0000001156920823.png - :alt: **Figure 1** Mapping between the configuration file and Usage Guides - - - **Figure 1** Mapping between the configuration file and Usage Guides - -- If your model is imported using a model template, the input and output parameters vary with the template. For details, see :ref:`Introduction to Model Templates `. - -.. _modelarts_23_0062__en-us_topic_0165025306_section15840106121611: - -JSON Text Prediction --------------------- - -#. Log in to the ModelArts management console and choose **Service Deployment** > **Real-Time Services**. -#. On the **Real-Time Services** page, click the name of the target service. The service details page is displayed. On the **Prediction** tab page, enter the prediction code and click **Predict** to perform prediction. - -.. _modelarts_23_0062__en-us_topic_0165025306_section1666533761611: - -File Prediction (Images and Audios) ------------------------------------ - -#. Log in to the ModelArts management console and choose **Service Deployment** > **Real-Time Services**. -#. On the **Real-Time Services** page, click the name of the target service. The service details page is displayed. On the **Prediction** tab page, click **Upload** and select a test file. After the file is uploaded successfully, click **Predict** to perform a prediction test. diff --git a/modelarts/umn/result/model_deployment/real-time_services/viewing_service_details.rst b/modelarts/umn/result/model_deployment/real-time_services/viewing_service_details.rst deleted file mode 100644 index 6f09d45a..00000000 --- a/modelarts/umn/result/model_deployment/real-time_services/viewing_service_details.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _modelarts_23_0061: - -Viewing Service Details -======================= - -After a model is deployed as a real-time service, you can access the service page to view its details. - -#. Log in to the ModelArts management console and choose **Service Deployment** > **Real-Time Services**. - -#. On the **Real-Time Services** page, click the name of the target service. The service details page is displayed. - - You can view the service name and status. For details, see :ref:`Table 1 `. - - .. _modelarts_23_0061__en-us_topic_0165025305_table54131529105213: - - .. table:: **Table 1** Real-time service parameters - - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=============================================================================================================================================================================================================================================================================================================================================+ - | Name | Name of the real-time service. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Status | Current status of the real-time service. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Source | Model source of the real-time service. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Failed Calls/Total Calls | Number of service calls, which is counted from the time when the service was created. | - | | | - | | If the number of models is changed or a service is invoked when a model is not ready, the number of calls is not counted. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Network Configuration | Customized network configuration of the used dedicated resource pool. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Service description, which can be edited after you click the edit button on the right side. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Custom Settings | Customized configurations based on real-time service versions. This allows version-based traffic distribution policies and configurations. Enable this option and click **View Settings** to customize the settings. For details, see :ref:`Modifying Customized Settings `. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data Collection | Enable this option to store the data generated when the real-time service is invoked to a specified OBS path. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Filter | Enable this option so that the system automatically identifies hard examples in all sample data. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Synchronize Data | Synchronize the collected data to a dataset for centralized management and utilization. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Traffic Limit | Maximum number of times a service can be accessed within a second. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. You can switch between tabs on the details page of a real-time service to view more details. For details, see :ref:`Table 2 `. - - .. _modelarts_23_0061__en-us_topic_0165025305_table62441712183917: - - .. table:: **Table 2** Service details - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=====================================================================================================================================================================================+ - | Usage Guides | Displays the API address, model information, input parameters, and output parameters. You can click |image1| to copy the API address to call the service. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Prediction | Performs a prediction test on the real-time service. For details, see :ref:`Testing a Service `. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Configuration Updates | Displays **Existing Configuration** and **Historical Updates**. | - | | | - | | - **Existing Configuration**: includes the model name, version, status, traffic ratio, . | - | | - **Historical Updates**: displays historical model information. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Monitoring | Displays **Resource Usage** and **Model Calls**. | - | | | - | | - **Resource Usage**: includes the used and available CPU, memory, and GPU resources. | - | | - **Model Calls**: indicates the number of model calls. The statistics collection starts after the model status changes to **Ready**. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Logs | Displays the log information about each model in the service. You can view logs generated in the latest 5 minutes, latest 30 minutes, latest 1 hour, and user-defined time segment. | - | | | - | | - You can select the start time and end time when defining the time segment. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0061__en-us_topic_0165025305_section242152442020: - -Modifying Customized Settings ------------------------------ - -A customized configuration rule consists of the configuration condition (**Setting**), access version (**Version**), and customized running parameters (including **Setting Name** and **Setting Value**). - -You can configure different settings with customized running parameters for different versions of a real-time service. - -The priorities of customized configuration rules are in descending order. You can change the priorities by dragging the sequence of customized configuration rules. - -After a rule is matched, the system will no longer match subsequent rules. A maximum of 10 configuration rules can be configured. - -.. table:: **Table 3** Parameters for **Custom Settings** - - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Description | - +=======================+=======================+========================================================================================================================================+ - | Setting | Yes | Expression of the Spring Expression Language (SPEL) rule. Only the equal and matches expressions of the character type are supported. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Yes | Access version for a customized service configuration rule. When a rule is matched, the real-time service of the version is requested. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Setting Name | No | Key of a customized running parameter, consisting of a maximum of 128 characters. | - | | | | - | | | Configure this parameter if the HTTP message header is used to carry customized running parameters to a real-time service. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - | Setting Value | No | Value of a customized running parameter, consisting of a maximum of 256 characters. | - | | | | - | | | Configure this parameter if the HTTP message header is used to carry customized running parameters to a real-time service. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------+ - -Customized settings can be used in the following scenarios: - -- If multiple versions of a real-time service are deployed for dark launch, customized settings can be used to distribute traffic by user. - - .. table:: **Table 4** Built-in variables - - +-------------------+-----------------------------------------------------------+ - | Built-in Variable | Description | - +===================+===========================================================+ - | DOMAIN_NAME | Account name that is used to invoke the inference request | - +-------------------+-----------------------------------------------------------+ - | DOMAIN_ID | Account ID that is used to invoke the inference request | - +-------------------+-----------------------------------------------------------+ - | PROJECT_NAME | Project name that is used to invoke the inference request | - +-------------------+-----------------------------------------------------------+ - | PROJECT_ID | Project ID that invokes the inference request | - +-------------------+-----------------------------------------------------------+ - | USER_NAME | Username that is used to invoke the inference request | - +-------------------+-----------------------------------------------------------+ - | USER_ID | User ID that is used to invoke the inference request | - +-------------------+-----------------------------------------------------------+ - - Pound key (#) indicates that a variable is referenced. The matched character string must be enclosed in single quotation marks. - - .. code-block:: - - #{Built-in variable} == 'Character string' - #{Built-in variable} matches 'Regular expression' - - - Example 1: - - If the account name for invoking the inference request is **User A**, the specified version is matched. - - .. code-block:: - - #DOMAIN_NAME == 'User A' - - - Example 2: - - If the account name in the inference request starts with **op**, the specified version is matched. - - .. code-block:: - - #DOMAIN_NAME matches 'op.*' - - .. table:: **Table 5** Common regular expressions - - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Character | Description | - +===========+=============================================================================================================================================================+ - | . | Match any single character except **\\n**. To match any character including **\\n**, use **(.|\n)**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \* | Match the subexpression that it follows for zero or multiple times. For example, **zo\*** can match **z** and **zoo**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | + | Match the subexpression that it follows for once or multiple times. For example, **zo+** can match **zo** and **zoo**, but cannot match **z**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ? | Match the subexpression that it follows for zero or one time. For example, **do(es)?** can match **does** or **do** in **does**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | ^ | Match the start of the input string. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | $ | Match the end of the input string. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | {n} | Match for the number specified by *n*, a non-negative integer. For example, **o{2}** cannot match **o** in **Bob**, but can match two **o**\ s in **food**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | x|y | Match x or y. For example, **z|food** can match **z** or **food**, and **(z|f)ood** can match **zood** or **food**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | [xyz] | Match any single character contained in a character set. For example, **[abc]** can match **a** in **plain**. | - +-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_23_0061__en-us_topic_0165025305_fig19860141184710: - - .. figure:: /_static/images/en-us_image_0000001157080859.png - :alt: **Figure 1** Traffic distribution by user - - - **Figure 1** Traffic distribution by user - -- If multiple versions of a real-time service are deployed for dark launch, customized settings can be used to access different versions through the header. - - Start with **#HEADER\_**, indicating that the header is referenced as a condition. - - .. code-block:: - - #HEADER_{key} == '{value}' - #HEADER_{key} matches '{value}' - - - Example 1: - - If the header of an inference HTTP request contains a version and the value is **0.0.1**, the condition is met. Otherwise, the condition is not met. - - .. code-block:: - - #HEADER_version == '0.0.1' - - - Example 2: - - If the header of an inference HTTP request contains **testheader** and the value starts with **mock**, the rule is matched. - - .. code-block:: - - #HEADER_testheader matches 'mock.*' - - .. _modelarts_23_0061__en-us_topic_0165025305_fig386192143714: - - .. figure:: /_static/images/en-us_image_0000001110920910.png - :alt: **Figure 2** Using the header to access different versions - - - **Figure 2** Using the header to access different versions - -- If a real-time service version supports different running configurations, you can use **Setting Name** and **Setting Value** to specify customized running parameters so that different users can use different running configurations. - - Example: - - When user A accesses the model, the user uses configuration A. When user B accesses the model, the user uses configuration B. When matching a running configuration, ModelArts adds a header to the request and also the customized running parameters specified by **Setting Name** and **Setting Value**. - - .. _modelarts_23_0061__en-us_topic_0165025305_fig913111016189: - - .. figure:: /_static/images/en-us_image_0000001110761010.png - :alt: **Figure 3** Customized running parameters added for a customized configuration rule - - - **Figure 3** Customized running parameters added for a customized configuration rule - -.. |image1| image:: /_static/images/en-us_image_0000001110920912.png - diff --git a/modelarts/umn/result/model_deployment/starting_or_stopping_a_service.rst b/modelarts/umn/result/model_deployment/starting_or_stopping_a_service.rst deleted file mode 100644 index e6dd4f57..00000000 --- a/modelarts/umn/result/model_deployment/starting_or_stopping_a_service.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_23_0072: - -Starting or Stopping a Service -============================== - -Starting a Service ------------------- - -You can start services in the **Successful**, **Abnormal**, or **Stopped** status. Services in the **Deploying** status cannot be started. You can start a service in either of the following ways: - -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. Click **Start** in the **Operation** column to start the target service. -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. Click the name of the target service. The service details page is displayed. Click **Start** in the upper right corner of the page to start the service. - -Stopping a Service ------------------- - -You can stop services in the **Running** or **Alarm** status. Services in the **Deploying** status cannot be stopped. After a service is stopped, ModelArts stops charging. You can stop a service in either of the following ways: - -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. Click **Stop** in the **Operation** column to stop the target service. -#. Log in to the ModelArts management console and choose **Service Deployment** from the left navigation pane. Go to the service management page of the target service. Click the name of the target service. The service details page is displayed. Click **Stop** in the upper right corner of the page to stop the service. diff --git a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_container_image.rst b/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_container_image.rst deleted file mode 100644 index b35c8897..00000000 --- a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_container_image.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _modelarts_23_0206: - -Importing a Meta Model from a Container Image -============================================= - -For AI engines that are not supported by ModelArts, you can import the model you compile to ModelArts from custom images. - -Prerequisites -------------- - -- For details about the specifications and description of custom images, see :ref:`Importing a Model Using a Custom Image `. -- The configuration must be provided for a model that you have developed and trained. The file must comply with ModelArts specifications. For details about the specifications, see :ref:`Specifications for Compiling the Model Configuration File `. After the compilation is complete, upload the file to the specified OBS directory. -- The OBS directory you use and ModelArts are in the same region. - -Procedure ---------- - -#. Log in to the ModelArts management console, and choose **Model Management** > **Models** in the left navigation pane. The **Models** page is displayed. -#. Click **Import** in the upper left corner. The **Import** page is displayed. -#. On the **Import** page, set related parameters. - - a. Set basic information about the model. For details about the parameters, see :ref:`Table 1 `. - - .. _modelarts_23_0206__en-us_topic_0207629477_table19428112584211: - - .. table:: **Table 1** Parameters of basic model information - - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=============+=====================================================================================================================================================================================+ - | Name | Model name. The value can contain 1 to 64 visible characters, including Chinese characters. Only letters, Chinese characters, digits, hyphens (-), and underscores (_) are allowed. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Version of the model to be created. For the first import, the default value is **0.0.1**. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label | Model label. A maximum of five model labels are supported. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of the model | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Select the meta model source and set related parameters. **Meta Model Source** has four options based on the scenario. For details, see :ref:`Methods of Importing a Model `. Set **Meta Model Source** to **Container image**. For details about the parameters, see :ref:`Table 2 `. - - .. _modelarts_23_0206__en-us_topic_0207629477_table104931647171713: - - .. table:: **Table 2** Parameters of the meta model source - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=================================================================================================================================================================================================================================================================================================================================================================================================+ - | Container Image Path | Click |image1| to import the model image from the container image. The model is of the Image type, and you do not need to use **swr_location** in the configuration file to specify the image location. | - | | | - | | For details about how to create a custom image, see :ref:`Introduction to Custom Images `. | - | | | - | | .. note:: | - | | | - | | The model image you select will be shared with the administrator, so ensure you have the permission to share the image (images shared with other accounts are unsupported). When you deploy a service, ModelArts deploys the image as an inference service. Ensure that your image can be properly started and provide an inference interface. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment Type | After the model is imported, select the service type that the model is deployed. When deploying a service, you can only deploy the service type selected here. For example, if you only select **Real-time services** here, you can only deploy real-time services after importing the model. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Configuration File | The **Import from OBS** and **Edit online** methods are available. The configuration file must comply with certain specifications in :ref:`Model Package Specifications `. If you select **Import from OBS**, you need to specify the OBS path for storing the configuration file. You can enable **View Configuration File** to view or edit the configuration file online. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter Configuration | Click |image2| on the right to view the input and output parameters of the model. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Set the inference specifications and model description. - - - **Min. Inference Specs**: If your model requires certain resources to complete inference, you can configure this parameter to set the minimum specifications required for normal inference after the model is deployed as a service. In later versions, the system will allocate resources based on the inference specifications in service deployment. You can also modify the specifications as required during deployment. Note that the specifications configured here are valid only when real-time services are deployed and the dedicated resource pool is used. - - **Model Description**: To help other model developers better understand and use your models, provide model descriptions. Click **Add Model Description** and then set the document name and URL. A maximum of three model descriptions are supported. - - d. Check the information and click **Next**. The model is imported. - - In the model list, you can view the imported model and its version. When the model status changes to **Normal**, the model is successfully imported. On this page, you can create new versions, quickly deploy models, publish models to the market, and perform other operations. - -Follow-Up Procedure -------------------- - -- **:ref:`Model Deployment `**: On the **Models** page, click the triangle next to a model name to view all versions of the model. Locate the row that contains the target version, click **Deploy** in the **Operation** column, and select the deployment type configured when importing the model from the drop-down list. On the **Deploy** page, set parameters by referring to :ref:`Introduction to Model Deployment `. - -.. |image1| image:: /_static/images/en-us_image_0000001157081003.png - -.. |image2| image:: /_static/images/en-us_image_0000001157081001.png - diff --git a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_template.rst b/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_template.rst deleted file mode 100644 index f182e711..00000000 --- a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_template.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _modelarts_23_0205: - -Importing a Meta Model from a Template -====================================== - -Because the configurations of models with the same functions are similar, ModelArts integrates the configurations of such models into a common template. By using this template, you can easily and quickly import models without compiling the **config.json** configuration file. - -Background ----------- - -- Because the configurations of models with the same functions are similar, ModelArts integrates the configurations of such models into a common template. By using this template, you can easily and quickly import the model. For details about the template, see :ref:`Introduction to Model Templates `. -- For details about the supported templates, see :ref:`Supported Templates `. For details about the input and output modes of each template, see :ref:`Supported Input and Output Modes `. -- Ensure that you have uploaded the model to OBS based on the model package specifications of the corresponding template. -- The OBS directory you use and ModelArts are in the same region. - -Procedure ---------- - -#. Log in to the ModelArts management console, and choose **Model Management** > **Models** in the left navigation pane. The **Models** page is displayed. -#. Click **Import** in the upper left corner. The **Import** page is displayed. -#. On the **Import** page, set related parameters. - - a. Set basic information about the model. For details about the parameters, see :ref:`Table 1 `. - - .. _modelarts_23_0205__en-us_topic_0207629476_table83985217130: - - .. table:: **Table 1** Parameters of basic model information - - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=============+=====================================================================================================================================================================================+ - | Name | Model name. The value can contain 1 to 64 visible characters, including Chinese characters. Only letters, Chinese characters, digits, hyphens (-), and underscores (_) are allowed. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Version of the model to be created. For the first import, the default value is **0.0.1**. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label | Model label. A maximum of five model labels are supported. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of the model | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Select the meta model source and set related parameters. Set **Meta Model Source** based on your application scenario. For details, see :ref:`Methods of Importing a Model `.If **Meta Model Source** is set to **Template**, set other parameters by referring to :ref:`Table 2 `. - - .. _modelarts_23_0205__en-us_topic_0207629476_table104931647171713: - - .. table:: **Table 2** Parameters of the meta model source - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Model Template | Select a template from the existing ModelArts template list . | - | | | - | | ModelArts also provides three filter criteria: **Type**, **Engine**, and **Environment**, helping you quickly find the desired template. If the three filter criteria cannot meet your requirements, you can enter keywords to search for the target template. For details about the supported templates, see :ref:`Supported Templates `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Model Directory | OBS path where a model is saved. Select an OBS path for storing the model based on the input requirements of the selected model template. | - | | | - | | .. note:: | - | | | - | | If a training job is executed for multiple times, different version directories are generated, such as V001 and V002, and the generated models are stored in the **model** folder in different version directories. When selecting model files, specify the **model** folder in the corresponding version directory. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Input and Output Mode | If the default input and output mode of the selected template can be overwritten, you can select an input and output mode based on the model function or application scenario. **Input and Output Mode** is an abstract of the API (**apis**) in **config.json**. It describes the interface provided by the model for external inference. An input and output mode describes one or more APIs, and corresponds to a template. | - | | | - | | For details about the supported input and output modes, see :ref:`Supported Input and Output Modes `. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment Type | After the model is imported, select the service type that the model is deployed. When deploying a service, you can only deploy the service type selected here. For example, if you only select **Real-time services** here, you can only deploy real-time services after importing the model. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Set the inference specifications and model description. - - - **Min. Inference Specs**: If your model requires certain resources to complete inference, you can configure this parameter to set the minimum specifications required for normal inference after the model is deployed as a service. In later versions, the system will allocate resources based on the inference specifications in service deployment. You can also modify the specifications as required during deployment. Note that the specifications configured here are valid only when real-time services are deployed and the dedicated resource pool is used. - - **Model Description**: To help other model developers better understand and use your models, provide model descriptions. Click **Add Model Description** and then set the document name and URL. A maximum of three model descriptions are supported. - - d. Check the information and click **Next**. The model is imported. - - In the model list, you can view the imported model and its version. When the model status changes to **Normal**, the model is successfully imported. On this page, you can create new versions, quickly deploy models, publish models to the market, and perform other operations. - -Follow-Up Procedure -------------------- - -- **:ref:`Model Deployment `**: On the **Models** page, click the triangle next to a model name to view all versions of the model. Locate the row that contains the target version, click **Deploy** in the **Operation** column, and select the deployment type configured when importing the model from the drop-down list. On the **Deploy** page, set parameters by referring to :ref:`Introduction to Model Deployment `. diff --git a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_training_job.rst b/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_training_job.rst deleted file mode 100644 index 7b07a1a6..00000000 --- a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_a_training_job.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _modelarts_23_0054: - -Importing a Meta Model from a Training Job -========================================== - -You can create a training job on ModelArts and perform training to obtain a satisfactory model. Then import the model to **Model Management** for unified management. In addition, you can quickly deploy the model as a service. - -Background ----------- - -- If a model generated by the ModelArts training job is used, ensure that the training job has been successfully executed and the model has been stored in the corresponding OBS directory. -- If a model is generated from a training job that uses built-in algorithms, the model can be directly imported to ModelArts without using the inference code and configuration file. -- If a model is generated from a training job that uses a frequently-used framework or custom image, upload the inference code and configuration file to the storage directory of the model by referring to :ref:`Model Package Specifications `. -- The OBS directory you use and ModelArts are in the same region. -- ModelArts of the Arm version does not support model import from training. - -Procedure ---------- - -#. Log in to the ModelArts management console, and choose **Model Management** > **Models** in the left navigation pane. The **Models** page is displayed. -#. Click **Import** in the upper left corner. The **Import** page is displayed. -#. On the **Import** page, set related parameters. - - a. Set basic information about the model. For details about the parameters, see :ref:`Table 1 `. - - .. _modelarts_23_0054__en-us_topic_0207629475_table19428112584211: - - .. table:: **Table 1** Parameters of basic model information - - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=============+=====================================================================================================================================================================================+ - | Name | Model name. The value can contain 1 to 64 visible characters, including Chinese characters. Only letters, Chinese characters, digits, hyphens (-), and underscores (_) are allowed. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Version of the model to be created. For the first import, the default value is **0.0.1**. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label | Model label. A maximum of five model labels are supported. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of the model | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Select the meta model source and set related parameters. Set **Meta Model Source** based on your application scenario. For details, see :ref:`Methods of Importing a Model `. If **Meta Model Source** is set to **Training job**, set other parameters by referring to :ref:`Table 2 `. - - .. _modelarts_23_0054__en-us_topic_0207629475_table104931647171713: - - .. table:: **Table 2** Parameters of the meta model source - - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=========================+===============================================================================================================================================================================================================================================================================================+ - | Meta Model Source | Select **Training job**, and select a specified training job that has completed training under the current account and its version from the drop-down lists on the right of **Training Job** and **Version** respectively. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment Type | After the model is imported, select the service type that the model is deployed. When deploying a service, you can only deploy the service type selected here. For example, if you only select **Real-time services** here, you can only deploy real-time services after importing the model. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Inference Code | Display the model inference code URL. You can copy this URL directly. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter Configuration | Click |image2| on the right to view the input and output parameters of the model. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Runtime Dependency | List the dependencies of the selected model on the environment. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Set the inference specifications and model description. - - - **Min. Inference Specs**: If your model requires certain resources to complete inference, you can configure this parameter to set the minimum specifications required for normal inference after the model is deployed as a service. In later versions, the system will allocate resources based on the inference specifications in service deployment. You can also modify the specifications as required during deployment. Note that the specifications configured here are valid only when real-time services are deployed and the dedicated resource pool is used. - - **Model Description**: To help other model developers better understand and use your models, provide model descriptions. Click **Add Model Description** and then set the document name and URL. A maximum of three model descriptions are supported. - - d. Check the information and click **Next**. The model is imported. - - In the model list, you can view the imported model and its version. When the model status changes to **Normal**, the model is successfully imported. On this page, you can create new versions, quickly deploy models, publish models to the market, and perform other operations. - -Follow-Up Procedure -------------------- - -- **:ref:`Model Deployment `**: On the **Models** page, click the triangle next to a model name to view all versions of the model. Locate the row that contains the target version, click **Deploy** in the **Operation** column, and select the deployment type configured when importing the model from the drop-down list. On the **Deploy** page, set parameters by referring to :ref:`Introduction to Model Deployment `. - -.. |image1| image:: /_static/images/en-us_image_0000001110761092.png - -.. |image2| image:: /_static/images/en-us_image_0000001110761092.png - diff --git a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_obs.rst b/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_obs.rst deleted file mode 100644 index 661c7455..00000000 --- a/modelarts/umn/result/model_management/importing_a_model/importing_a_meta_model_from_obs.rst +++ /dev/null @@ -1,148 +0,0 @@ -.. _modelarts_23_0207: - -Importing a Meta Model from OBS -=============================== - -In scenarios where frequently-used frameworks are used for model development and training, you can import the model to ModelArts for unified management. - -Prerequisites -------------- - -- The model has been developed and trained, and the type and version of the AI engine it uses is supported by ModelArts. Common engines supported by ModelArts and their runtime ranges are described as follows: - - .. _modelarts_23_0207__en-us_topic_0207629478_table108792813184: - - .. table:: **Table 1** Supported AI engines and their runtime - - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Engine | Runtime | Precautions | - +=======================+=========================+============================================================================================================================================================================================================================================================================================+ - | TensorFlow | python3.6 | - TensorFlow 1.8.0 is used in **python2.7** and **python3.6**. | - | | | - **python3.6**, **python2.7**, and **tf2.1-python3.7** indicate that the model can run on both CPUs and GPUs. For other runtime values, if the suffix contains **cpu** or **gpu**, the model can run only on CPUs or GPUs. | - | | python2.7 | - The default runtime is **python2.7**. | - | | | | - | | tf1.13-python2.7-gpu | | - | | | | - | | tf1.13-python2.7-cpu | | - | | | | - | | tf1.13-python3.6-gpu | | - | | | | - | | tf1.13-python3.6-cpu | | - | | | | - | | tf1.13-python3.7-cpu | | - | | | | - | | tf1.13-python3.7-gpu | | - | | | | - | | tf2.1-python3.7 | | - | | | | - | | tf1.15-aarch64-c76-d910 | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | MXNet | python3.7 | - MXNet 1.2.1 is used in **python3.6** and **python3.7**. | - | | | - **python3.6** and **python3.7** indicate that the model can run on both CPUs and GPUs. | - | | python3.6 | - The default runtime is **python3.6**. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Caffe | python3.6 | - Caffe 1.0.0 is used in **python3.6**, **python3.7**, **python3.6-gpu**, **python3.7-gpu**, **python3.6-cpu**, and **python3.7-cpu**. | - | | | - **python 3.6** and **python3.7** can only be used to run models on CPUs. For other runtime values, if the suffix contains **cpu** or **gpu**, the model can run only on CPUs or GPUs. Use the runtime of **python3.6-gpu**, **python3.7-gpu**, **python3.6-cpu**, or **python3.7-cpu**. | - | | python3.7 | - The default runtime is **python3.6**. | - | | | | - | | python3.6-gpu | | - | | | | - | | python3.7-gpu | | - | | | | - | | python3.6-cpu | | - | | | | - | | python3.7-cpu | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Spark_MLlib | python3.6 | - Spark_MLlib 2.3.2 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Scikit_Learn | python3.6 | - Scikit_Learn 0.18.1 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | XGBoost | python3.6 | - XGBoost 0.80 is used in **python3.6**. | - | | | - **python 3.6** can only be used to run models on CPUs. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | PyTorch | python3.6 | - PyTorch 1.0 is used in **python3.6** and **python3.7**. | - | | | - **python3.6**, **python3.7**, and **pytorch1.4-python3.7** indicate that the model can run on both CPUs and GPUs. | - | | python3.7 | - The default runtime is **python3.6**. | - | | | | - | | pytorch1.4-python3.7 | | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | MindSpore | ms1.1-python3.7-c76 | MindSpore 1.1.1 is used. | - +-----------------------+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -- The imported model, inference code, and configuration file must comply with the requirements of ModelArts. For details, see :ref:`Model Package Specifications `, :ref:`Specifications for Compiling the Model Configuration File `, and :ref:`Specifications for Compiling Model Inference Code `. - -- The model package that has completed training, inference code, and configuration file have been uploaded to the OBS directory. - -- The OBS directory you use and ModelArts are in the same region. - -- ModelArts of the Arm version does not support model import from OBS. - -Procedure ---------- - -#. Log in to the ModelArts management console, and choose **Model Management** > **Models** in the left navigation pane. The **Models** page is displayed. -#. Click **Import** in the upper left corner. The **Import** page is displayed. -#. On the **Import** page, set related parameters. - - a. Set basic information about the model. For details about the parameters, see :ref:`Table 2 `. - - .. _modelarts_23_0207__en-us_topic_0207629478_table19428112584211: - - .. table:: **Table 2** Parameters of basic model information - - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=============+=====================================================================================================================================================================================+ - | Name | Model name. The value can contain 1 to 64 visible characters, including Chinese characters. Only letters, Chinese characters, digits, hyphens (-), and underscores (_) are allowed. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Version of the model to be created. For the first import, the default value is **0.0.1**. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Label | Model label. A maximum of five model labels are supported. | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of the model | - +-------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - b. Select the meta model source and set related parameters. **Meta Model Source** has four options based on the scenario. For details, see :ref:`Methods of Importing a Model `. Set **Meta Model Source** to **OBS**. For details about the parameters, see :ref:`Table 3 `. - - For the meta model imported from OBS, you need to compile the inference code and configuration file by referring to :ref:`Model Package Specifications ` and place the inference code and configuration files in the **model** folder storing the meta model. If the selected directory does not contain the corresponding inference code and configuration files, the model cannot be imported. - - .. _modelarts_23_0207__en-us_topic_0207629478_table1631162916535: - - .. table:: **Table 3** Parameters of the meta model source - - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=========================+===============================================================================================================================================================================================================================================================================================+ - | Meta Model | Select the model storage path. This path is the training output path specified in the training job. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | AI Engine | The corresponding AI engine is automatically associated based on the selected meta model storage path. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Deployment Type | After the model is imported, select the service type that the model is deployed. When deploying a service, you can only deploy the service type selected here. For example, if you only select **Real-time services** here, you can only deploy real-time services after importing the model. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Configuration File | By default, the system associates the configuration file stored in OBS. Enable the function to view, edit, or import the model configuration file from OBS. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter Configuration | Click |image2| on the right to view the input and output parameters of the model. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Runtime Dependency | List the dependencies of the selected model on the environment. | - +-------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Set the inference specifications and model description. - - - **Min. Inference Specs**: If your model requires certain resources to complete inference, you can configure this parameter to set the minimum specifications required for normal inference after the model is deployed as a service. In later versions, the system will allocate resources based on the inference specifications in service deployment. You can also modify the specifications as required during deployment. Note that the specifications configured here are valid only when real-time services are deployed and the dedicated resource pool is used. - - **Model Description**: To help other model developers better understand and use your models, provide model descriptions. Click **Add Model Description** and then set the document name and URL. A maximum of three model descriptions are supported. - - d. Check the information and click **Next**. The model is imported. - - In the model list, you can view the imported model and its version. When the model status changes to **Normal**, the model is successfully imported. On this page, you can create new versions, quickly deploy models, publish models to the market, and perform other operations. - -Follow-Up Procedure -------------------- - -- **:ref:`Model Deployment `**: On the **Models** page, click the triangle next to a model name to view all versions of the model. Locate the row that contains the target version, click **Deploy** in the **Operation** column, and select the deployment type configured when importing the model from the drop-down list. On the **Deploy** page, set parameters by referring to :ref:`Introduction to Model Deployment `. - -.. |image1| image:: /_static/images/en-us_image_0000001156920973.png - -.. |image2| image:: /_static/images/en-us_image_0000001156920973.png - diff --git a/modelarts/umn/result/model_management/importing_a_model/index.rst b/modelarts/umn/result/model_management/importing_a_model/index.rst deleted file mode 100644 index 79583dfd..00000000 --- a/modelarts/umn/result/model_management/importing_a_model/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0204: - -================= -Importing a Model -================= - -.. toctree:: - :maxdepth: 1 - - importing_a_meta_model_from_a_training_job - importing_a_meta_model_from_a_template - importing_a_meta_model_from_a_container_image - importing_a_meta_model_from_obs diff --git a/modelarts/umn/result/model_management/index.rst b/modelarts/umn/result/model_management/index.rst deleted file mode 100644 index 82906529..00000000 --- a/modelarts/umn/result/model_management/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0051: - -================ -Model Management -================ - -.. toctree:: - :maxdepth: 1 - - introduction_to_model_management - importing_a_model/index - managing_model_versions - model_compression_and_conversion/index diff --git a/modelarts/umn/result/model_management/introduction_to_model_management.rst b/modelarts/umn/result/model_management/introduction_to_model_management.rst deleted file mode 100644 index ed8a44bb..00000000 --- a/modelarts/umn/result/model_management/introduction_to_model_management.rst +++ /dev/null @@ -1,42 +0,0 @@ -.. _modelarts_23_0052: - -Introduction to Model Management -================================ - -AI model development and optimization require frequent iterations and debugging. Changes in datasets, training code, or parameters may affect the quality of models. If the metadata of the development process cannot be managed in a unified manner, the optimal model may fail to be reproduced. - -ModelArts model management allows you to import models generated with all training versions to manage all iterated and debugged models in a unified manner. - -Usage Restrictions ------------------- - -- In an automatic learning project, after a model is deployed, the model is automatically uploaded to the model management list. However, models generated by automatic learning cannot be downloaded and can be used only for deployment and rollout. - -.. _modelarts_23_0052__en-us_topic_0171858287_section179419351998: - -Methods of Importing a Model ----------------------------- - -- :ref:`Importing from Trained Models `: You can create a training job on ModelArts and complete model training. After obtaining a satisfactory model, import the model to the **Model Management** page for model deployment. -- :ref:`Importing from a Template `: Because the configurations of models with the same functions are similar, ModelArts integrates the configurations of such models into a common template. By using this template, you can easily and quickly import models without compiling the **config.json** configuration file. -- :ref:`Importing from a Container Image `: For AI engines that are not supported by ModelArts, you can import the model you compile to ModelArts using custom images. -- :ref:`Importing from OBS `: If you use a frequently-used framework to develop and train a model locally, you can import the model to ModelArts for model deployment. - -Model Management Functions --------------------------- - -.. table:: **Table 1** Model management functions - - +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Supported Function | Description | - +==============================================================+=============================================================================================================================================================================================================================================================+ - | :ref:`Importing a Model ` | Import the trained models to ModelArts for unified management. You can import models using four methods. The following provides the operation guide for each method. | - | | | - | | - :ref:`Importing a Meta Model from a Training Job ` | - | | - :ref:`Importing a Meta Model from a Template ` | - | | - :ref:`Importing a Meta Model from a Container Image ` | - +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Managing Model Versions ` | To facilitate source tracing and repeated model tuning, ModelArts provides the model version management function. You can manage models based on versions. | - +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | :ref:`Compressing and Converting Models ` | To obtain higher and more economical computing power, you can deploy the models created on ModelArts or a local PC on the Ascend chip, Arm, or GPU. In this case, you need to compress or convert the models to the required formats before deploying them. | - +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/model_management/managing_model_versions.rst b/modelarts/umn/result/model_management/managing_model_versions.rst deleted file mode 100644 index 271e2f83..00000000 --- a/modelarts/umn/result/model_management/managing_model_versions.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _modelarts_23_0055: - -Managing Model Versions -======================= - -To facilitate source tracing and repeated model tuning, ModelArts provides the model version management function. You can manage models based on versions. - -Prerequisites -------------- - -You have imported a model to ModelArts, - -Creating a New Version ----------------------- - -On the **Model Management > Models** page, click **Create New Version** in the **Operation** column. The **Create New Version** page is displayed. Set related parameters by following the instructions in **Importing Models** and click **Next**. - -Deleting a Version ------------------- - -On the **Model Management > Models** page, click the triangle on the left of the model name to expand a model version list. In the model version list, click **Delete** in the **Operation** column to delete the corresponding version. - -.. note:: - - A deleted version cannot be recovered. Exercise caution when performing this operation. diff --git a/modelarts/umn/result/model_management/model_compression_and_conversion/compressing_and_converting_models.rst b/modelarts/umn/result/model_management/model_compression_and_conversion/compressing_and_converting_models.rst deleted file mode 100644 index f701f6bb..00000000 --- a/modelarts/umn/result/model_management/model_compression_and_conversion/compressing_and_converting_models.rst +++ /dev/null @@ -1,46 +0,0 @@ -.. _modelarts_23_0107: - -Compressing and Converting Models -================================= - -To obtain higher computing power, you can deploy the models created on ModelArts or a local PC on the Ascend chip, Arm, or GPU. In this case, you need to compress or convert the models to the required formats before deploying them. - -ModelArts supports model conversion, allowing you to convert a model to a required format before deploying the model on a chip with higher computing power and performance. - -Model conversion applies to the following scenarios: - -- If you use the TensorFlow framework (in **frozen_graph** or **saved_model** format) to train a model, you can convert the model to the **.om** format. The converted model can be deployed and run on Ascend chips. - -Constraints ------------ - -- Only Ascend chips are supported for model conversion. -- Only Caffe and TensorFlow models can be converted. For a TensorFlow model, the input data type is of the INT32, BOOL, UINT8, or FLOAT type. -- ModelArts provides conversion templates for you to choose. For details about the supported templates, see :ref:`Conversion Templates `. -- The **.tflite** and TensorRT formats support fewer operators and quantization operators. Therefore, some models may fail to be converted. If the conversion fails, view the log dialog box or check error logs in the conversion output directory. -- An OBS directory must be specified in compression/conversion tasks. Ensure that the OBS directory you use and ModelArts are in the same region. -- When importing the converted model to ModelArts, you need to use the :ref:`model template `. -- For a TensorFlow model, the FrozenGraphDef and SavedModel formats are supported. If a model is in the SavedModel format, the model is converted to the FrozenGraphDef format and then to the OM format. -- Inputs with dynamic shapes are not supported, for example, NHWC = [?,?,?,3]. A fixed value needs to be specified during model conversion. -- The input can be up to 4-dimensional. Operators involving dimension changes (such as reshape and expanddim) cannot output five dimensions. -- Except the const operator, the input and output at all layers in a model must meet the condition **dim!=0**. -- Model conversion does not support models that contain training operators. -- A UINT8 quantized model cannot be converted. -- Model operators support only 2D convolution but do not support 3D convolution. The batch_normalization_1 and FusedBatchNorm operators cannot be converted in batches. - -Deleting a Model Compression/Conversion Task --------------------------------------------- - -You can delete unnecessary conversion tasks. However, tasks in the **Running** or **Initializing** status cannot be deleted. - -.. note:: - - Deleted tasks cannot be recovered. Exercise caution when performing this operation. - -- Deleting a single task: - - On the **Compression/Conversion** page, click **Delete** in the **Operation** column of the target task. - -- Deleting a batch of tasks: - - On the **Compression/Conversion** page, select multiple tasks to be deleted and click **Delete** in the upper left corner. diff --git a/modelarts/umn/result/model_management/model_compression_and_conversion/conversion_templates.rst b/modelarts/umn/result/model_management/model_compression_and_conversion/conversion_templates.rst deleted file mode 100644 index 5d518c10..00000000 --- a/modelarts/umn/result/model_management/model_compression_and_conversion/conversion_templates.rst +++ /dev/null @@ -1,56 +0,0 @@ -.. _modelarts_23_0110: - -Conversion Templates -==================== - -ModelArts provides the following conversion templates based on different AI frameworks: - -- :ref:`TF-FrozenGraph-To-Ascend-C32 ` - -.. _modelarts_23_0110__en-us_topic_0177612243_section47553019134: - -TF-FrozenGraph-To-Ascend-C32 ----------------------------- - -Convert the model trained by the TensorFlow framework and saved in **frozen_graph** format. The converted model can run on the Ascend. The custom operators (TBE operators) developed based on Tensor Based Engine (TBE) can be used for conversion. - -.. table:: **Table 1** Advanced settings of the custom operator conversion template - - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | input_shape | Enter the shape of the input data of the model, for example, **input_name1:n1,c1,h1,w1;input_name2:n2,c2,h2,w2**. **input_name** must be the node name in the network model before model conversion. This parameter is mandatory when the model has dynamic shape input. For example, in **input_name1:? ,h,w,c**, the question mark (?) indicates the batch size, that is, the number of images processed at a time. It is used to convert the original model with a dynamic shape into an offline model with a fixed shape. The batch feature is not supported. The batch value of the **input_shape** can only be **1**. During the conversion, the system parses the input model to obtain the input tensor and prints it in the log. If you do not know the input tensor of the used model, refer to the parsing result in the log. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | input_format | **NCHW** and **NHWC** are supported. The default format is **NHWC**. For the TensorFlow framework, the default value is **NHWC**. To use the NCHW format, you need to specify **NCHW**. For the Caffe framework, only the NCHW format is supported. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | out_nodes | Specifies the output node, for example, **node_name1:0;node_name1:1;node_name2:0**. **node_name** must be the node name in the network model before model conversion. The digit after each colon (:) indicates the sequence number of the output. For example, **node_name1:0** indicates the 0th output of **node_name1**. If the output node is not specified, the output of the last operator layer serves as the model output by default. To check the parameters of a specific operator layer, specify the operator layer by using this parameter. During the conversion, the system parses the input model to obtain the output node and prints it in the log. If you do not know the input tensor of the used model, refer to the parsing result in the log. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net_format | Specifies the preferred data format for network operators. Possible values are **ND** (N cannot be more than 4) and **5D**. This parameter only takes effect if the input data of operators on the network supports both **ND** and **5D** formats. **ND** indicates that operators in the model are converted into the NCHW format. **5D** indicates that operators in the model are converted into the 5D format. **5D** is the default value. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fp16_high_prec | Specifies whether to generate a high-precision **FP16 Davinci** model. **0** is the default value, indicating that a common FP16 Da Vinci model with better inference performance is generated. The value **1** indicates that a high-precision FP16 Da Vinci model with better inference precision is generated. High-precision models support only Caffe operators (Convolution, Pooling, and FullConnection) and TensorFlow operators (tf.nn.conv2d and tf.nn.max_poo). | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_type | **FP32** is the default value and is recommended for classification and detection networks. For image super-resolution networks, UINT8 is recommended for better inference performance. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -TF-SavedModel-To-Ascend-C32 ---------------------------- - -Convert the model trained by the TensorFlow framework and saved in **saved_model** format. The converted model can run on the Ascend. The custom operators (TE operators) developed based on TE can be used for conversion. - -.. table:: **Table 2** Advanced settings of the custom operator conversion template - - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +================+==========================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | input_shape | Enter the shape of the input data of the model, for example, **input_name1:n1,c1,h1,w1;input_name2:n2,c2,h2,w2**. **input_name** must be the node name in the network model before model conversion. This parameter is mandatory when the model has dynamic shape input. For example, in **input_name1:? ,h,w,c**, the question mark (?) indicates the batch size, that is, the number of images processed at a time. It is used to convert the original model with a dynamic shape into an offline model with a fixed shape. The batch feature is not supported. The batch value of the **input_shape** can only be **1**. During the conversion, the system parses the input model to obtain the input tensor and prints it in the log. If you do not know the input tensor of the used model, refer to the parsing result in the log. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | input_format | **NCHW** and **NHWC** are supported. The default format is **NHWC**. For the TensorFlow framework, the default value is **NHWC**. To use the NCHW format, you need to specify **NCHW**. For the Caffe framework, only the NCHW format is supported. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | out_nodes | Specifies the output node, for example, **node_name1:0;node_name1:1;node_name2:0**. **node_name** must be the node name in the network model before model conversion. The digit after each colon (:) indicates the sequence number of the output. For example, **node_name1:0** indicates the 0th output of **node_name1**. If the output node is not specified, the output of the last operator layer serves as the model output by default. To check the parameters of a specific operator layer, specify the operator layer by using this parameter. During the conversion, the system parses the input model to obtain the output node and prints it in the log. If you do not know the input tensor of the used model, refer to the parsing result in the log. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | net_format | Specifies the preferred data format for network operators. Possible values are **ND** (N cannot be more than 4) and **5D**. This parameter only takes effect if the input data of operators on the network supports both **ND** and **5D** formats. **ND** indicates that operators in the model are converted into the NCHW format. **5D** indicates that operators in the model are converted into the 5D format. **5D** is the default value. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | fp16_high_prec | Specifies whether to generate a high-precision **FP16 Davinci** model. **0** is the default value, indicating that a common FP16 Da Vinci model with better inference performance is generated. The value **1** indicates that a high-precision FP16 Da Vinci model with better inference precision is generated. High-precision models support only Caffe operators (Convolution, Pooling, and FullConnection) and TensorFlow operators (tf.nn.conv2d and tf.nn.max_poo). | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | output_type | **FP32** is the default value and is recommended for classification and detection networks. For image super-resolution networks, UINT8 is recommended for better inference performance. | - +----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/model_management/model_compression_and_conversion/index.rst b/modelarts/umn/result/model_management/model_compression_and_conversion/index.rst deleted file mode 100644 index b3c52e01..00000000 --- a/modelarts/umn/result/model_management/model_compression_and_conversion/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0106: - -================================ -Model Compression and Conversion -================================ - -.. toctree:: - :maxdepth: 1 - - compressing_and_converting_models - model_input_path_specifications - model_output_path_description - conversion_templates diff --git a/modelarts/umn/result/model_management/model_compression_and_conversion/model_input_path_specifications.rst b/modelarts/umn/result/model_management/model_compression_and_conversion/model_input_path_specifications.rst deleted file mode 100644 index 1a939035..00000000 --- a/modelarts/umn/result/model_management/model_compression_and_conversion/model_input_path_specifications.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _modelarts_23_0108: - -Model Input Path Specifications -=============================== - -Ascend Chip ------------ - -The requirements for converting the models run on the Ascend chip are as follows: - -- For TensorFlow-based models (in **frozen_graph** or **saved_model** format), the input path must comply with the following specifications during model conversion: - - **frozen_graph** format - - .. code-block:: - - | - |---xxxx.pb (Mandatory) Model network file. Only one model network file can exist in the input path. The model must be in frozen_graph or saved_model format. - |---insert_op_conf.cfg (Optional) Insertion operator configuration file. Only one insertion operator configuration file can exist in the input path. - |---plugin (Optional) Custom operator directory. The input directory can contain only one plugin folder. Only custom operators developed based on Tensor Engine (TE) are supported. - - **saved_model** format - - .. code-block:: - - | - |---saved_model.pb (Mandatory) Model network file. Only one model network file can exist in the input path. The model must be in frozen_graph or saved_model format. - |---variables (Mandatory) Fixed subdirectory name, including the model weight deviation. - |---variables.index Mandatory - |---variables.data-00000-of-00001 Mandatory - |---insert_op_conf.cfg (Optional) Insertion operator configuration file. Only one insertion operator configuration file can exist in the input path. - |---plugin (Optional) Custom operator directory. The input directory can contain only one plugin folder. Only custom operators developed based on Tensor Engine (TE) are supported. diff --git a/modelarts/umn/result/model_management/model_compression_and_conversion/model_output_path_description.rst b/modelarts/umn/result/model_management/model_compression_and_conversion/model_output_path_description.rst deleted file mode 100644 index 72fa3f70..00000000 --- a/modelarts/umn/result/model_management/model_compression_and_conversion/model_output_path_description.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _modelarts_23_0109: - -Model Output Path Description -============================= - -Ascend Chip ------------ - -The following describes the output path of the model run on the Ascend chip after conversion: - -- For TensorFlow-based models, the output path must comply with the following specifications during model conversion: - - .. code-block:: - - | - |---xxxx.om Converted model to run on the Ascend chip. The model file name extension is .om. - |---job_log.txt Conversion log file diff --git a/modelarts/umn/result/model_package_specifications/index.rst b/modelarts/umn/result/model_package_specifications/index.rst deleted file mode 100644 index 4a4e00ad..00000000 --- a/modelarts/umn/result/model_package_specifications/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0090: - -============================ -Model Package Specifications -============================ - -.. toctree:: - :maxdepth: 1 - - model_package_specifications - specifications_for_compiling_the_model_configuration_file - specifications_for_compiling_model_inference_code diff --git a/modelarts/umn/result/model_package_specifications/model_package_specifications.rst b/modelarts/umn/result/model_package_specifications/model_package_specifications.rst deleted file mode 100644 index 9cc17fb0..00000000 --- a/modelarts/umn/result/model_package_specifications/model_package_specifications.rst +++ /dev/null @@ -1,146 +0,0 @@ -.. _modelarts_23_0091: - -Model Package Specifications -============================ - -When you import models in **Model Management**, if the meta model is imported from OBS or a container image, the model package must meet the following specifications: - -- The model package must contain the **model** directory. The **model** directory stores the model file, model configuration file, and model inference code. -- The model configuration file must exist and its name is fixed to **config.json**. There exists only one model configuration file. For details about how to compile the model configuration file, see :ref:`Specifications for Compiling the Model Configuration File `. -- The model inference code file is optional. If this file is required, the file name is fixed to **customize_service.py**. There must be one and only one such file. For details about how to compile the model inference code, see :ref:`Specifications for Compiling Model Inference Code `. - - .. note:: - - - The **.py** file on which **customize_service.py** depends can be directly stored in the **model** directory. Use the Python import mode to import the custom package. - - The other files on which **customize_service.py** depends can be stored in the **model** directory. You must use absolute paths to access these files. For more details, see :ref:`Obtaining an Absolute Path `. - -ModelArts also provides custom script examples of common AI engines. For details, see :ref:`Examples of Custom Scripts `. - -Model Package Example ---------------------- - -- Structure of the TensorFlow-based model package - - When publishing the model, you only need to specify the **ocr** directory. - - .. code-block:: - - OBS bucket/directory name - |── ocr - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | │ ├── saved_model.pb (Mandatory) Protocol buffer file, which contains the diagram description of the model - | │ ├── variables Name of a fixed sub-directory, which contains the weight and deviation rate of the model. It is mandatory for the main file of the *.pb model. - | │ │ ├── variables.index Mandatory - | │ │ ├── variables.data-00000-of-00001 Mandatory - | │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | │ ├──customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the MindSpore-based model package - - .. code-block:: - - OBS bucket/directory name - |── resnet - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | │ ├── checkpoint_lenet_1-1_1875.ckpt (Mandatory) Model file in ckpt format trained using MindSpore - | │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | │ ├──customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file is supported. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the MXNet-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | │ ├── resnet-50-symbol.json (Mandatory) Model definition file, which contains the neural network description of the model - | │ ├── resnet-50-0000.params (Mandatory) Model variable parameter file, which contains parameter and weight information - | │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | │ ├──customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the Image-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├──config.json (Mandatory) Model configuration file (the address of the SWR image must be configured). The file name is fixed to config.json. Only one model configuration file is supported. - -- Structure of the PySpark-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | │ ├── spark_model (Mandatory) Model directory, which contains the model content saved by PySpark - | │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | │ ├──customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the PyTorch-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | ├── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | │ ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | │ ├── resnet50.pth (Mandatory) PyTorch model file, which contains variable and weight information and is saved as state_dict - | │ ├──config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | │ ├──customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the Caffe-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | |── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | | |── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | | |── deploy.prototxt (Mandatory) Caffe model file, which contains information such as the model network structure - | | |── resnet.caffemodel (Mandatory) Caffe model file, which contains variable and weight information - | | |── config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | | |── customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the XGBoost-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | |── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | | |── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | | |── *.m (Mandatory): Model file whose extension name is .m - | | |── config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | | |── customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. - -- Structure of the Scikit_Learn-based model package - - When publishing the model, you only need to specify the **resnet** directory. - - .. code-block:: - - OBS bucket/directory name - |── resnet - | |── model (Mandatory) Name of a fixed subdirectory, which is used to store model-related files - | | |── <> (Optional) User's Python package, which can be directly referenced in the model inference code - | | |── *.m (Mandatory): Model file whose extension name is .m - | | |── config.json (Mandatory) Model configuration file. The file name is fixed to config.json. Only one model configuration file is supported. - | | |── customize_service.py (Optional) Model inference code. The file name is fixed to customize_service.py. Only one model inference code file exists. The files on which customize_service.py depends can be directly stored in the model directory. diff --git a/modelarts/umn/result/model_package_specifications/specifications_for_compiling_model_inference_code.rst b/modelarts/umn/result/model_package_specifications/specifications_for_compiling_model_inference_code.rst deleted file mode 100644 index 4cf3347e..00000000 --- a/modelarts/umn/result/model_package_specifications/specifications_for_compiling_model_inference_code.rst +++ /dev/null @@ -1,445 +0,0 @@ -.. _modelarts_23_0093: - -Specifications for Compiling Model Inference Code -================================================= - -This section describes how to compile model inference code in ModelArts. The following also provides an example of inference code for the TensorFlow engine and an example of customizing inference logic in an inference script. - -Specifications for Compiling Inference Code -------------------------------------------- - -#. All custom Python code must be inherited from the BaseService class. :ref:`Table 1 ` lists the import statements of different types of model parent classes. - - .. _modelarts_23_0093__en-us_topic_0172466150_table55021545175412: - - .. table:: **Table 1** Import statements of the **BaseService** class - - +--------------+-------------------------+------------------------------------------------------------------------+ - | Model Type | Parent Class | Import Statement | - +==============+=========================+========================================================================+ - | TensorFlow | TfServingBaseService | from model_service.tfserving_model_service import TfServingBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | MXNet | MXNetBaseService | from mms.model_service.mxnet_model_service import MXNetBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | PyTorch | PTServingBaseService | from model_service.pytorch_model_service import PTServingBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | Pyspark | SparkServingBaseService | from model_service.spark_model_service import SparkServingBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | Caffe | CaffeBaseService | from model_service.caffe_model_service import CaffeBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | XGBoost | XgSklServingBaseService | from model_service.python_model_service import XgSklServingBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | Scikit_Learn | XgSklServingBaseService | from model_service.python_model_service import XgSklServingBaseService | - +--------------+-------------------------+------------------------------------------------------------------------+ - | MindSpore | SingleNodeService | from model_service.model_service import SingleNodeService | - +--------------+-------------------------+------------------------------------------------------------------------+ - -#. The following methods can be rewritten: - - .. table:: **Table 2** Methods to be rewritten - - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Method | Description | - +=========================================+==========================================================================================================================================================================================================================================================+ - | \__init__(self, model_name, model_path) | Initialization method, which is suitable for models created based on deep learning frameworks. Models and labels are loaded using this method. This method must be rewritten for models based on PyTorch and Caffe to implement the model loading logic. | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \__init__(self, model_path) | Initialization method, which is suitable for models created based on machine learning frameworks. The model path (**self.model_path**) is initialized using this method. In Spark_MLlib, this method also initializes SparkSession (**self.spark**). | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \_preprocess(self, data) | Preprocess method, which is called before an inference request and is used to convert the original request data of an API into the expected input data of a model | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \_inference(self, data) | Inference request method. You are not advised to rewrite the method because once the method is rewritten, the built-in inference process of ModelArts will be overwritten and the custom inference logic will run. | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | \_postprocess(self, data) | Postprocess method, which is called after an inference request is complete and is used to convert the model output to the API output | - +-----------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. note:: - - - You can choose to rewrite the preprocess and postprocess methods to implement preprocessing of the API input and postprocessing of the inference output. - - Rewriting the init method of the BaseService inheritance class may cause a model to run abnormally. - -#. .. _modelarts_23_0093__en-us_topic_0172466150_li135956421288: - - The attribute that can be used is the local path where the model resides. The attribute name is **self.model_path**. In addition, PySpark-based models can use **self.spark** to obtain the SparkSession object in **customize_service.py**. - - .. note:: - - An absolute path is required for reading files in the inference code. You can obtain the absolute path of the model from the **self.model_path** attribute. - - - When TensorFlow, Caffe, or MXNet is used, **self.model_path** indicates the path of the model file. See the following example: - - .. code-block:: - - # Store the label.json file in the model directory. The following information is read: - with open(os.path.join(self.model_path, 'label.json')) as f: - self.label = json.load(f) - - - When PyTorch, Scikit_Learn, or PySpark is used, **self.model_path** indicates the path of the model file. See the following example: - - .. code-block:: - - # Store the label.json file in the model directory. The following information is read: - dir_path = os.path.dirname(os.path.realpath(self.model_path)) - with open(os.path.join(dir_path, 'label.json')) as f: - self.label = json.load(f) - -#. Two types of **content-type** APIs can be used for inputting data: **multipart/form-data** and **application/json** - - - **multipart/form-data** request - - .. code-block:: - - curl -X POST \ - \ - -F image1=@cat.jpg \ - -F images2=@horse.jpg - - The corresponding input data is as follows: - - .. code-block:: - - [ - { - "image1":{ - "cat.jpg":"" - } - }, - { - "image2":{ - "horse.jpg":"" - } - } - ] - - - **application/json** request - - .. code-block:: - - curl -X POST \ - \ - -d '{ - "images":"base64 encode image" - }' - - The corresponding input data is **python dict**. - - .. code-block:: - - { - "images":"base64 encode image" - - } - -TensorFlow Inference Script Example ------------------------------------ - -The following is an example of TensorFlow MnistService. - -- Inference code - - +-----------------------------------+-------------------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | from PIL import Image | - | 2 | import numpy as np | - | 3 | from model_service.tfserving_model_service import TfServingBaseService | - | 4 | | - | 5 | class mnist_service(TfServingBaseService): | - | 6 | | - | 7 | def _preprocess(self, data): | - | 8 | preprocessed_data = {} | - | 9 | | - | 10 | for k, v in data.items(): | - | 11 | for file_name, file_content in v.items(): | - | 12 | image1 = Image.open(file_content) | - | 13 | image1 = np.array(image1, dtype=np.float32) | - | 14 | image1.resize((1, 784)) | - | 15 | preprocessed_data[k] = image1 | - | 16 | | - | 17 | return preprocessed_data | - | 18 | | - | 19 | def _postprocess(self, data): | - | 20 | | - | 21 | infer_output = {} | - | 22 | | - | 23 | for output_name, result in data.items(): | - | 24 | | - | 25 | infer_output["mnist_result"] = result[0].index(max(result[0])) | - | 26 | | - | 27 | return infer_output | - +-----------------------------------+-------------------------------------------------------------------------------+ - -- Request - - .. code-block:: - - curl -X POST \ Real-time service address \ -F images=@test.jpg - -- Response - - .. code-block:: - - {"mnist_result": 7} - -The preceding code example resizes images imported to the user's form to adapt to the model input shape. The **32×32** image is read from the Pillow library and resized to **1×784** to match the model input. In subsequent processing, convert the model output into a list for the RESTful API to display. - -XGBoost Inference Script Example --------------------------------- - -.. code-block:: - - # coding:utf-8 - import collections - import json - import xgboost as xgb - from model_service.python_model_service import XgSklServingBaseService - - - class user_Service(XgSklServingBaseService): - - # request data preprocess - def _preprocess(self, data): - list_data = [] - json_data = json.loads(data, object_pairs_hook=collections.OrderedDict) - for element in json_data["data"]["req_data"]: - array = [] - for each in element: - array.append(element[each]) - list_data.append(array) - return list_data - - # predict - def _inference(self, data): - xg_model = xgb.Booster(model_file=self.model_path) - pre_data = xgb.DMatrix(data) - pre_result = xg_model.predict(pre_data) - pre_result = pre_result.tolist() - return pre_result - - # predict result process - def _postprocess(self, data): - resp_data = [] - for element in data: - resp_data.append({"predict_result": element}) - return resp_data - -Inference Script Example of the Custom Inference Logic ------------------------------------------------------- - -First, define a dependency package in the configuration file. For details, see :ref:`Example of a Model Configuration File Using a Custom Dependency Package `. Then, use the following code example to implement the loading and inference of the model in **saved_model** format. - -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | # -*- coding: utf-8 -*- | -| 2 | import json | -| 3 | import os | -| 4 | import threading | -| 5 | | -| 6 | import numpy as np | -| 7 | import tensorflow as tf | -| 8 | from PIL import Image | -| 9 | | -| 10 | from model_service.tfserving_model_service import TfServingBaseService | -| 11 | import logging | -| 12 | | -| 13 | logger = logging.getLogger(__name__) | -| 14 | | -| 15 | | -| 16 | class MnistService(TfServingBaseService): | -| 17 | | -| 18 | def __init__(self, model_name, model_path): | -| 19 | self.model_name = model_name | -| 20 | self.model_path = model_path | -| 21 | self.model_inputs = {} | -| 22 | self.model_outputs = {} | -| 23 | | -| 24 | # The label file can be loaded here and used in the post-processing function. | -| 25 | # Directories for storing the label.txt file on OBS and in the model package | -| 26 | | -| 27 | # with open(os.path.join(self.model_path, 'label.txt')) as f: | -| 28 | # self.label = json.load(f) | -| 29 | | -| 30 | # Load the model in saved_model format in non-blocking mode to prevent blocking timeout. | -| 31 | thread = threading.Thread(target=self.get_tf_sess) | -| 32 | thread.start() | -| 33 | | -| 34 | def get_tf_sess(self): | -| 35 | # Load the model in saved_model format. | -| 36 | | -| 37 | # The session will be reused. Do not use the with statement. | -| 38 | sess = tf.Session(graph=tf.Graph()) | -| 39 | meta_graph_def = tf.saved_model.loader.load(sess, [tf.saved_model.tag_constants.SERVING], self.model_path) | -| 40 | signature_defs = meta_graph_def.signature_def | -| 41 | | -| 42 | self.sess = sess | -| 43 | | -| 44 | signature = [] | -| 45 | | -| 46 | # only one signature allowed | -| 47 | for signature_def in signature_defs: | -| 48 | signature.append(signature_def) | -| 49 | if len(signature) == 1: | -| 50 | model_signature = signature[0] | -| 51 | else: | -| 52 | logger.warning("signatures more than one, use serving_default signature") | -| 53 | model_signature = tf.saved_model.signature_constants.DEFAULT_SERVING_SIGNATURE_DEF_KEY | -| 54 | | -| 55 | logger.info("model signature: %s", model_signature) | -| 56 | | -| 57 | for signature_name in meta_graph_def.signature_def[model_signature].inputs: | -| 58 | tensorinfo = meta_graph_def.signature_def[model_signature].inputs[signature_name] | -| 59 | name = tensorinfo.name | -| 60 | op = self.sess.graph.get_tensor_by_name(name) | -| 61 | self.model_inputs[signature_name] = op | -| 62 | | -| 63 | logger.info("model inputs: %s", self.model_inputs) | -| 64 | | -| 65 | for signature_name in meta_graph_def.signature_def[model_signature].outputs: | -| 66 | tensorinfo = meta_graph_def.signature_def[model_signature].outputs[signature_name] | -| 67 | name = tensorinfo.name | -| 68 | op = self.sess.graph.get_tensor_by_name(name) | -| 69 | | -| 70 | self.model_outputs[signature_name] = op | -| 71 | | -| 72 | logger.info("model outputs: %s", self.model_outputs) | -| 73 | | -| 74 | def _preprocess(self, data): | -| 75 | # Two request modes using HTTPS | -| 76 | # 1. The request in form-data file format is as follows: data = {"Request key value":{"File name":}} | -| 77 | # 2. Request in JSON format is as follows: data = json.loads("JSON body transferred by the API") | -| 78 | preprocessed_data = {} | -| 79 | | -| 80 | for k, v in data.items(): | -| 81 | for file_name, file_content in v.items(): | -| 82 | image1 = Image.open(file_content) | -| 83 | image1 = np.array(image1, dtype=np.float32) | -| 84 | image1.resize((1, 28, 28)) | -| 85 | preprocessed_data[k] = image1 | -| 86 | | -| 87 | return preprocessed_data | -| 88 | | -| 89 | def _inference(self, data): | -| 90 | | -| 91 | feed_dict = {} | -| 92 | for k, v in data.items(): | -| 93 | if k not in self.model_inputs.keys(): | -| 94 | logger.error("input key %s is not in model inputs %s", k, list(self.model_inputs.keys())) | -| 95 | raise Exception("input key %s is not in model inputs %s" % (k, list(self.model_inputs.keys()))) | -| 96 | feed_dict[self.model_inputs[k]] = v | -| 97 | | -| 98 | result = self.sess.run(self.model_outputs, feed_dict=feed_dict) | -| 99 | logger.info('predict result : ' + str(result)) | -| 100 | | -| 101 | return result | -| 102 | | -| 103 | def _postprocess(self, data): | -| 104 | infer_output = {"mnist_result": []} | -| 105 | for output_name, results in data.items(): | -| 106 | | -| 107 | for result in results: | -| 108 | infer_output["mnist_result"].append(np.argmax(result)) | -| 109 | | -| 110 | return infer_output | -| 111 | | -| 112 | def __del__(self): | -| 113 | self.sess.close() | -+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------+ - -MindSpore Inference Script Example ----------------------------------- - -+-----------------------------------+-----------------------------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | import threading | -| 2 | | -| 3 | import mindspore | -| 4 | import mindspore.nn as nn | -| 5 | import numpy as np | -| 6 | import logging | -| 7 | from mindspore import Tensor, context | -| 8 | from mindspore.common.initializer import Normal | -| 9 | from mindspore.train.serialization import load_checkpoint, load_param_into_net | -| 10 | from model_service.model_service import SingleNodeService | -| 11 | from PIL import Image | -| 12 | | -| 13 | logger = logging.getLogger(__name__) | -| 14 | logger.setLevel(logging.INFO) | -| 15 | | -| 16 | | -| 17 | | -| 18 | context.set_context(mode=context.GRAPH_MODE, device_target="Ascend") | -| 19 | | -| 20 | | -| 21 | class LeNet5(nn.Cell): | -| 22 | """Lenet network structure.""" | -| 23 | | -| 24 | # define the operator required | -| 25 | def __init__(self, num_class=10, num_channel=1): | -| 26 | super(LeNet5, self).__init__() | -| 27 | self.conv1 = nn.Conv2d(num_channel, 6, 5, pad_mode='valid') | -| 28 | self.conv2 = nn.Conv2d(6, 16, 5, pad_mode='valid') | -| 29 | self.fc1 = nn.Dense(16 * 5 * 5, 120, weight_init=Normal(0.02)) | -| 30 | self.fc2 = nn.Dense(120, 84, weight_init=Normal(0.02)) | -| 31 | self.fc3 = nn.Dense(84, num_class, weight_init=Normal(0.02)) | -| 32 | self.relu = nn.ReLU() | -| 33 | self.max_pool2d = nn.MaxPool2d(kernel_size=2, stride=2) | -| 34 | self.flatten = nn.Flatten() | -| 35 | | -| 36 | # use the preceding operators to construct networks | -| 37 | def construct(self, x): | -| 38 | x = self.max_pool2d(self.relu(self.conv1(x))) | -| 39 | x = self.max_pool2d(self.relu(self.conv2(x))) | -| 40 | x = self.flatten(x) | -| 41 | x = self.relu(self.fc1(x)) | -| 42 | x = self.relu(self.fc2(x)) | -| 43 | x = self.fc3(x) | -| 44 | return x | -| 45 | | -| 46 | | -| 47 | class mnist_service(SingleNodeService): | -| 48 | def __init__(self, model_name, model_path): | -| 49 | self.model_name = model_name | -| 50 | self.model_path = model_path | -| 51 | logger.info("self.model_name:%s self.model_path: %s", self.model_name, | -| 52 | self.model_path) | -| 53 | self.network = None | -| 54 | # Load the model in non-blocking mode to prevent blocking timeout. | -| 55 | thread = threading.Thread(target=self.load_model) | -| 56 | thread.start() | -| 57 | | -| 58 | def load_model(self): | -| 59 | logger.info("load network ... \n") | -| 60 | self.network = LeNet5() | -| 61 | ckpt_file = self.model_path + "/checkpoint_lenet_1-1_1875.ckpt" | -| 62 | logger.info("ckpt_file: %s", ckpt_file) | -| 63 | param_dict = load_checkpoint(ckpt_file) | -| 64 | load_param_into_net(self.network, param_dict) | -| 65 | logger.info("load network successfully ! \n") | -| 66 | | -| 67 | def _preprocess(self, input_data): | -| 68 | preprocessed_result = {} | -| 69 | images = [] | -| 70 | for k, v in input_data.items(): | -| 71 | for file_name, file_content in v.items(): | -| 72 | image1 = Image.open(file_content) | -| 73 | image1 = image1.resize((1, 32 * 32)) | -| 74 | image1 = np.array(image1, dtype=np.float32) | -| 75 | images.append(image1) | -| 76 | | -| 77 | images = np.array(images, dtype=np.float32) | -| 78 | logger.info(images.shape) | -| 79 | images.resize([len(input_data), 1, 32, 32]) | -| 80 | logger.info("images shape: %s", images.shape) | -| 81 | inputs = Tensor(images, mindspore.float32) | -| 82 | preprocessed_result['images'] = inputs | -| 83 | | -| 84 | return preprocessed_result | -| 85 | | -| 86 | def _inference(self, preprocessed_result): | -| 87 | inference_result = self.network(preprocessed_result['images']) | -| 88 | return inference_result | -| 89 | | -| 90 | def _postprocess(self, inference_result): | -| 91 | return str(inference_result) | -+-----------------------------------+-----------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/model_package_specifications/specifications_for_compiling_the_model_configuration_file.rst b/modelarts/umn/result/model_package_specifications/specifications_for_compiling_the_model_configuration_file.rst deleted file mode 100644 index 8eba1ee5..00000000 --- a/modelarts/umn/result/model_package_specifications/specifications_for_compiling_the_model_configuration_file.rst +++ /dev/null @@ -1,795 +0,0 @@ -.. _modelarts_23_0092: - -Specifications for Compiling the Model Configuration File -========================================================= - -A model developer needs to compile a configuration file when publishing a model. The model configuration file describes the model usage, computing framework, precision, inference code dependency package, and model API. - -Configuration File Format -------------------------- - -The configuration file is in JSON format. :ref:`Table 1 ` describes the parameters. - -.. _modelarts_23_0092__en-us_topic_0172466149_table7143191919436: - -.. table:: **Table 1** Parameters - - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +=================+=================+===========================+=============================================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | model_algorithm | Yes | String | Model algorithm, which is set by the model developer to help model users understand the usage of the model. The value must start with a letter and contain no more than 36 characters. Chinese characters and special characters (&!'\"<>=) are not allowed. Common model algorithms include **image_classification** (image classification), **object_detection** (object detection), and **predict_analysis** (prediction analysis). | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | model_type | Yes | String | Model AI engine, which indicates the computing framework used by a model. The options are **TensorFlow**, **MXNet**, **Spark_MLlib**, **Caffe**, **Scikit_Learn**, **XGBoost**, **PyTorch**, **MindSpore**, and **Image**. | - | | | | | - | | | | **Image** is not a common AI framework. When **model_type** is set to **Image**, a model is imported from a custom image. In this case, **swr_location** is mandatory. For details about how to make Image images, see :ref:`Custom Image Specifications `. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | runtime | No | String | Model runtime environment. Python 3.6 is used by default. The value of **runtime** depends on the value of **model_type**. If **model_type** is set to **Image**, you do not need to set **runtime**. If **model_type** is set to another frequently-used framework, select the engine and development environment. For details about the supported running environments, see :ref:`Table 1 `. | - | | | | | - | | | | If your model needs to run on a specified CPU or GPU, select the runtime based on the suffix information. If the runtime does not contain the CPU or GPU information, read the description of each runtime in :ref:`Table 1 `. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | swr_location | No | String | SWR image address. | - | | | | | - | | | | - If you import a custom image model from a container image, you do not need to set **swr_location**. | - | | | | - If you import a custom image model from OBS (not recommended) and set **model_type** to **Image**, you must set **swr_location**. **swr_location** indicates the address of the Docker image on SWR, indicating that the Docker image on SWR is used to publish the model. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metrics | No | Object | Model precision information, including the average value, recall rate, precision, and accuracy. For details about the **metrics** object structure, see :ref:`Table 2 `. | - | | | | | - | | | | This parameter is used only to display model information and is optional. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | apis | No | api array | Format of the requests received and returned by a model. The value is structure data. | - | | | | | - | | | | It is the RESTful API array provided by a model. For details about the API data structure, see :ref:`Table 3 `. | - | | | | | - | | | | - When **model_type** is set to **Image**, that is, in the model scenario of a custom image, APIs with different paths can be declared in **apis** based on the request path exposed by the image. | - | | | | - When **model_type** is not **Image**, only one API whose request path is **/** can be declared in **apis** because the preconfigured AI engine exposes only one inference API whose request path is **/**. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | dependencies | No | dependency array | Package on which the model inference code depends, which is structure data. | - | | | | | - | | | | Model developers need to provide the package name, installation mode, and version constraints. Only the pip installation mode is supported. :ref:`Table 6 ` describes the dependency array. | - | | | | | - | | | | If the model package does not contain the **customize_service.py** file, you do not need to set this parameter. Dependency packages cannot be installed for custom image models. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | health | No | **health** data structure | Configuration of an image health interface. This parameter is mandatory only when **model_type** is set to **Image**. For details about the health data structure, see :ref:`Table 8 `. | - +-----------------+-----------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table81712704511: - -.. table:: **Table 2** **metrics** object description - - +-----------+-----------+-----------+---------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +===========+===========+===========+=========================================================+ - | f1 | No | Number | F1 score. The value is rounded to 17 decimal places. | - +-----------+-----------+-----------+---------------------------------------------------------+ - | recall | No | Number | Recall rate. The value is rounded to 17 decimal places. | - +-----------+-----------+-----------+---------------------------------------------------------+ - | precision | No | Number | Precision. The value is rounded to 17 decimal places. | - +-----------+-----------+-----------+---------------------------------------------------------+ - | accuracy | No | Number | Accuracy. The value is rounded to 17 decimal places. | - +-----------+-----------+-----------+---------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table1683418482455: - -.. table:: **Table 3** **api** array - - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +===========+===========+===========+=======================================================================================================================================================================================================================================================================================================+ - | protocol | No | String | Request protocol. The default value is **http**. Set the parameter value to **http** or **https** based on your custom image. For details about other parameter, see :ref:`Example of the Object Detection Model Configuration File `. | - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | url | No | String | Request path. The default value is a slash (**/**). For a custom image model (**model_type** is **Image**), set this parameter to the actual request path exposed in the image. For a non-custom image model (**model_type** is not **Image**), the URL can only be **/**. | - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | method | No | String | Request method. The default value is **POST**. | - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | request | No | Object | Request body. For details about the **request** structure, see :ref:`Table 4 `. | - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | response | No | Object | Response body. For details about the **response** structure, see :ref:`Table 5 `. | - +-----------+-----------+-----------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table332913335466: - -.. table:: **Table 4** **request** description - - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +=================+============================+=================+========================================================================================+ - | Content-type | Yes for real-time services | String | Data is sent in a specified content format. The default value is **application/json**. | - | | | | | - | | No for batch services | | The options are as follows: | - | | | | | - | | | | - **application/json**: sends JSON data. | - | | | | - **multipart/form-data**: uploads a file. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For machine learning models, only **application/json** is supported. | - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - | data | Yes for real-time services | String | The request body is described in JSON schema. | - | | | | | - | | No for batch services | | | - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table17521240184711: - -.. table:: **Table 5** **response** description - - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +=================+============================+=================+========================================================================================+ - | Content-type | Yes for real-time services | String | Data is sent in a specified content format. The default value is **application/json**. | - | | | | | - | | No for batch services | | The options are as follows: | - | | | | | - | | | | - **application/json**: sends JSON data. | - | | | | - **multipart/form-data**: uploads a file. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For machine learning models, only **application/json** is supported. | - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - | data | Yes for real-time services | String | The response body is described in JSON schema. | - | | | | | - | | No for batch services | | | - +-----------------+----------------------------+-----------------+----------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table13709813144819: - -.. table:: **Table 6** **dependency** array - - +-----------+-----------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Data Type | Description | - +===========+===========+===============+================================================================================================================================================================+ - | installer | Yes | String | Installation method. Only **pip** is supported. | - +-----------+-----------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | packages | Yes | package array | Dependency package collection. For details about the package structure array, see :ref:`Table 7 `. | - +-----------+-----------+---------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table47885356482: - -.. table:: **Table 7** package array - - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=================+=================+=================+=========================================================================================================================================================================================+ - | package_name | Yes | String | Dependency package name. Chinese characters and special characters (&!'"<>=) are not allowed. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | package_version | No | String | Dependency package version. If the dependency package does not rely on the version number, leave this field blank. Chinese characters and special characters (&!'"<>=) are not allowed. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | restraint | No | String | Version restriction. This parameter is mandatory only when **package_version** is configured. Possible values are **EXACT**, **ATLEAST**, and **ATMOST**. | - | | | | | - | | | | - **EXACT** indicates that a specified version is installed. | - | | | | - **ATLEAST** indicates that the version of the installation package is not earlier than the specified version. | - | | | | - **ATMOST** indicates that the version of the installation package is not later than the specified version. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | - If there are specific requirements on the version, preferentially use **EXACT**. If **EXACT** conflicts with the system installation packages, you can select **ATLEAST**. | - | | | | - If there is no specific requirement on the version, retain only the **package_name** parameter and leave **restraint** and **package_version** blank. | - +-----------------+-----------------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_table115896191852: - -.. table:: **Table 8** **health** data structure description - - +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------+ - | Parameter | Mandatory | Type | Description | - +=======================+===========+========+============================================================================================================+ - | url | Yes | String | Request URL of the health check interface | - +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------+ - | protocol | No | String | Request protocol of the health check interface. Only HTTP is supported. | - +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------+ - | initial_delay_seconds | No | String | After an instance is started, a health check starts after seconds configured in **initial_delay_seconds**. | - +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------+ - | timeout_seconds | No | String | Health check timeout | - +-----------------------+-----------+--------+------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_section218715919415: - -Example of the Object Detection Model Configuration File --------------------------------------------------------- - -The following code uses the TensorFlow engine as an example. You can modify the **model_type** parameter based on the actual engine type. - -- Model input - - Key: images - - Value: image files - -- Model output - - +-----------------------------------+-----------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "detection_classes": [ | - | 4 | "face", | - | 5 | "arm" | - | 6 | ], | - | 7 | "detection_boxes": [ | - | 8 | [ | - | 9 | 33.6, | - | 10 | 42.6, | - | 11 | 104.5, | - | 12 | 203.4 | - | 13 | ], | - | 14 | [ | - | 15 | 103.1, | - | 16 | 92.8, | - | 17 | 765.6, | - | 18 | 945.7 | - | 19 | ] | - | 20 | ], | - | 21 | "detection_scores": [0.99, 0.73] | - | 22 | } | - | 23 | ``` | - +-----------------------------------+-----------------------------------------+ - -- Configuration file - - +-----------------------------------+-------------------------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "model_type": "TensorFlow", | - | 4 | "model_algorithm": "object_detection", | - | 5 | "metrics": { | - | 6 | "f1": 0.345294, | - | 7 | "accuracy": 0.462963, | - | 8 | "precision": 0.338977, | - | 9 | "recall": 0.351852 | - | 10 | }, | - | 11 | "apis": [{ | - | 12 | "protocol": "http", | - | 13 | "url": "/", | - | 14 | "method": "post", | - | 15 | "request": { | - | 16 | "Content-type": "multipart/form-data", | - | 17 | "data": { | - | 18 | "type": "object", | - | 19 | "properties": { | - | 20 | "images": { | - | 21 | "type": "file" | - | 22 | } | - | 23 | } | - | 24 | } | - | 25 | }, | - | 26 | "response": { | - | 27 | "Content-type": "multipart/form-data", | - | 28 | "data": { | - | 29 | "type": "object", | - | 30 | "properties": { | - | 31 | "detection_classes": { | - | 32 | "type": "array", | - | 33 | "items": [{ | - | 34 | "type": "string" | - | 35 | }] | - | 36 | }, | - | 37 | "detection_boxes": { | - | 38 | "type": "array", | - | 39 | "items": [{ | - | 40 | "type": "array", | - | 41 | "minItems": 4, | - | 42 | "maxItems": 4, | - | 43 | "items": [{ | - | 44 | "type": "number" | - | 45 | }] | - | 46 | }] | - | 47 | }, | - | 48 | "detection_scores": { | - | 49 | "type": "array", | - | 50 | "items": [{ | - | 51 | "type": "number" | - | 52 | }] | - | 53 | } | - | 54 | } | - | 55 | } | - | 56 | } | - | 57 | }], | - | 58 | "dependencies": [{ | - | 59 | "installer": "pip", | - | 60 | "packages": [{ | - | 61 | "restraint": "EXACT", | - | 62 | "package_version": "1.15.0", | - | 63 | "package_name": "numpy" | - | 64 | }, | - | 65 | { | - | 66 | "restraint": "EXACT", | - | 67 | "package_version": "5.2.0", | - | 68 | "package_name": "Pillow" | - | 69 | } | - | 70 | ] | - | 71 | }] | - | 72 | } | - | 73 | ``` | - +-----------------------------------+-------------------------------------------------------+ - -Example of the Image Classification Model Configuration File ------------------------------------------------------------- - -The following code uses the TensorFlow engine as an example. You can modify the **model_type** parameter based on the actual engine type. - -- Model input - - Key: images - - Value: image files - -- Model output - - +-----------------------------------+-------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "predicted_label": "flower", | - | 4 | "scores": [ | - | 5 | ["rose", 0.99], | - | 6 | ["begonia", 0.01] | - | 7 | ] | - | 8 | } | - | 9 | ``` | - +-----------------------------------+-------------------------------------+ - -- Configuration file - - +-----------------------------------+---------------------------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "model_type": "TensorFlow", | - | 4 | "model_algorithm": "image_classification", | - | 5 | "metrics": { | - | 6 | "f1": 0.345294, | - | 7 | "accuracy": 0.462963, | - | 8 | "precision": 0.338977, | - | 9 | "recall": 0.351852 | - | 10 | }, | - | 11 | "apis": [{ | - | 12 | "protocol": "http", | - | 13 | "url": "/", | - | 14 | "method": "post", | - | 15 | "request": { | - | 16 | "Content-type": "multipart/form-data", | - | 17 | "data": { | - | 18 | "type": "object", | - | 19 | "properties": { | - | 20 | "images": { | - | 21 | "type": "file" | - | 22 | } | - | 23 | } | - | 24 | } | - | 25 | }, | - | 26 | "response": { | - | 27 | "Content-type": "multipart/form-data", | - | 28 | "data": { | - | 29 | "type": "object", | - | 30 | "properties": { | - | 31 | "predicted_label": { | - | 32 | "type": "string" | - | 33 | }, | - | 34 | "scores": { | - | 35 | "type": "array", | - | 36 | "items": [{ | - | 37 | "type": "array", | - | 38 | "minItems": 2, | - | 39 | "maxItems": 2, | - | 40 | "items": [ | - | 41 | { | - | 42 | "type": "string" | - | 43 | }, | - | 44 | { | - | 45 | "type": "number" | - | 46 | } | - | 47 | ] | - | 48 | }] | - | 49 | } | - | 50 | } | - | 51 | } | - | 52 | } | - | 53 | }], | - | 54 | "dependencies": [{ | - | 55 | "installer": "pip", | - | 56 | "packages": [{ | - | 57 | "restraint": "ATLEAST", | - | 58 | "package_version": "1.15.0", | - | 59 | "package_name": "numpy" | - | 60 | }, | - | 61 | { | - | 62 | "restraint": "", | - | 63 | "package_version": "", | - | 64 | "package_name": "Pillow" | - | 65 | } | - | 66 | ] | - | 67 | }] | - | 68 | } | - | 69 | ``` | - +-----------------------------------+---------------------------------------------------------+ - -Example of the Predictive Analytics Model Configuration File ------------------------------------------------------------- - -The following code uses the TensorFlow engine as an example. You can modify the **model_type** parameter based on the actual engine type. - -- Model input - - +-----------------------------------+--------------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "data": { | - | 4 | "req_data": [ | - | 5 | { | - | 6 | "buying_price": "high", | - | 7 | "maint_price": "high", | - | 8 | "doors": "2", | - | 9 | "persons": "2", | - | 10 | "lug_boot": "small", | - | 11 | "safety": "low", | - | 12 | "acceptability": "acc" | - | 13 | }, | - | 14 | { | - | 15 | "buying_price": "high", | - | 16 | "maint_price": "high", | - | 17 | "doors": "2", | - | 18 | "persons": "2", | - | 19 | "lug_boot": "small", | - | 20 | "safety": "low", | - | 21 | "acceptability": "acc" | - | 22 | } | - | 23 | ] | - | 24 | } | - | 25 | } | - | 26 | ``` | - +-----------------------------------+--------------------------------------------+ - -- Model output - - +-----------------------------------+----------------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "data": { | - | 4 | "resp_data": [ | - | 5 | { | - | 6 | "predict_result": "unacc" | - | 7 | }, | - | 8 | { | - | 9 | "predict_result": "unacc" | - | 10 | } | - | 11 | ] | - | 12 | } | - | 13 | } | - | 14 | ``` | - +-----------------------------------+----------------------------------------------+ - -- Configuration file - - +-----------------------------------+------------------------------------------------------------------+ - | :: | :: | - | | | - | 1 | ``` | - | 2 | { | - | 3 | "model_type": "TensorFlow", | - | 4 | "model_algorithm": "predict_analysis", | - | 5 | "metrics": { | - | 6 | "f1": 0.345294, | - | 7 | "accuracy": 0.462963, | - | 8 | "precision": 0.338977, | - | 9 | "recall": 0.351852 | - | 10 | }, | - | 11 | "apis": [ | - | 12 | { | - | 13 | "protocol": "http", | - | 14 | "url": "/", | - | 15 | "method": "post", | - | 16 | "request": { | - | 17 | "Content-type": "application/json", | - | 18 | "data": { | - | 19 | "type": "object", | - | 20 | "properties": { | - | 21 | "data": { | - | 22 | "type": "object", | - | 23 | "properties": { | - | 24 | "req_data": { | - | 25 | "items": [ | - | 26 | { | - | 27 | "type": "object", | - | 28 | "properties": { | - | 29 | } | - | 30 | }], | - | 31 | "type": "array" | - | 32 | } | - | 33 | } | - | 34 | } | - | 35 | } | - | 36 | } | - | 37 | }, | - | 38 | "response": { | - | 39 | "Content-type": "multipart/form-data", | - | 40 | "data": { | - | 41 | "type": "object", | - | 42 | "properties": { | - | 43 | "data": { | - | 44 | "type": "object", | - | 45 | "properties": { | - | 46 | "resp_data": { | - | 47 | "type": "array", | - | 48 | "items": [ | - | 49 | { | - | 50 | "type": "object", | - | 51 | "properties": { | - | 52 | } | - | 53 | }] | - | 54 | } | - | 55 | } | - | 56 | } | - | 57 | } | - | 58 | } | - | 59 | } | - | 60 | }], | - | 61 | "dependencies": [ | - | 62 | { | - | 63 | "installer": "pip", | - | 64 | "packages": [ | - | 65 | { | - | 66 | "restraint": "EXACT", | - | 67 | "package_version": "1.15.0", | - | 68 | "package_name": "numpy" | - | 69 | }, | - | 70 | { | - | 71 | "restraint": "EXACT", | - | 72 | "package_version": "5.2.0", | - | 73 | "package_name": "Pillow" | - | 74 | }] | - | 75 | }] | - | 76 | } | - | 77 | ``` | - +-----------------------------------+------------------------------------------------------------------+ - -.. _modelarts_23_0092__en-us_topic_0172466149_section9113122232018: - -Example of the Custom Image Model Configuration File ----------------------------------------------------- - -The model input and output are similar to those in :ref:`Example of the Object Detection Model Configuration File `. - -+-----------------------------------+---------------------------------------------------------+ -| :: | :: | -| | | -| 1 | { | -| 2 | "model_algorithm": "image_classification", | -| 3 | "model_type": "Image", | -| 4 | | -| 5 | "metrics": { | -| 6 | "f1": 0.345294, | -| 7 | "accuracy": 0.462963, | -| 8 | "precision": 0.338977, | -| 9 | "recall": 0.351852 | -| 10 | }, | -| 11 | "apis": [{ | -| 12 | "protocol": "http", | -| 13 | "url": "/", | -| 14 | "method": "post", | -| 15 | "request": { | -| 16 | "Content-type": "multipart/form-data", | -| 17 | "data": { | -| 18 | "type": "object", | -| 19 | "properties": { | -| 20 | "images": { | -| 21 | "type": "file" | -| 22 | } | -| 23 | } | -| 24 | } | -| 25 | }, | -| 26 | "response": { | -| 27 | "Content-type": "multipart/form-data", | -| 28 | "data": { | -| 29 | "type": "object", | -| 30 | "required": [ | -| 31 | "predicted_label", | -| 32 | "scores" | -| 33 | ], | -| 34 | "properties": { | -| 35 | "predicted_label": { | -| 36 | "type": "string" | -| 37 | }, | -| 38 | "scores": { | -| 39 | "type": "array", | -| 40 | "items": [{ | -| 41 | "type": "array", | -| 42 | "minItems": 2, | -| 43 | "maxItems": 2, | -| 44 | "items": [{ | -| 45 | "type": "string" | -| 46 | }, | -| 47 | { | -| 48 | "type": "number" | -| 49 | } | -| 50 | ] | -| 51 | }] | -| 52 | } | -| 53 | } | -| 54 | } | -| 55 | } | -| 56 | }] | -| 57 | } | -+-----------------------------------+---------------------------------------------------------+ - -Example of the Machine Learning Model Configuration File --------------------------------------------------------- - -The following uses XGBoost as an example: - -- Model input - -.. code-block:: - - { - "data": { - "req_data": [{ - "sepal_length": 5, - "sepal_width": 3.3, - "petal_length": 1.4, - "petal_width": 0.2 - }, { - "sepal_length": 5, - "sepal_width": 2, - "petal_length": 3.5, - "petal_width": 1 - }, { - "sepal_length": 6, - "sepal_width": 2.2, - "petal_length": 5, - "petal_width": 1.5 - }] - } - } - -- Model output - -.. code-block:: - - { - "data": { - "resp_data": [{ - "predict_result": "Iris-setosa" - }, { - "predict_result": "Iris-versicolor" - }] - } - } - -- Configuration file - -.. code-block:: - - { - "model_type": "XGBoost", - "model_algorithm": "xgboost_iris_test", - "runtime": "python2.7", - "metrics": { - "f1": 0.345294, - "accuracy": 0.462963, - "precision": 0.338977, - "recall": 0.351852 - }, - "apis": [ - { - "protocol": "http", - "url": "/", - "method": "post", - "request": { - "Content-type": "application/json", - "data": { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "req_data": { - "items": [ - { - "type": "object", - "properties": {} - } - ], - "type": "array" - } - } - } - } - } - }, - "response": { - "Content-type": "applicaton/json", - "data": { - "type": "object", - "properties": { - "resp_data": { - "type": "array", - "items": [ - { - "type": "object", - "properties": { - "predict_result": { - "type": "number" - } - } - } - ] - } - } - } - } - } - ] - } - -.. _modelarts_23_0092__en-us_topic_0172466149_section119911955122011: - -Example of a Model Configuration File Using a Custom Dependency Package ------------------------------------------------------------------------ - -The following example defines the NumPy 1.16.4 dependency environment. - -+-----------------------------------+------------------------------------------------------------+ -| :: | :: | -| | | -| 1 | { | -| 2 | "model_algorithm": "image_classification", | -| 3 | "model_type": "TensorFlow", | -| 4 | "runtime": "python3.6", | -| 5 | "apis": [{ | -| 6 | "procotol": "http", | -| 7 | "url": "/", | -| 8 | "method": "post", | -| 9 | "request": { | -| 10 | "Content-type": "multipart/form-data", | -| 11 | "data": { | -| 12 | "type": "object", | -| 13 | "properties": { | -| 14 | "images": { | -| 15 | "type": "file" | -| 16 | } | -| 17 | } | -| 18 | } | -| 19 | }, | -| 20 | "response": { | -| 21 | "Content-type": "applicaton/json", | -| 22 | "data": { | -| 23 | "type": "object", | -| 24 | "properties": { | -| 25 | "mnist_result": { | -| 26 | "type": "array", | -| 27 | "item": [{ | -| 28 | "type": "string" | -| 29 | }] | -| 30 | } | -| 31 | } | -| 32 | } | -| 33 | } | -| 34 | } | -| 35 | ], | -| 36 | "metrics": { | -| 37 | "f1": 0.124555, | -| 38 | "recall": 0.171875, | -| 39 | "precision": 0.0023493892851938493, | -| 40 | "accuracy": 0.00746268656716417 | -| 41 | }, | -| 42 | "dependencies": [{ | -| 43 | "installer": "pip", | -| 44 | "packages": [{ | -| 45 | "restraint": "EXACT", | -| 46 | "package_version": "1.16.4", | -| 47 | "package_name": "numpy" | -| 48 | } | -| 49 | ] | -| 50 | }] | -| 51 | } | -+-----------------------------------+------------------------------------------------------------+ diff --git a/modelarts/umn/result/model_templates/index.rst b/modelarts/umn/result/model_templates/index.rst deleted file mode 100644 index a80adbf2..00000000 --- a/modelarts/umn/result/model_templates/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0097: - -=============== -Model Templates -=============== - -.. toctree:: - :maxdepth: 1 - - introduction_to_model_templates - template_description/index - input_and_output_modes/index diff --git a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_image_processing_mode.rst b/modelarts/umn/result/model_templates/input_and_output_modes/built-in_image_processing_mode.rst deleted file mode 100644 index db578b23..00000000 --- a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_image_processing_mode.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _modelarts_23_0101: - -Built-in Image Processing Mode -============================== - -Input ------ - -The built-in image processing input and output mode can be applied to models such as image classification, object detection, and image semantic segmentation. The prediction request path is **/**, the request protocol is **HTTPS**, the request method is **POST**, **Content-Type** is **multipart/form-data**, **key** is **images**, and **type** is **file**. Before selecting this mode, ensure that your model can process the input data whose **key** is **images**. - -Output ------- - -The inference result is returned in JSON format. The specific fields are determined by the model. - -Sample Request --------------- - -In this mode, input an image to be processed in the inference request. The response in JSON format varies according to the model. The following are examples: - -- Performing prediction on the console - -- Using Postman to call a RESTful API for prediction - - After a model is deployed as a service, you can obtain the API URL on the **Usage Guides** tab page of the service details page. On the **Body** tab page, set the request body. Set **key** to **images**, select **File**, select the image to be processed, and click **send** to send your prediction request. diff --git a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_object_detection_mode.rst b/modelarts/umn/result/model_templates/input_and_output_modes/built-in_object_detection_mode.rst deleted file mode 100644 index 0362dd84..00000000 --- a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_object_detection_mode.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. _modelarts_23_0100: - -Built-in Object Detection Mode -============================== - -Input ------ - -This is a built-in input and output mode for object detection. The models using this mode are identified as object detection models. The prediction request path is **/**, the request protocol is **HTTP**, the request method is **POST**, **Content-Type** is **multipart/form-data**, **key** is **images**, and **type** is **file**. Before selecting this mode, ensure that your model can process the input data whose **key** is **images**. - -Output ------- - -The inference result is returned in JSON format. For details about the fields, see :ref:`Table 1 `. - -.. _modelarts_23_0100__en-us_topic_0172873542_table101531747125712: - -.. table:: **Table 1** Parameters - - +-------------------+--------------+-----------------------------------------------------------------------------------------+ - | Field | Type | Description | - +===================+==============+=========================================================================================+ - | detection_classes | String array | List of detected objects, for example, **["flowers","cat"]** | - +-------------------+--------------+-----------------------------------------------------------------------------------------+ - | detection_boxes | Float array | Coordinates of the bounding box, in the format of |image2| | - +-------------------+--------------+-----------------------------------------------------------------------------------------+ - | detection_scores | Float array | Confidence scores of detected objects, which are used to measure the detection accuracy | - +-------------------+--------------+-----------------------------------------------------------------------------------------+ - -The **JSON Schema** of the inference result is as follows: - -.. code-block:: - - { - "type": "object", - "properties": { - "detection_classes": { - "items": { - "type": "string" - }, - "type": "array" - }, - "detection_boxes": { - "items": { - "minItems": 4, - "items": { - "type": "number" - }, - "type": "array", - "maxItems": 4 - }, - "type": "array" - }, - "detection_scores": { - "items": { - "type": "string" - }, - "type": "array" - } - } - } - -Sample Request --------------- - -In this mode, input an image to be processed in the inference request. The inference result is returned in JSON format. The following are examples: - -- Performing prediction on the console - - On the **Prediction** tab page of the service details page, upload an image and click **Predict** to obtain the prediction result. - -- Using Postman to call a RESTful API for prediction - - After a model is deployed as a service, you can obtain the API URL on the **Usage Guides** tab page of the service details page. - - - On the **Headers** tab page, set **Content-Type** to **multipart/form-data** and **X-Auth-Token** to the actual token obtained. - - - On the **Body** tab page, set the request body. Set **key** to **images**, select **File**, select the image to be processed, and click **send** to send your prediction request. - -.. |image1| image:: /_static/images/en-us_image_0000001110761158.png - -.. |image2| image:: /_static/images/en-us_image_0000001110761158.png - diff --git a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_predictive_analytics_mode.rst b/modelarts/umn/result/model_templates/input_and_output_modes/built-in_predictive_analytics_mode.rst deleted file mode 100644 index 70595aa8..00000000 --- a/modelarts/umn/result/model_templates/input_and_output_modes/built-in_predictive_analytics_mode.rst +++ /dev/null @@ -1,118 +0,0 @@ -.. _modelarts_23_0102: - -Built-in Predictive Analytics Mode -================================== - -Input ------ - -This is a built-in input and output mode for predictive analytics. The models using this mode are identified as predictive analytics models. The prediction request path is **/**, the request protocol is **HTTP**, the request method is **POST**, and **Content-Type** is **application/json**. The request body is in JSON format. For details about the JSON fields, see :ref:`Table 1 `. Before selecting this mode, ensure that your model can process the input data in **JSON Schema** format. - -.. _modelarts_23_0102__en-us_topic_0172873544_table101531747125712: - -.. table:: **Table 1** JSON field description - - +-------+----------------+----------------------------------------------------------------------------------------------------------------+ - | Field | Type | Description | - +=======+================+================================================================================================================+ - | data | Data structure | Inference data. For details, see :ref:`Table 2 `. | - +-------+----------------+----------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0102__en-us_topic_0172873544_table159187574436: - -.. table:: **Table 2** **Data** description - - ======== ============= ====================== - Field Type Description - ======== ============= ====================== - req_data ReqData array List of inference data - ======== ============= ====================== - -**ReqData** is of the **Object** type and indicates the inference data. The data structure is determined by the application scenario. For models using this mode, the preprocessing logic in the custom model inference code should be able to correctly process the data inputted in the format defined by the mode. - -The **JSON Schema** of a prediction request is as follows: - -.. code-block:: - - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "req_data": { - "items": [{ - "type": "object", - "properties": {} - }], - "type": "array" - } - } - } - } - } - -Output ------- - -The inference result is returned in JSON format. For details about the JSON fields, see :ref:`Table 3 `. - -.. _modelarts_23_0102__en-us_topic_0172873544_table49621346461: - -.. table:: **Table 3** JSON field description - - +-------+----------------+----------------------------------------------------------------------------------------------------------------+ - | Field | Type | Description | - +=======+================+================================================================================================================+ - | data | Data structure | Inference data. For details, see :ref:`Table 4 `. | - +-------+----------------+----------------------------------------------------------------------------------------------------------------+ - -.. _modelarts_23_0102__en-us_topic_0172873544_table196311344469: - -.. table:: **Table 4** **Data** description - - ========= ============== ========================== - Field Type Description - ========= ============== ========================== - resp_data RespData array List of prediction results - ========= ============== ========================== - -Similar to **ReqData**, **RespData** is also of the **Object** type and indicates the prediction result. Its structure is determined by the application scenario. For models using this mode, the postprocessing logic in the custom model inference code should be able to correctly output data in the format defined by the mode. - -The **JSON Schema** of a prediction result is as follows: - -.. code-block:: - - { - "type": "object", - "properties": { - "data": { - "type": "object", - "properties": { - "resp_data": { - "type": "array", - "items": [{ - "type": "object", - "properties": {} - }] - } - } - } - } - } - -Sample Request --------------- - -In this mode, input the data to be predicted in JSON format. The prediction result is returned in JSON format. The following are examples: - -- Performing prediction on the console - - On the **Prediction** tab page of the service details page, enter inference code and click **Predict** to obtain the prediction result. - -- Using Postman to call a RESTful API for prediction - - After a model is deployed as a service, you can obtain the API URL on the **Usage Guides** tab page of the service details page. - - - On the **Headers** tab page, set **Content-Type** to **application/json** and **X-Auth-Token** to the actual token obtained. - - On the **Body** tab page, edit the data to be predicted and click **send** to send your prediction request. diff --git a/modelarts/umn/result/model_templates/input_and_output_modes/index.rst b/modelarts/umn/result/model_templates/input_and_output_modes/index.rst deleted file mode 100644 index 92c18a88..00000000 --- a/modelarts/umn/result/model_templates/input_and_output_modes/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. _modelarts_23_0099: - -====================== -Input and Output Modes -====================== - -.. toctree:: - :maxdepth: 1 - - built-in_object_detection_mode - built-in_image_processing_mode - built-in_predictive_analytics_mode - undefined_mode diff --git a/modelarts/umn/result/model_templates/input_and_output_modes/undefined_mode.rst b/modelarts/umn/result/model_templates/input_and_output_modes/undefined_mode.rst deleted file mode 100644 index 46ec796c..00000000 --- a/modelarts/umn/result/model_templates/input_and_output_modes/undefined_mode.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_23_0103: - -Undefined Mode -============== - -Description ------------ - -The undefined mode does not define the input and output mode. The input and output mode is determined by the model. Select this mode only when the existing input and output mode is not applicable to the application scenario of the model. The models imported in undefined mode cannot be deployed as batch services. In addition, the service prediction page may not be displayed properly. New modes are coming soon for more application scenarios. - -Input ------ - -No limit. - -Output ------- - -No limit. - -Sample Request --------------- - -The undefined mode has no specific sample request because the input and output of the request are entirely determined by the model. diff --git a/modelarts/umn/result/model_templates/introduction_to_model_templates.rst b/modelarts/umn/result/model_templates/introduction_to_model_templates.rst deleted file mode 100644 index 4352762d..00000000 --- a/modelarts/umn/result/model_templates/introduction_to_model_templates.rst +++ /dev/null @@ -1,48 +0,0 @@ -.. _modelarts_23_0098: - -Introduction to Model Templates -=============================== - -Because the configurations of models with the same functions are similar, ModelArts integrates the configurations of such models into a common template. By using this template, you can easily and quickly import models without compiling the **config.json** configuration file. In simple terms, a template integrates AI engine and model configurations. Each template corresponds to a specific AI engine and inference mode. With the templates, you can quickly import models to ModelArts. - -Using a Template ----------------- - -The following uses the template described in :ref:`TensorFlow-py36 General Template ` as an example. Upload the TensorFlow model package to OBS before using the template. Store the model files in the **model** directory. When creating a model using this template, you need to select the **model** directory. - -#. On the **Import Model** page, set **Meta Model Source** to **Template**. - -#. In the **Template** area, select **TensorFlow-py36 general template**. - - ModelArts also provides three filter criteria: **Type**, **Engine**, and **Environment**, helping you quickly find the desired template. If the three filter criteria cannot meet your requirements, you can enter keywords to search for the target template. - -#. For **Model Folder**, select the **model** directory where the model files reside. For details, see :ref:`Template Description `. - - .. note:: - - If a training job is executed for multiple times, different version directories are generated, such as V001 and V002, and the generated models are stored in the **model** folder in different version directories. When selecting model files, specify the **model** folder in the corresponding version directory. - -#. If the default input and output mode of the selected template can be overwritten, you can select an input and output mode based on the model function or application scenario. **Input and Output Mode** is an abstract of the API in **config.json**. It describes the interface provided by the model for external inference. An input and output mode describes one or more APIs, and corresponds to a template. - - For details about the supported input and output modes, see :ref:`Input and Output Modes `. - -.. _modelarts_23_0098__en-us_topic_0172873520_section44801025155417: - -Supported Templates -------------------- - -- :ref:`TensorFlow-py36 General Template ` -- :ref:`MXNet-py36 General Template ` -- :ref:`PyTorch-py36 General Template ` -- :ref:`Caffe-CPU-py36 General Template ` -- :ref:`Caffe-GPU-py36 General Template ` - -.. _modelarts_23_0098__en-us_topic_0172873520_section737759781: - -Supported Input and Output Modes --------------------------------- - -- :ref:`Built-in Object Detection Mode ` -- :ref:`Built-in Image Processing Mode ` -- :ref:`Built-in Predictive Analytics Mode ` -- :ref:`Undefined Mode ` diff --git a/modelarts/umn/result/model_templates/template_description/arm-ascend_template.rst b/modelarts/umn/result/model_templates/template_description/arm-ascend_template.rst deleted file mode 100644 index 5b5b8367..00000000 --- a/modelarts/umn/result/model_templates/template_description/arm-ascend_template.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _modelarts_23_0254: - -Arm-Ascend Template -=================== - -Introduction ------------- - -AI engine: MindSpore; Environment: Python 3.5; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the OM-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you cannot select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0254__en-us_topic_0235925353_section1761262493211: - -Model Package Example ---------------------- - -**Structure of the OM-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - ├── model.om (Mandatory) Protocol buffer file, which contains the diagram description of the model - ├──customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/model_templates/template_description/caffe-cpu-py36_general_template.rst b/modelarts/umn/result/model_templates/template_description/caffe-cpu-py36_general_template.rst deleted file mode 100644 index e80d3c35..00000000 --- a/modelarts/umn/result/model_templates/template_description/caffe-cpu-py36_general_template.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _modelarts_23_0169: - -Caffe-CPU-py36 General Template -=============================== - -Introduction ------------- - -AI engine: CPU-based Caffe 1.0; Environment: Python 3.6; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the Caffe-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you can select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0169__en-us_topic_0193596270_section164016197320: - -Model Package Example ---------------------- - -**Structure of the Caffe-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - |── <> (Optional) User's Python package, which can be directly referenced in the model inference code - |── deploy.prototxt (Mandatory) Caffe model file, which contains information such as the model network structure - |── resnet.caffemodel (Mandatory) Caffe model file, which contains variable and weight information - |── customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/model_templates/template_description/caffe-gpu-py36_general_template.rst b/modelarts/umn/result/model_templates/template_description/caffe-gpu-py36_general_template.rst deleted file mode 100644 index 49850480..00000000 --- a/modelarts/umn/result/model_templates/template_description/caffe-gpu-py36_general_template.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _modelarts_23_0170: - -Caffe-GPU-py36 General Template -=============================== - -Introduction ------------- - -AI engine: GPU-based Caffe 1.0; Environment: Python 3.6; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the Caffe-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you can select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0170__en-us_topic_0193596271_section164016197320: - -Model Package Example ---------------------- - -**Structure of the Caffe-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - |── <> (Optional) User's Python package, which can be directly referenced in the model inference code - |── deploy.prototxt (Mandatory) Caffe model file, which contains information such as the model network structure - |── resnet.caffemodel (Mandatory) Caffe model file, which contains variable and weight information - |── customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/model_templates/template_description/index.rst b/modelarts/umn/result/model_templates/template_description/index.rst deleted file mode 100644 index 62f6d1b8..00000000 --- a/modelarts/umn/result/model_templates/template_description/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. _modelarts_23_0118: - -==================== -Template Description -==================== - -.. toctree:: - :maxdepth: 1 - - tensorflow-py36_general_template - mxnet-py36_general_template - pytorch-py36_general_template - caffe-cpu-py36_general_template - caffe-gpu-py36_general_template - arm-ascend_template diff --git a/modelarts/umn/result/model_templates/template_description/mxnet-py36_general_template.rst b/modelarts/umn/result/model_templates/template_description/mxnet-py36_general_template.rst deleted file mode 100644 index 3f54d5aa..00000000 --- a/modelarts/umn/result/model_templates/template_description/mxnet-py36_general_template.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _modelarts_23_0164: - -MXNet-py36 General Template -=========================== - -Introduction ------------- - -AI engine: MXNet 1.2.1; Environment: Python 3.6; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the MXNet-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you can select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0164__en-us_topic_0193596264_section164016197320: - -Model Package Example ---------------------- - -**Structure of the MXNet-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - ├── resnet-50-symbol.json (Mandatory) Model definition file, which contains the neural network description of the model - ├── resnet-50-0000.params (Mandatory) Model variable parameter file, which contains parameter and weight information - ├──customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/model_templates/template_description/pytorch-py36_general_template.rst b/modelarts/umn/result/model_templates/template_description/pytorch-py36_general_template.rst deleted file mode 100644 index e1a35ead..00000000 --- a/modelarts/umn/result/model_templates/template_description/pytorch-py36_general_template.rst +++ /dev/null @@ -1,52 +0,0 @@ -.. _modelarts_23_0166: - -PyTorch-py36 General Template -============================= - -Introduction ------------- - -AI engine: PyTorch 1.0; Environment: Python 3.6; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the PyTorch-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you can select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0166__en-us_topic_0193596267_section164016197320: - -Model Package Example ---------------------- - -**Structure of the PyTorch-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - ├── resnet50.pth (Mandatory) PyTorch model file, which contains variable and weight information - ├──customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/model_templates/template_description/tensorflow-py36_general_template.rst b/modelarts/umn/result/model_templates/template_description/tensorflow-py36_general_template.rst deleted file mode 100644 index 74f0b540..00000000 --- a/modelarts/umn/result/model_templates/template_description/tensorflow-py36_general_template.rst +++ /dev/null @@ -1,55 +0,0 @@ -.. _modelarts_23_0162: - -TensorFlow-py36 General Template -================================ - -Introduction ------------- - -AI engine: TensorFlow 1.8; Environment: Python 3.6; Input and output mode: undefined mode. Select an appropriate input and output mode based on the model function or application scenario. When using the template to import a model, select the **model** directory containing the model files. - -Template Input --------------- - -The template input is the TensorFlow-based model package stored on OBS. Ensure that the OBS directory you use and ModelArts are in the same region. For details about model package requirements, see :ref:`Model Package Example `. - -Input and Output Mode ---------------------- - -:ref:`Undefined Mode ` can be overwritten. That is, you can select another input and output mode during model creation. - -Model Package Specifications ----------------------------- - -- The model package must be stored in the OBS folder named **model**. Model files and the model inference code file are stored in the **model** folder. -- The model inference code file is optional. If the file exists, the file name must be **customize_service.py**. Only one inference code file can exist in the **model** folder. For details about how to compile the model inference code file, see :ref:`Specifications for Compiling Model Inference Code `. - -- The structure of the model package imported using the template is as follows: - - .. code-block:: - - model/ - │ - ├── Model file //(Mandatory) The model file format varies according to the engine. For details, see the model package example. - ├── Custom Python package //(Optional) User's Python package, which can be directly referenced in the model inference code - ├── customize_service.py //(Optional) Model inference code file. The file name must be customize_service.py. Otherwise, the code is not considered as inference code. - -.. _modelarts_23_0162__en-us_topic_0193596262_section1761262493211: - -Model Package Example ---------------------- - -**Structure of the TensorFlow-based model package** - -When publishing the model, you only need to specify the **model** directory. - -.. code-block:: - - OBS bucket/directory name - |── model (Mandatory) The folder must be named model and is used to store model-related files. - ├── <> (Optional) User's Python package, which can be directly referenced in the model inference code - ├── saved_model.pb (Mandatory) Protocol buffer file, which contains the diagram description of the model - ├── variables Mandatory for the main file of the *.pb model. The folder must be named variables and contains the weight deviation of the model. - ├── variables.index Mandatory - ├── variables.data-00000-of-00001 Mandatory - ├──customize_service.py (Optional) Model inference code file. The file must be named customize_service.py. Only one inference code file exists. The .py file on which customize_service.py depends can be directly put in the model directory. diff --git a/modelarts/umn/result/monitoring/index.rst b/modelarts/umn/result/monitoring/index.rst deleted file mode 100644 index 17caaf19..00000000 --- a/modelarts/umn/result/monitoring/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0186: - -========== -Monitoring -========== - -.. toctree:: - :maxdepth: 1 - - modelarts_metrics - setting_alarm_rules - viewing_monitoring_metrics diff --git a/modelarts/umn/result/monitoring/modelarts_metrics.rst b/modelarts/umn/result/monitoring/modelarts_metrics.rst deleted file mode 100644 index 8786c3d7..00000000 --- a/modelarts/umn/result/monitoring/modelarts_metrics.rst +++ /dev/null @@ -1,129 +0,0 @@ -.. _modelarts_23_0187: - -ModelArts Metrics -================= - -Description ------------ - -The cloud service platform provides Cloud Eye to help you better understand the status of your ModelArts real-time services and models. You can use Cloud Eye to automatically monitor your ModelArts real-time services and models in real time and manage alarms and notifications, so that you can keep track of performance metrics of ModelArts and models. - -Namespace ---------- - -SYS.ModelArts - -Monitoring Metrics ------------------- - -.. table:: **Table 1** ModelArts metrics - - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | Metric ID | Metric Name | Meaning | Value Range | Measurement Object & Dimension | Monitoring Interval | - +=============================================================================================================================================================================================================================+============================+===================================================+=============+================================+=====================+ - | cpu_usage | CPU Usage | CPU usage of ModelArts | ≥ 0% | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: % | | ModelArts models | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | mem_usage | Memory Usage | Memory usage of ModelArts | ≥ 0% | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: % | | ModelArts models | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | gpu_util | GPU Usage | GPU usage of ModelArts | ≥ 0% | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: % | | ModelArts models | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | gpu_mem_usage | GPU Memory Usage | GPU memory usage of ModelArts | ≥ 0% | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: % | | ModelArts models | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | successfully_called_times | Number of Successful Calls | Times that ModelArts has been successfully called | ≥Count/min | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: Times/min | | ModelArts models | | - | | | | | | | - | | | | | ModelArts real-time services | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id, | | - | | | | | | | - | | | | | service_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | failed_called_times | Number of Failed Calls | Times that ModelArts failed to be called | ≥Count/min | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: Times/min | | ModelArts models | | - | | | | | | | - | | | | | ModelArts real-time services | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id, | | - | | | | | | | - | | | | | service_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | total_called_times | API Calls | Times that ModelArts is called | ≥Count/min | Measurement object: | 1 minute | - | | | | | | | - | | | Unit: Times/min | | ModelArts models | | - | | | | | | | - | | | | | ModelArts real-time services | | - | | | | | | | - | | | | | Dimension: | | - | | | | | | | - | | | | | model_id, | | - | | | | | | | - | | | | | service_id | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - | If a measurement object has multiple measurement dimensions, all the measurement dimensions are mandatory when you use an API to query monitoring metrics. | | | | | | - | | | | | | | - | - The following provides an example of using the multi-dimensional **dim** to query a single monitoring metric: dim.0=service_id,530cd6b0-86d7-4818-837f-935f6a27414d&dim.1="model_id,3773b058-5b4f-4366-9035-9bbd9964714a | | | | | | - | | | | | | | - | - The following provides an example of using the multi-dimensional **dim** to query monitoring metrics in batches: | | | | | | - | | | | | | | - | "dimensions": [ | | | | | | - | | | | | | | - | { | | | | | | - | | | | | | | - | "name": "service_id", | | | | | | - | | | | | | | - | "value": "530cd6b0-86d7-4818-837f-935f6a27414d" | | | | | | - | | | | | | | - | } | | | | | | - | | | | | | | - | { | | | | | | - | | | | | | | - | "name": "model_id", | | | | | | - | | | | | | | - | "value": "3773b058-5b4f-4366-9035-9bbd9964714a" | | | | | | - | | | | | | | - | } | | | | | | - | | | | | | | - | ], | | | | | | - +-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+----------------------------+---------------------------------------------------+-------------+--------------------------------+---------------------+ - -Dimensions ----------- - -.. table:: **Table 2** Dimension description - - ========== ==================== - Key Value - ========== ==================== - service_id Real-time service ID - model_id Model ID - ========== ==================== diff --git a/modelarts/umn/result/monitoring/setting_alarm_rules.rst b/modelarts/umn/result/monitoring/setting_alarm_rules.rst deleted file mode 100644 index 5a6bc4df..00000000 --- a/modelarts/umn/result/monitoring/setting_alarm_rules.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. _modelarts_23_0188: - -Setting Alarm Rules -=================== - -Scenario --------- - -Setting alarm rules allows you to customize the monitored objects and notification policies so that you can know the status of ModelArts real-time services and models in a timely manner. - -An alarm rule includes the alarm rule name, monitored object, metric, threshold, monitoring interval, and whether to send a notification. This section describes how to set alarm rules for ModelArts services and models. - -Prerequisites -------------- - -You have created an ModelArts real-time service. - -Procedure ---------- - -#. Log in to the management console. -#. Click **Service List**. Under **Management & Deployment**, click **Cloud Eye**. -#. In the left navigation pane, choose **Cloud Service Monitoring > ModelArts**. -#. Select a real-time service for which you want to create an alarm rule and click **Create Alarm Rule** in the **Operation** column. -#. On the **Create Alarm Rule** page, create an alarm rule for ModelArts real-time services and models as prompted. -#. After the setting is complete, click **Create**. When an alarm that meets the rule is generated, the system automatically sends a notification. diff --git a/modelarts/umn/result/monitoring/viewing_monitoring_metrics.rst b/modelarts/umn/result/monitoring/viewing_monitoring_metrics.rst deleted file mode 100644 index 5cad4757..00000000 --- a/modelarts/umn/result/monitoring/viewing_monitoring_metrics.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. _modelarts_23_0189: - -Viewing Monitoring Metrics -========================== - -Scenario --------- - -Cloud Eye on the cloud service platform monitors the status of ModelArts real-time services and model loads. You can obtain the monitoring metrics of each ModelArts real-time service and model loads on the management console. Monitored data requires a period of time for transmission and display. The status of ModelArts displayed on the Cloud Eye console is usually the status obtained 5 to 10 minutes before. You can view the monitored data of a newly created real-time service 5 to 10 minutes later. - -Prerequisites -------------- - -- The ModelArts real-time service is running properly. - -- Alarm rules have been configured on the Cloud Eye page. For details, see :ref:`Setting Alarm Rules `. -- The real-time service has been properly running for at least 10 minutes. -- The monitoring data and graphics are available for a new real-time service after the service runs for at least 10 minutes. - -- Cloud Eye does not display the metrics of a faulty or deleted real-time service. The monitoring metrics can be viewed after the real-time service starts or recovers. - -Monitoring data is unavailable without alarm rules configured on Cloud Eye. For details, see :ref:`Setting Alarm Rules `. - -Procedure ---------- - -#. Log in to the management console. - -#. Click **Service List**. Under **Management & Deployment**, click **Cloud Eye**. - -#. In the left navigation pane, choose **Cloud Service Monitoring > ModelArts**. - -#. View monitoring graphs. - - - Viewing monitoring graphs of the real-time service: Click **View Graph** in the **Operation** column. - - Viewing monitoring graphs of the model loads: Click |image1| next to the target real-time service, and select **View Graph** from the drop-down list for model loads in the **Operation** column. - -#. In the monitoring area, you can select a duration to view the monitoring data. - - You can view the monitoring data in the recent 1 hour, 3 hours, or 12 hours. To view the monitoring curve of a longer time range, click |image2| to enlarge the graph. - -.. |image1| image:: /_static/images/en-us_image_0000001110920964.png - -.. |image2| image:: /_static/images/en-us_image_0000001110761062.png - diff --git a/modelarts/umn/result/permissions_management/basic_concepts.rst b/modelarts/umn/result/permissions_management/basic_concepts.rst deleted file mode 100644 index 91919d17..00000000 --- a/modelarts/umn/result/permissions_management/basic_concepts.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_23_0078: - -Basic Concepts -============== - -A fine-grained policy is a set of permissions defining which operations on which cloud services can be performed. Each policy can define multiple permissions. After a policy is granted to a user group, users in the group can obtain all permissions defined by the policy. IAM implements fine-grained permissions management based on the permissions defined by policies. - -IAM supports two types of policies: - -- Default policies: Define the common permissions preset in the system, which are typically read-only or management permissions for cloud services such as ModelArts. Default policies can be used only for authorization and cannot be edited or modified. -- Custom policies: Define the permissions created and managed by users and are the extension and supplement of default policies. diff --git a/modelarts/umn/result/permissions_management/creating_a_custom_policy.rst b/modelarts/umn/result/permissions_management/creating_a_custom_policy.rst deleted file mode 100644 index 5cd0b028..00000000 --- a/modelarts/umn/result/permissions_management/creating_a_custom_policy.rst +++ /dev/null @@ -1,104 +0,0 @@ -.. _modelarts_23_0080: - -Creating a Custom Policy -======================== - -If default policies cannot meet the requirements on fine-grained access control, you can create custom policies and assign the policies to the user group. - -You can create custom policies in either of the following ways: - -- Visual editor: Select cloud services, actions, resources, and request conditions. This does not require knowledge of policy syntax. -- JSON: Edit JSON policies from scratch or based on an existing policy. - -For details about how to create a custom policy, see section "Creating a Custom Policy" in the *Identity and Access Management User Guide*. This section describes :ref:`example custom policies of OBS (a dependent service of ModelArts) ` and :ref:`ModelArts `. - -Precautions ------------ - -- The permissions to use ModelArts depend on OBS authorization. Therefore, you need to grant OBS system permissions to users. -- A custom policy can contain actions of multiple services that are globally accessible or accessible through region-specific projects. -- To define permissions required to access both global and project-level services, create two custom policies and specify the scope as **Global services** and **Project-level services**. Then grant the two policies to the users. - -.. _modelarts_23_0080__en-us_topic_0284259054_en-us_topic_0170867515_section3734428121013: - -Example Custom Policies of OBS ------------------------------- - -ModelArts is a project-level service, and OBS is a global service. Therefore, you need to create custom policies for the two services respectively and grant them to users. The permissions to use ModelArts depend on OBS authorization. The following example shows the minimum permissions for OBS, including the permissions for OBS buckets and objects. After being granted the minimum permissions for OBS, users can access OBS from ModelArts without restrictions. - -.. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Action": [ - "obs:bucket:ListAllMybuckets", - "obs:bucket:HeadBucket", - "obs:bucket:ListBucket", - "obs:bucket:GetBucketLocation", - "obs:object:GetObject", - "obs:object:GetObjectVersion", - "obs:object:PutObject", - "obs:object:DeleteObject", - "obs:object:DeleteObjectVersion", - "obs:object:ListMultipartUploadParts", - "obs:object:AbortMultipartUpload", - "obs:object:GetObjectAcl", - "obs:object:GetObjectVersionAcl", - "obs:bucket:PutBucketAcl" - ], - "Effect": "Allow" - } - ] - } - -.. _modelarts_23_0080__en-us_topic_0284259054_en-us_topic_0170867515_section1493518251395: - -Example Custom Policies of ModelArts ------------------------------------- - -- Example: Denying ExeML project deletion - - A deny policy must be used in conjunction with other policies to take effect. If the permissions assigned to a user contain both Allow and Deny actions, the Deny actions take precedence over the Allow actions. - - The following method can be used if you need to assign permissions of the **ModelArts FullAccess** policy to a user but also forbid the user from deleting ExeML projects. Create a custom policy for denying ExeML project deletion, and assign both policies to the group the user belongs to. Then the user can perform all operations on ModelArts except deleting ExeML projects. The following is an example deny policy: - - .. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Deny", - "Action": [ - "modelarts:exemlProject:delete" - ] - } - ] - } - -- Example: Allowing users to use only development environments - - The following is a policy configuration example for this user: - - .. code-block:: - - { - "Version": "1.1", - "Statement": [ - - { - "Effect": "Allow", - "Action": [ - "modelarts:notebook:list", - "modelarts:notebook:create" , - "modelarts:notebook:get" , - "modelarts:notebook:update" , - "modelarts:notebook:delete" , - "modelarts:notebook:action" , - "modelarts:notebook:access" - ] - } - ] - } diff --git a/modelarts/umn/result/permissions_management/creating_a_user_and_granting_permissions.rst b/modelarts/umn/result/permissions_management/creating_a_user_and_granting_permissions.rst deleted file mode 100644 index dd61cd59..00000000 --- a/modelarts/umn/result/permissions_management/creating_a_user_and_granting_permissions.rst +++ /dev/null @@ -1,93 +0,0 @@ -.. _modelarts_23_0079: - -Creating a User and Granting Permissions -======================================== - -Policy Content --------------- - -A fine-grained policy consists of the policy version (the **Version** field) and statement (the **Statement** field). - -- **Version**: Distinguishes between role-based access control (RBAC) and fine-grained policies. - - - **1.0**: RBAC policies, which are preset in the system and used to grant permissions of each service as a whole. After such a policy is granted to a user, the user has all permissions of the corresponding service. - - **1.1**: Fine-grained policies. A fine-grained policy consists of API-based permissions for operations on specific resource types. Fine-grained policies, as the name suggests, allow for more fine-grained control than RBAC policies. Users granted permissions of such a policy can only perform specific operations on the corresponding service. Fine-grained policies are classified into default and custom policies. - - - Default policies: Preset common permission sets to control read and administrator permissions of different services. - - Custom policies: Permission sets created and managed by users as an extension and supplement to system-defined policies. For example, a custom policy can be created to allow users only to modify ECS specifications. - -- **Statement**: Detailed information about a policy, containing the **Effect** and **Action** elements. - - - Effect - - Valid values for **Effect** include **Allow** and **Deny**. In a custom policy that contains both Allow and Deny statements, the Deny statements take precedence. - - - Action - - The value can be one or more resource operations. - - The value format is *Service name*:*Resource type*:*Action*, for example, **modelarts:exemlProject:create**. - - .. note:: - - - *Service name*: service name. Only lowercase letters are supported, for example, **modelarts**. - - *Resource type* and *Action*: The values are case-insensitive, and the wildcard (*) are allowed. A wildcard (*) can represent all or part of information about resource types and actions for the specific service. - -Example Policies ----------------- - -- A policy can define a single permission, such as the permission to deny ExeML project deletion. - - .. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Deny", - "Action": [ - "modelarts:exemlProject:delete" - ] - } - ] - } - -- A policy can define multiple permissions, such as the permissions to delete an ExeML version and an ExeML project. - - .. code-block:: - - { - "Version": "1.1", - "Statement": [ - { - "Effect": "Allow", - "Action": [ - "modelarts:exemlProjectVersion:delete", - "modelarts:exemlProject:delete" - ] - } - ] - } - -Authentication Logic --------------------- - -IAM authenticates users according to the permissions that the users have been granted. The authentication logic is as follows: - -.. _modelarts_23_0079__en-us_topic_0285383428_en-us_topic_0270979573_fig4148178111014: - -.. figure:: /_static/images/en-us_image_0000001110920802.png - :alt: **Figure 1** Authentication logic - - - **Figure 1** Authentication logic - -.. note:: - - The actions in each policy bear the OR relationship. - -#. A user accesses the system and makes an operation request. -#. The system evaluates all the permissions policies assigned to the user. -#. In these policies, the system looks for explicit deny permissions. If the system finds an explicit deny that applies, it returns a decision of **Deny**, and the authentication ends. -#. If no explicit deny is found, the system looks for allow permissions that would apply to the request. If the system finds an explicit allow permission that applies, it returns a decision of **Allow**, and the authentication ends. -#. If no explicit allow permission is found, the system returns a decision of **Deny**, and the authentication ends. diff --git a/modelarts/umn/result/permissions_management/index.rst b/modelarts/umn/result/permissions_management/index.rst deleted file mode 100644 index ca656150..00000000 --- a/modelarts/umn/result/permissions_management/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0077: - -====================== -Permissions Management -====================== - -.. toctree:: - :maxdepth: 1 - - basic_concepts - creating_a_user_and_granting_permissions - creating_a_custom_policy diff --git a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_access_key_authorization.rst b/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_access_key_authorization.rst deleted file mode 100644 index 6764e0a9..00000000 --- a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_access_key_authorization.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _modelarts_08_0002: - -Configuring Access Key Authorization -==================================== - -To use an access key pair for authorization, you need to obtain the access key pair first and then add the access key pair on the ModelArts management console. If your access key pair changes, you need to add a new one. - -Obtaining an Access Key ------------------------ - -#. On the ModelArts management console, hover over the username in the upper right corner and choose **My Credentials** from the drop-down list. -#. On the **My Credentials** page, choose **Access Keys** > **Create Access Key**. -#. In the **Create Access Key** dialog box that is displayed, enter the verification code received by SMS or email. -#. Click **OK** and save the access key file as prompted. The access key file is saved in the default download folder of the browser. Open the **credentials.csv** file to view the access key (**Access Key Id** and **Secret Access Key**). - -Adding an Access Key --------------------- - -#. Log in to the ModelArts management console. In the navigation pane, choose **Settings**. The **Settings** page is displayed. - -#. Click **Add Authorization**. - -#. In the **Add Authorization** dialog box that is displayed, set **Authorization Method** to **AK/SK**. The username is fixed. Enter the obtained access key pair. - - - **AK**: Enter the value of the **Access Key Id** field in the key file. - - **SK**: Enter the value of the **Secret Access Key** field in the key file. - -#. Select **I have read and agree to the ModelArts Service Statement** and click **Agree**. - - After the configuration is complete, you can view the access key configurations of an account or IAM user on the **Settings** page. diff --git a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_agency_authorization_recommended.rst b/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_agency_authorization_recommended.rst deleted file mode 100644 index fb5b09fd..00000000 --- a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/configuring_agency_authorization_recommended.rst +++ /dev/null @@ -1,79 +0,0 @@ -.. _modelarts_08_0007: - -Configuring Agency Authorization (Recommended) -============================================== - -An agency is used to delegate ModelArts the operation permissions for dependent services such as OBS and SWR. Before using ModelArts, you need to complete agency authorization. - -.. note:: - - If you have used ModelArts before, click **Delete Authorization** in the global configurations area and then create an agency. - -Before You Start ----------------- - -- account - - - Only a cloud account can perform agency authorization to authorize the current account or all IAM users under the current account. - - Multiple IAM users or accounts can use the same agency. - - A maximum of 50 agencies can be created under an account. - -- IAM user - - - If the agency has been authorized, you can view the authorization information on the **Settings** page. - - If an IAM user has not obtained the authorization, ModelArts will display a message indicating that the user has not been authorized when the user accesses the **Add Authorization** page. In this case, contact the administrator of the IAM user to add authorization. Alternatively, you can :ref:`use access keys for authorization `. - -- When configuring an agency, you can use an automatically created agency. For details, see :ref:`Automatically Creating an IAM Agency `. You can also configure an agency. For example, you can configure an IAM user with the agency valid for only one day. - -Configuring Authorization -------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, click **Settings**. The **Settings** page is displayed. - -#. Click **Add Authorization**. - -#. In the **Add Authorization** dialog box that is displayed, set **Authorization Method** to **Agency**, and select the username and agency to be authorized. - - .. table:: **Table 1** Parameters - - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+======================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Authorization Method | Select **Agency**. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Username | Select an account from the drop-down list on the right. By default, **All IAM users (including logged-in account)** is selected, which indicates that authorization will be performed for the logged-in account and all IAM users under the account. All IAM users under the logged-in account are displayed in the drop-down list. You can configure an agency for an IAM user. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Agency | - **Auto Create** (recommended): When you use ModelArts **Settings** for the first time, no agency is available. In this case, you can click **Auto Create** to automatically create an agency for the user selected in **Username**. For details about the automatically created agency, see :ref:`Automatically Creating an IAM Agency `. | - | | - Select an existing agency: If you have created agencies in IAM, you can select an available agency from the drop-down list to authorize the selected user. | - | | - **Create on IAM**: If the automatically created agency cannot meet your requirements, you can click **Create on IAM** to manually create an agency on the IAM management console. If you choose **Create on IAM**, configure at least the **ModelArts CommonOperation** and **OBS Operate Access** permissions. Otherwise, the basic functions of ModelArts will be unavailable. | - +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. After configuring the username and agency, select **I have read and agree to the ModelArts Service Statement** and click **Agree**. - - After the configuration is complete, you can view the agency configurations of an account or IAM user on the **Settings** page. - -.. _modelarts_08_0007__en-us_topic_0284258827_en-us_topic_0256240291_section19256347172519: - -Automatically Creating an IAM Agency ------------------------------------- - -The following provides the details about the agency automatically created by ModelArts. - -- **Agency Name**: For a cloud account, the agency name is **modelarts_agency**. For an IAM user, the agency name is **ma_agency_**. -- **Agency Type**: Select **Cloud service**. -- **Cloud Service**: Select **ModelArts**. -- **Validity Period**: Select **Unlimited**. -- **Permissions**: The **ModelArts CommonOperations**, **OBS OperateAccess**, and **Tenant Administrator** (required for using other dependent services) permissions are automatically added for this agency to use all ModelArts functions. - -Deleting Authorizations ------------------------ - -To better manage your authorization, you can delete the authorization of an IAM user or delete the authorizations of all users in batches. - -- **Deleting the authorization of a user** - - On the **Settings** page, the authorizations configured for IAM users under the current account are displayed. You can click **Delete** in the **Operation** column to delete the authorization of a user. After the deletion takes effect, the user cannot use ModelArts functions. - -- **Deleting authorizations in batches** - - On the **Settings** page, click **Delete Authorization** above the authorization list to delete all authorizations of the current account. After the deletion, the account and all IAM users under the account cannot use ModelArts functions. diff --git a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/index.rst b/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/index.rst deleted file mode 100644 index 7fdd3806..00000000 --- a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_08_0006: - -======================================================= -Configuring Access Authorization (Global Configuration) -======================================================= - -.. toctree:: - :maxdepth: 1 - - overview - configuring_agency_authorization_recommended - configuring_access_key_authorization diff --git a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/overview.rst b/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/overview.rst deleted file mode 100644 index fac4fe5f..00000000 --- a/modelarts/umn/result/preparations/configuring_access_authorization_global_configuration/overview.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _modelarts_08_0005: - -Overview -======== - -When you use ExeML, data management, notebook instances, training jobs, models, and services, ModelArts may need to access dependent services such as OBS and Software Repository for Container (SWR). If ModelArts is not authorized to access the services, these functions cannot be used. - -You can configure access authorization in either of the following ways: - -- **Using an agency** (recommended) - - After agency authorization is configured, the dependent service operation permissions are delegated to ModelArts so that ModelArts can use the dependent services and perform operations on resources on your behalf. - -- **Using the access key** - - You can use the obtained access key pair (AK/SK) to authorize ModelArts to access dependent services and and perform operations on resources. - -Precautions ------------ - -- Agency authorization grants ModelArts permissions on dependent services, such as OBS and SWR. If the OBS permissions are not configured for an IAM user, the user still does not have the permission to operate the services. -- For users who have used ModelArts before, access key authorization has been configured and does not need to be configured again. However, you are advised to use agency authorization again. -- For new users, use agency authorization. diff --git a/modelarts/umn/result/preparations/creating_an_obs_bucket.rst b/modelarts/umn/result/preparations/creating_an_obs_bucket.rst deleted file mode 100644 index 579e305a..00000000 --- a/modelarts/umn/result/preparations/creating_an_obs_bucket.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _modelarts_08_0003: - -Creating an OBS Bucket -====================== - -ModelArts uses OBS to store data and model backups and snapshots, achieving secure, reliable, and low-cost storage. Therefore, before using ModelArts, create an OBS bucket and folders for storing data. - -Procedure ---------- - -#. Log in to OBS Console and create an OBS bucket. For details, see "Creating a Bucket". For example, create an OBS bucket named **c-flowers**. - - .. note:: - - The created OBS bucket and ModelArts are in the same region. - -#. Create a folder for storing data. For details, see "Creating a Folder". For example, create a folder named **flowers** in the created **c-flowers** OBS bucket. diff --git a/modelarts/umn/result/preparations/index.rst b/modelarts/umn/result/preparations/index.rst deleted file mode 100644 index 849d6d74..00000000 --- a/modelarts/umn/result/preparations/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _modelarts_08_0000: - -============ -Preparations -============ - -.. toctree:: - :maxdepth: 1 - - configuring_access_authorization_global_configuration/index - creating_an_obs_bucket diff --git a/modelarts/umn/result/resource_pools.rst b/modelarts/umn/result/resource_pools.rst deleted file mode 100644 index 3074a07c..00000000 --- a/modelarts/umn/result/resource_pools.rst +++ /dev/null @@ -1,124 +0,0 @@ -.. _modelarts_23_0076: - -Resource Pools -============== - -ModelArts Resource Pools ------------------------- - -When using ModelArts to implement AI Development Lifecycle, you can use two different resource pools to train and deploy models. - -- **Public Resource Pool**: provides public large-scale computing clusters, which are allocated based on job parameter settings. Resources are isolated by job. - -- **Dedicated Resource Pool**: provides exclusive compute resources, which can be used for model deployment. It delivers higher efficiency and cannot be shared with other users. - - Create a dedicated resource pool and select the dedicated resource pool during AI development. For details about the dedicated resource pool, see the following: - - :ref:`Dedicated Resource Pool ` - - :ref:`Creating a Dedicated Resource Pool ` - - :ref:`Scaling a Dedicated Resource Pool ` - - :ref:`Deleting a Dedicated Resource Pool ` - -.. _modelarts_23_0076__en-us_topic_0143244658_section6250135125515: - -Dedicated Resource Pool ------------------------ - -- Dedicated resource pools can be used in the following jobs and tasks: notebook instances, training, TensorBoard, and deployment. -- Dedicated resource pools are classified into two types: **Dedicated for Development/Training** and **Dedicated for Service Deployment**. The **Dedicated for Development/Training** type can be used only for notebook instances, training, and TensorBoard. The **Dedicated for Service Deployment** type can be used only for model deployment. -- Dedicated resource pools are available only when they are in the **Running** status. If a dedicated resource pool is unavailable or abnormal, rectify the fault before using it. - -.. _modelarts_23_0076__en-us_topic_0143244658_section4115221610: - -Creating a Dedicated Resource Pool ----------------------------------- - -#. Log in to the ModelArts management console and choose **Dedicated Resource Pools** on the left. - -#. On the **Dedicated Resource Pools** page, select **Dedicated for Development/Training** or **Dedicated for Service Deployment**. - -#. Click **Create** in the upper left corner. The page for creating a dedicated resource pool is displayed. - -#. Set the parameters on the page. For details about how to set parameters, see :ref:`Table 1 ` and :ref:`Table 2 `. - - .. _modelarts_23_0076__en-us_topic_0143244658_table1073325155617: - - .. table:: **Table 1** Parameters of the **Dedicated for Development/Training** type - - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+=======================================================================================================================================================================================================+ - | Resource Type | The default value is and cannot be changed. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Name of a dedicated resource pool. | - | | | - | | The value can contain letters, digits, hyphens (-), and underscores (_). | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of a dedicated resource pool. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Nodes | Select the number of nodes in a dedicated resource pool. More nodes mean higher computing performance. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Specifications | Required specifications. The GPU delivers better performance, and the CPU is more cost-effective. If a flavor is sold out, you can purchase it again only after other users delete the resource pool. | - +-----------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - .. _modelarts_23_0076__en-us_topic_0143244658_table199892206411: - - .. table:: **Table 2** Parameters of the **Dedicated for Service Deployment** type - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+====================================================================================================================================================================================================================================================================================================================================+ - | Resource Type | The default value is **Dedicated for Service Deployment** and cannot be changed. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Name | Name of a dedicated resource pool. | - | | | - | | The value can contain letters, digits, hyphens (-), and underscores (_). | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Description | Brief description of a dedicated resource pool. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Custom Network Configuration | If you enable **Custom Network Configuration**, the service instance runs on the specified network and can communicate with other cloud service resource instances on the network. If you do not enable **Custom Network Configuration**, ModelArts allocates a dedicated network to each user and isolates users from each other. | - | | | - | | If you enable **Custom Network Configuration**, set **VPC**, **Subnet**, and **Security Group**. If no network is available, go to the VPC service and create a network. . | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | AZ | You can select **Random**, **AZ 1**, **AZ 2**, or **AZ 3** based on site requirements. An AZ is a physical region where resources use independent power supplies and networks. AZs are physically isolated but interconnected through an internal network. To enhance workload availability, create nodes in different AZs. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Nodes | Select the number of nodes in a dedicated resource pool. More nodes mean higher computing performance. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Specifications | Required specifications. The GPU delivers better performance. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - -#. After confirming that the specifications are correct, create a dedicated resource pool as prompted. After a dedicated resource pool is created, its status changes to **Running**. - -.. _modelarts_23_0076__en-us_topic_0143244658_section1521854122017: - -Scaling a Dedicated Resource Pool ---------------------------------- - -After a dedicated resource pool is used for a period of time, you can scale out or in the capacity of the resource pool by increasing or decreasing the number of nodes. - -The procedure for scaling is as follows: - -#. Go to the dedicated resource pool management page, locate the row that contains the desired dedicated resource pool, and click **Scale** in the **Operation** column. -#. On the scaling page, increase or decrease the number of nodes. Increasing the node quantity scales out the resource pool whereas decreasing the node quantity scales in the resource pool. Scale the capacity based on service requirements. - - - During capacity expansion, - - During capacity reduction, delete the target nodes in the **Operation** column. To reduce one node, you need to switch off the node in **Node List** to delete the node. - -#. Click **Submit**. After the request is submitted, the dedicated resource pool management page is displayed. - -.. _modelarts_23_0076__en-us_topic_0143244658_section102631431172915: - -Deleting a Dedicated Resource Pool ----------------------------------- - -If a dedicated resource pool is no longer needed during AI service development, you can delete the resource pool to release resources. - -.. note:: - - - After a dedicated resource pool is deleted, the training jobs, notebook instances, and deployment that depend on the resource pool are unavailable. A dedicated resource pool cannot be restored after being deleted. Exercise caution when deleting a dedicated resource pool. - -#. Go to the dedicated resource pool management page, locate the row that contains the desired dedicated resource pool, and click **Delete** in the **Operation** column. -#. In the dialog box that is displayed, click **OK**. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/basic_concepts_of_ai_development.rst b/modelarts/umn/result/service_overview/basic_knowledge/basic_concepts_of_ai_development.rst deleted file mode 100644 index c078971b..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/basic_concepts_of_ai_development.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _modelarts_01_0011: - -Basic Concepts of AI Development -================================ - -Machine learning is classified into supervised, unsupervised, and reinforcement learning. - -- Supervised learning uses labeled samples to adjust the parameters of classifiers to achieve the required performance. It can be considered as learning with a teacher. Common supervised learning includes regression and classification. -- Unsupervised learning is used to find hidden structures in unlabeled data. Clustering is a form of unsupervised learning. -- Reinforcement learning is an area of machine learning concerned with how software agents ought to take actions in an environment so as to maximize some notion of cumulative reward. - -Regression ----------- - -Regression reflects the time feature of data attributes and generates a function that maps one data attribute to an actual variable prediction to find the dependency between the variable and attribute. Regression mainly analyzes data and predicts data and data relationship. Regression can be used for customer development, retention, customer churn prevention, production lifecycle analysis, sales trend prediction, and targeted promotion. - -|image1| - -Classification --------------- - -Classification involves defining a set of categories based on the common features of objects and identifying which category an object belongs to. Classification can be used for customer classification, customer properties, feature analysis, customer satisfaction analysis, and customer purchase trend prediction. - -|image2| - -Clustering ----------- - -Clustering involves grouping a set of objects in such a way that objects in the same group are more similar to each other than to those in other groups. Clustering can be used for customer segmentation, customer characteristic analysis, customer purchase trend prediction, and market segmentation. - -|image3| - -Clustering analyzes data objects and produces class labels. Objects are grouped based on the maximized and minimized similarities to form clusters. In this way, objects in the same cluster are more similar to each other than to those in other clusters. - -.. |image1| image:: /_static/images/en-us_image_0000001110920858.png - -.. |image2| image:: /_static/images/en-us_image_0000001157080805.png - -.. |image3| image:: /_static/images/en-us_image_0000001110760956.png - diff --git a/modelarts/umn/result/service_overview/basic_knowledge/common_concepts_of_modelarts.rst b/modelarts/umn/result/service_overview/basic_knowledge/common_concepts_of_modelarts.rst deleted file mode 100644 index 94aa4e0c..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/common_concepts_of_modelarts.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _modelarts_01_0005: - -Common Concepts of ModelArts -============================ - -ExeML ------ - -ExeML is the process of automating model design, parameter tuning, and model training, model compression, and model deployment with the labeled data. The process is code-free and does not require developers to have experience in model development. A model can be built in three steps: labeling data, training a model, and deploying the model. - -Inference ---------- - -Inference is the process of deriving a new judgment from a known judgment according to a certain strategy. In AI, machines simulate human intelligence, and complete inference based on neural networks. - -Real-Time Inference -------------------- - -Real-time inference specifies a web service that provides an inference result for each inference request. - -Batch Inference ---------------- - -Batch inference specifies a batch job that processes batch data for inference. - -Resource Pool -------------- - -ModelArts provides large-scale computing clusters for model development, training, and deployment. There are two types of resource pools: public resource pool and dedicated resource pool. The public resource pool is provided by default. Dedicated resource pools are created separately and used exclusively. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/data_management.rst b/modelarts/umn/result/service_overview/basic_knowledge/data_management.rst deleted file mode 100644 index 757cc7f1..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/data_management.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_01_0012: - -Data Management -=============== - -During AI development, massive volumes of data need to be processed, and data preparation and labeling usually take more than half of the development time. ModelArts data management provides an efficient data management and labeling framework. It supports various data types such as image, text, audio, and video in a range of labeling scenarios such as image classification, object detection, speech paragraph labeling, and text classification. ModelArts data management can be used in AI projects of computer vision, natural language processing, and audio and video analysis. In addition, it provides functions such as data filtering, data analysis, team labeling, and version management for full-process data labeling. - -Team labeling enables multiple members to label a dataset, improving labeling efficiency. ModelArts allows project-based management for labeling by individual developers, small-scale labeling by small teams, and large-scale labeling by professional teams. - -For large-scale team labeling, ModelArts provides team management, personnel management, and data management to implement the entire process, from project creation, allocation, management, labeling, to acceptance. For small-scale labeling by individuals and small teams, ModelArts provides an easy-to-use labeling tool to minimize project management costs. - -In addition, the labeling platform ensures data security. User data is used only within the authorized scope. The labeling object allocation policy ensures user data privacy and implements data anonymization. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/devenviron.rst b/modelarts/umn/result/service_overview/basic_knowledge/devenviron.rst deleted file mode 100644 index f7c44007..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/devenviron.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_01_0013: - -DevEnviron -========== - -It is challenging to set up a development environment, select an AI algorithm framework and algorithm, debug code, install software, and accelerate hardware. To address these challenges, ModelArts provides DevEnviron to simplify the entire development process. - -- **Mainstream AI algorithm frameworks supported** - - In the machine learning and deep learning fields, popular open-source training and inference frameworks include TensorFlow, PyTorch, MXNet, and MindSpore. ModelArts supports all popular AI computing frameworks and provides a user-friendly development and debugging environment. It supports traditional machine learning algorithms, such as logistic regression, decision tree, and clustering, as well as multiple types of deep learning algorithms, such as the convolutional neural network (CNN), recurrent neural network (RNN), and long short-term memory (LSTM). - -- **Simplified algorithm development for distributed training** - - Deep learning generally requires large-scale GPU clusters for distributed acceleration. For existing open-source frameworks, algorithm developers need to write a large amount of code for distributed training on different hardware, and the acceleration code varies depending on the framework. To resolve these issues, a distributed lightweight framework or SDK is required. The framework or SDK is built on deep learning engines such as TensorFlow, PyTorch, MXNet, and MindSpore to improve the distributed performance and usability of these engines. ModelArts MoXing perfectly suits the needs. The easy-to-use MoXing API/SDK enables you to develop deep learning at low costs. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/exeml.rst b/modelarts/umn/result/service_overview/basic_knowledge/exeml.rst deleted file mode 100644 index 23986445..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/exeml.rst +++ /dev/null @@ -1,20 +0,0 @@ -.. _modelarts_01_0016: - -ExeML -===== - -To implement AI in various industries, AI model development must be simplified. Currently, only a few algorithm engineers and researchers are capable of AI development and optimization. They find it challenging to develop related prototypes into products and projects. Most service developers, however, face difficulties in developing AI algorithms and optimizing parameters. As a result, most enterprises lack comprehensive AI development capabilities. - -ModelArts provides ExeML for service developers who are not experienced in algorithm development to develop algorithms. It automatically generates models based on transfer learning and Neural Architecture Search (NAS), selects parameters for model training, and tunes models for rapid model training and deployment. Based on the labeled data and application scenario provided by developers, ModelArts automatically generates models that meet precision requirements, without the need for coding. The application scenarios include image classification and object detection. Models can be automatically optimized and generated based on the deployment environment and inference speed requirements. - -.. _modelarts_01_0016__en-us_topic_0284258742_en-us_topic_0168462757_fig3430158114210: - -.. figure:: /_static/images/en-us_image_0000001214778791.png - :alt: **Figure 1** Process of using ExeML - - - **Figure 1** Process of using ExeML - -ModelArts ExeML also provides the auto learning white-box capabilities. It opens model parameters and implements template-based development. ExeML helps accelerate the development speed. With ExeML, developers can directly optimize the generated model or retrain the model, instead of setting up a new model. - -The key techniques of automatic deep learning are transfer learning (generating high-quality models based on a small amount of data), automatic design of the model architecture in multiple dimensions (neural network search and adaptive model optimization), and fast, accurate automatic tuning of training parameters. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/index.rst b/modelarts/umn/result/service_overview/basic_knowledge/index.rst deleted file mode 100644 index 2fedb8c3..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _modelarts_01_0009: - -=============== -Basic Knowledge -=============== - -.. toctree:: - :maxdepth: 1 - - introduction_to_the_ai_development_lifecycle - basic_concepts_of_ai_development - common_concepts_of_modelarts - data_management - devenviron - model_training - model_deployment - exeml diff --git a/modelarts/umn/result/service_overview/basic_knowledge/introduction_to_the_ai_development_lifecycle.rst b/modelarts/umn/result/service_overview/basic_knowledge/introduction_to_the_ai_development_lifecycle.rst deleted file mode 100644 index fc8d71d1..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/introduction_to_the_ai_development_lifecycle.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _modelarts_01_0010: - -Introduction to the AI Development Lifecycle -============================================ - -What Is AI ----------- - -Artificial intelligence (AI) is a technology capable of simulating human cognition through machines. The core capability of AI is to make a judgment or prediction based on a given input. - -What Is the Purpose of AI Development -------------------------------------- - -AI development aims to centrally process and extract information from volumes of data to summarize internal patterns of the study objects. - -Massive volumes of collected data are computed, analyzed, summarized, and organized by using appropriate statistics, machine learning, and deep learning methods to maximize data value. - -Basic Process of AI Development -------------------------------- - -The basic process of AI development includes the following steps: determining an objective, preparing data, and training, evaluating, and deploying a model. - -.. _modelarts_01_0010__en-us_topic_0284258735_en-us_topic_0168462752_fig1553185024113: - -.. figure:: /_static/images/en-us_image_0000001110921016.png - :alt: **Figure 1** AI development process - - - **Figure 1** AI development process - -#. **Determine an objective.** - - Before starting AI development, determine what to analyze. What problems do you want to solve? What is the business goal? Sort out the AI development framework and ideas based on the business understanding. For example, image classification and object detection. Different projects have different requirements for data and AI development methods. - -#. **Prepare data.** - - Data preparation refers to data collection and preprocessing. - - Data preparation is the basis of AI development. When you collect and integrate related data based on the determined objective, the most important thing is to ensure the authenticity and reliability of the obtained data. Typically, you cannot collect all the data at the same time. In the data labeling phase, you may find that some data sources are missing and then you may need to repeatedly adjust and optimize the data. - -#. **Train a model.** - - Modeling involves analyzing the prepared data to find the causality, internal relationships, and regular patterns, thereby providing references for commercial decision making. After model training, usually one or more machine learning or deep learning models are generated. These models can be applied to new data to obtain predictions and evaluation results. - -#. **Evaluate the model.** - - A model generated by training needs to be evaluated. Typically, you cannot obtain a satisfactory model after the first evaluation, and may need to repeatedly adjust algorithm parameters and data to further optimize the model. - - Some common metrics, such as the accuracy, recall, and area under the curve (AUC), help you effectively evaluate and obtain a satisfactory model. - -#. **Deploy the model.** - - Model development and training are based on existing data (which may be test data). After a satisfactory model is obtained, the model needs to be formally applied to actual data or newly generated data for prediction, evaluation, and visualization. The findings can then be reported to decision makers in an intuitive way, helping them develop the right business strategies. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/model_deployment.rst b/modelarts/umn/result/service_overview/basic_knowledge/model_deployment.rst deleted file mode 100644 index a249893f..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/model_deployment.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _modelarts_01_0015: - -Model Deployment -================ - -Generally, AI model deployment and large-scale implementation are complex. - -ModelArts resolves this issue by deploying a trained model on different devices in various scenarios with only a few clicks. This secure and reliable one-stop deployment is available for individual developers, enterprises, and device manufacturers. - -.. _modelarts_01_0015__en-us_topic_0284258741_en-us_topic_0168462756_fig104181892237: - -.. figure:: /_static/images/en-us_image_0000001110920824.png - :alt: **Figure 1** Process of deploying a model - - - **Figure 1** Process of deploying a model - -- The real-time inference service features high concurrency, low latency, and elastic scaling. diff --git a/modelarts/umn/result/service_overview/basic_knowledge/model_training.rst b/modelarts/umn/result/service_overview/basic_knowledge/model_training.rst deleted file mode 100644 index 19bf0a9a..00000000 --- a/modelarts/umn/result/service_overview/basic_knowledge/model_training.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _modelarts_01_0014: - -Model Training -============== - -In addition to data and algorithms, developers spend a lot of time configuring model training parameters. Model training parameters determine the model's precision and convergence time. Parameter selection is heavily dependent on developers' experience. Improper parameter selection will affect the model's precision or significantly increase the time required for model training. - -To simplify AI development and improve development efficiency and training performance, ModelArts offers visualized job management, resource management, and version management and automatically performs hyperparameter optimization based on machine learning and reinforcement learning. It provides automatic hyperparameter tuning policies such as learning rate and batch size, and integrates common models. - -Currently, when most developers build models, the models usually have dozens of layers or even hundreds of layers and MB-level or GB-level parameters to meet precision requirements. As a result, the specifications of computing resources are extremely high, especially the computing power of hardware resources, memory, and ROM. The resource specifications on the device side are strictly limited. For example, the computing power on the device side is 1 TFLOPS, the memory size is about 2 GB, and the ROM space is about 2 GB, so the model size on the device side must be limited to 100 KB and the inference delay must be limited to 100 milliseconds. - -Therefore, compression technologies with lossless or near-lossless model precision, such as pruning, quantization, and knowledge distillation, are used to implement automatic model compression and optimization, and automatic iteration of model compression and retraining to control the loss of model precision. The low-bit quantization technology, which eliminates the need for retraining, converts the model from a high-precision floating point to a fixed-point operation. Multiple compression and optimization technologies are used to meet the lightweight requirements of device and edge hardware resources. The model compression technology reduces the precision by less than 1% in specific scenarios. - -When the training data volume is large, the training of the deep learning model is time-consuming. In computer vision technology, ImageNet-1k (a classification dataset containing 1,000 image classes, referred to as ImageNet) is a commonly used dataset. If you use a P100 GPU to train a ResNet-50 model on the dataset, it will take nearly one week. This hinders rapid development of deep learning applications. Therefore, the acceleration of deep learning training has always been an important concern to the academia and the industry. - -Distributed training acceleration needs to be considered in terms of software and hardware. A single optimization method cannot meet expectations. Therefore, optimization of distributed acceleration is a system project. The distributed training architecture needs to be considered in terms of hardware and chip design. To minimize compute and communication delays, many factors need to be considered, including overall compute specifications, network bandwidth, high-speed cache, power consumption, and heat dissipation of the system, and the relationship between compute and communication throughput. - -The software design needs to combine high-performance hardware features to fully use the high-speed hardware network and implement high-bandwidth distributed communication and efficient local data caching. By using training optimization algorithms, such as hybrid parallel, gradient compression, and convolution acceleration, the software and hardware of the distributed training system can be efficiently coordinated and optimized from end to end, and training acceleration can be implemented in a distributed environment of multiple hosts and cards. ModelArts delivers an industry-leading speedup of over 0.8 for ResNet50 on the ImageNet dataset in the distributed environment with thousands of hosts and cards. - -To measure the acceleration performance of distributed deep learning, the following two key indicators are used: - -- Throughput, that is, the amount of data processed in a unit time -- Convergence time, that is, the time required to achieve certain precision - -The throughput depends on server hardware (for example, more AI acceleration chips with higher FLOPS processing capabilities and higher communication bandwidth achieve higher throughput), data reading and caching, data preprocessing, model computing (for example, convolution algorithm selection), and communication topology optimization. Except low-bit computing and gradient (or parameter) compression, most technologies improve throughput without affecting model precision. To achieve the shortest convergence time, optimize the throughput and adjust the parameters. If the parameters are not adjusted properly, the throughput cannot be optimized. If the batch size is set to a small value, the parallel performance of model training will be relatively poor. As a result, the throughput cannot be improved even if the number of compute nodes are increased. - -Users are most concerned about convergence time. The MoXing framework implements full-stack optimization and significantly reduces the training convergence time. For data read and preprocessing, MoXing uses multi-level concurrent input pipelines to prevent data I/Os from becoming a bottleneck. In terms of model computing, MoXing provides hybrid precision calculation, which combines semi-precision and single-precision for the upper layer models and reduces the loss caused by precision calculation through adaptive scaling. Dynamic hyperparameter policies (such as momentum and batch size) are used to minimize the number of epochs required for model convergence. - -ModelArts High-Performance Distributed Training Optimization ------------------------------------------------------------- - -- Automatic hybrid precision to fully utilize hardware computing capabilities -- Dynamic hyperparameter adjustment technologies (dynamic batch size, image size, and momentum) -- Automatic model gradient merging and splitting -- Communication operator scheduling optimization based on BP bubble adaptive computing -- Distributed high-performance communication libraries (NStack and HCCL) -- Distributed data-model hybrid parallel -- Training data compression and multi-level caching diff --git a/modelarts/umn/result/service_overview/functions.rst b/modelarts/umn/result/service_overview/functions.rst deleted file mode 100644 index 892b64a7..00000000 --- a/modelarts/umn/result/service_overview/functions.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _modelarts_01_0003: - -Functions -========= - -AI engineers face challenges in the installation and configuration of various AI tools, data preparation, and model training. To address these challenges, the one-stop AI development platform ModelArts is provided. The platform integrates data preparation, algorithm development, model training, and model deployment into the production environment, allowing AI engineers to perform one-stop AI development. - -.. _modelarts_01_0003__en-us_topic_0284258733_en-us_topic_0129439806_fig3111511145515: - -.. figure:: /_static/images/en-us_image_0000001156920845.png - :alt: **Figure 1** Function overview - - - **Figure 1** Function overview - -ModelArts has the following features: - -- **Data governance** - - Manages data preparation, such as data filtering and labeling, and dataset versions. - -- **Rapid and simplified model training** - - Enables high-performance distributed training and simplifies coding with the self-developed MoXing deep learning framework. - -- **Multi-scenario deployment** - - Deploys models in various production environments, and supports real-time and batch inference. - -- **Auto learning** - - Enables model building without coding and supports image classification, object detection, and predictive analytics. diff --git a/modelarts/umn/result/service_overview/index.rst b/modelarts/umn/result/service_overview/index.rst deleted file mode 100644 index b3d4580c..00000000 --- a/modelarts/umn/result/service_overview/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. _modelarts_01_0000: - -================ -Service Overview -================ - -.. toctree:: - :maxdepth: 1 - - what_is_modelarts - functions - basic_knowledge/index - related_services - permissions_management diff --git a/modelarts/umn/result/service_overview/permissions_management.rst b/modelarts/umn/result/service_overview/permissions_management.rst deleted file mode 100644 index ed4ac560..00000000 --- a/modelarts/umn/result/service_overview/permissions_management.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _modelarts_01_0017: - -Permissions Management -====================== - -If you need to assign different permissions to different employees in your enterprise to access ModelArts resources, IAM is a good choice for fine-grained permissions management. - -Granting Permissions to Users ------------------------------ - -.. _modelarts_01_0017__en-us_topic_0284296677_fig105571112712: - -.. figure:: /_static/images/en-us_image_0000001156920871.png - :alt: **Figure 1** Authorization model - - - **Figure 1** Authorization model - -#. Plan user groups and grant required permissions to each user group. -#. Add a user to a specific user group so that the user can inherit the permissions of the group. - -When personnel changes occur, you only need to change individual user permissions by changing their user group. User groups make permission management more efficient. - -Granting Permissions to Other Accounts --------------------------------------- - -You (account A) can create an agency on IAM to grant required permissions to the delegated account (account B). The administrator of account B grants the **Agent Operator** permissions to the user of account B to enable the user to manage resources in your account (account A). - -Granting Permissions to Federated Users ---------------------------------------- - -You can use IAM to create an IdP and create rules for the IdP to convert federated users into IAM users who have specified permissions to access cloud resources. - -.. _modelarts_01_0017__en-us_topic_0284296677_fig644812451338: - -.. figure:: /_static/images/en-us_image_0000001157080847.png - :alt: **Figure 2** Principles of identity conversion for federated users - - - **Figure 2** Principles of identity conversion for federated users diff --git a/modelarts/umn/result/service_overview/related_services.rst b/modelarts/umn/result/service_overview/related_services.rst deleted file mode 100644 index d7a0cb67..00000000 --- a/modelarts/umn/result/service_overview/related_services.rst +++ /dev/null @@ -1,24 +0,0 @@ -.. _modelarts_01_0006: - -Related Services -================ - -OBS ---- - -ModelArts uses Object Storage Service (OBS) to store data and model backups and snapshots. OBS provides secure, reliable, low-cost storage. For more details, see *Object Storage Service Console Function Overview*. - -CCE ---- - -ModelArts uses Cloud Container Engine (CCE) to deploy models as real-time services. CCE enables high concurrency and provides elastic scaling. For more information about CCE, see *Cloud Container Engine User Guide*. - -SWR ---- - -To use an AI framework that is not supported by ModelArts, use SoftWare Repository for Container (SWR) to customize an image and import the image to ModelArts for training or inference. For more details, see . - -Cloud Eye ---------- - -ModelArts uses Cloud Eye to monitor online services and model loads in real time and send alarms and notifications automatically. For details about Cloud Eye, see *Cloud Eye User Guide*. diff --git a/modelarts/umn/result/service_overview/what_is_modelarts.rst b/modelarts/umn/result/service_overview/what_is_modelarts.rst deleted file mode 100644 index e67e7022..00000000 --- a/modelarts/umn/result/service_overview/what_is_modelarts.rst +++ /dev/null @@ -1,49 +0,0 @@ -.. _modelarts_01_0001: - -What Is ModelArts? -================== - -ModelArts is a one-stop development platform for AI developers. With data preprocessing, semi-automated data labeling, distributed training, automated model building, and model deployment, ModelArts helps AI developers quickly build models and efficiently manage the AI development lifecycle. - -ModelArts covers all stages of AI development, including data processing and model training and deployment. The underlying technologies of ModelArts support various heterogeneous computing resources, allowing developers to flexibly select and use resources. In addition, ModelArts supports popular open-source AI development frameworks such as TensorFlow. Developers can also use self-developed algorithm frameworks to match their usage habits. - -ModelArts aims to simplify AI development. - -Product Architecture --------------------- - -ModelArts supports the entire development process, including data processing, and model training, management, and deployment. - -ModelArts supports various AI application scenarios, such as image classification and object detection. - -.. _modelarts_01_0001__en-us_topic_0284258732_en-us_topic_0129423679_fig19821028175912: - -.. figure:: /_static/images/en-us_image_0000001110920880.png - :alt: **Figure 1** ModelArts architecture - - - **Figure 1** ModelArts architecture - -Product Advantages ------------------- - -- **One-stop platform** - - The out-of-the-box and full-lifecycle AI development platform provides one-stop training, management, and deployment of models. - -- **Easy to use** - - - Automatic optimization of hyperparameters - - Code-free development and simplified operations - -- **High performance** - - - The self-developed MoXing deep learning framework accelerates algorithm development and training. - - Optimized GPU utilization accelerates real-time inference. - -- **Flexible** - - - Popular open-source frameworks available, such as TensorFlow, and MindSpore - - Popular GPUs - - Exclusive use of dedicated resources - - Custom images for custom frameworks and operators diff --git a/modelarts/umn/result/training_management/creating_a_training_job/index.rst b/modelarts/umn/result/training_management/creating_a_training_job/index.rst deleted file mode 100644 index bb2183c1..00000000 --- a/modelarts/umn/result/training_management/creating_a_training_job/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. _modelarts_23_0235: - -======================= -Creating a Training Job -======================= - -.. toctree:: - :maxdepth: 1 - - introduction_to_training_jobs - using_frequently-used_frameworks_to_train_models - using_custom_images_to_train_models diff --git a/modelarts/umn/result/training_management/creating_a_training_job/introduction_to_training_jobs.rst b/modelarts/umn/result/training_management/creating_a_training_job/introduction_to_training_jobs.rst deleted file mode 100644 index 744a3fcc..00000000 --- a/modelarts/umn/result/training_management/creating_a_training_job/introduction_to_training_jobs.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. _modelarts_23_0046: - -Introduction to Training Jobs -============================= - -ModelArts supports multiple types of training jobs during the entire AI development process. Select a creation mode based on the algorithm source. - -Algorithm Sources of Training Jobs ----------------------------------- - -- **Frequently-used** - - If you have used some frequently-used frameworks to develop algorithms locally, you can select a frequently-used framework and create a training job to build a model. For details, see :ref:`Using Frequently-used Frameworks to Train Models `. - -- **Custom** - - If the framework used for algorithm development is not a frequently-used framework, you can build an algorithm into a custom image and use the custom image to create a training job. For details about the operation guide to create a training job, see :ref:`Using Custom Images to Train Models `. For details about the specifications and description of custom images, see :ref:`Specifications for Custom Images Used for Training Jobs `. diff --git a/modelarts/umn/result/training_management/creating_a_training_job/using_custom_images_to_train_models.rst b/modelarts/umn/result/training_management/creating_a_training_job/using_custom_images_to_train_models.rst deleted file mode 100644 index 1f520030..00000000 --- a/modelarts/umn/result/training_management/creating_a_training_job/using_custom_images_to_train_models.rst +++ /dev/null @@ -1,120 +0,0 @@ -.. _modelarts_23_0239: - -Using Custom Images to Train Models -=================================== - -If the framework used for algorithm development is not a frequently-used framework, you can build an algorithm into a custom image and use the custom image to create a training job. - -Prerequisites -------------- - -- Data has been prepared. Specifically, you have created an available dataset in ModelArts, or you have uploaded the dataset used for training to the OBS directory. -- If the algorithm source is **Custom**, create an image and upload the image to SWR. For details, see . -- The training script has been uploaded to the OBS directory. -- At least one empty folder has been created on OBS for storing the training output. -- The account is not in arrears because resources are consumed when training jobs are running. -- The OBS directory you use and ModelArts are in the same region. - -Precautions ------------ - -- In the dataset directory specified for a training job, the names of the files (such as the image file, audio file, and label file) containing data used for training contain 0 to 255 characters. If the names of certain files in the dataset directory contain over 255 characters, the training job will ignore these files and use data in the valid files for training. If the names of all files in the dataset directory contain over 255 characters, no data is available for the training job and the training job fails. -- In the training script, the **Data Source** and **Training Output Path** parameters must be set to the OBS path. Use the to perform read and write operations in the path. - -Creating a Training Job ------------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. By default, the system switches to the **Training Jobs** page. - -#. In the upper left corner of the training job list, click **Create** to switch to the **Create Training Job** page. - -#. Set related parameters. - - a. Set the basic information, including **Name**, **Version**, and **Description**. The **Version** information is automatically generated by the system and named in an ascending order of **V001**, **V002**, and so on. You cannot manually modify it. - - Specify **Name** and **Description** according to actual requirements. - - b. Set job parameters, including the data source, algorithm source, and more. For details, see :ref:`Table 1 `. - - .. _modelarts_23_0239__en-us_topic_0216621184_table1819364517144: - - .. table:: **Table 1** Job parameters - - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Sub-Parameter | Description | - +=========================+=======================+=========================================================================================================================================================================================================================================================================================================+ - | One-Click Configuration | - | If you have saved job parameter configurations in ModelArts, click **One-Click Configuration** and select an existing job parameter configuration as prompted to quickly complete parameter setting for the job. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Algorithm Source | Custom | For details about custom image specifications, see :ref:`Specifications for Custom Images Used for Training Jobs `. | - | | | | - | | | - **Image Path**: SWR URL after the image is uploaded to SWR. For details about how to upload an image, see :ref:`Creating and Uploading a Custom Image `. | - | | | - **Code Directory**: OBS path for storing the training code file. | - | | | - **Boot Command**: Command to boot the training job after the image is started. Set this parameter based on site requirements. If the custom image is based on a basic ModelArts image, set parameters by referring to :ref:`Creating a Training Job Using a Custom Image (GPU) `. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data Source | Dataset | Select an available dataset and its version from the ModelArts **Data Management** module. | - | | | | - | | | - **Dataset**: Select an existing dataset from the drop-down list. If no dataset is available in ModelArts, no result will be displayed in the drop-down list. | - | | | - **Version**: Select a version according to the **Dataset** setting. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Data path | Select the training data from your OBS bucket. On the right of the **Data path** text box, click **Select**. In the dialog box that is displayed, select an OBS folder for storing data. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Training Output Path | - | Storage path of the training result | - | | | | - | | | .. note:: | - | | | | - | | | To minimize errors, select an empty directory for **Training Output Path**. Do not select the directory used for storing the dataset for **Training Output Path**. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Environment Variable | - | Add environment variables based on your image file. This parameter is optional. You can click **Add Environment Variable** to add multiple variable parameters. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Job Log Path | - | Select a path for storing log files generated during job running. | - +-------------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Select resources for the training job. - - .. table:: **Table 2** Resource parameters - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==============================================================================================================================================================================================================================================================================+ - | Resource Pool | Select resource pools for the job. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | If **Resource Pool** is set to **Public resource pools**, select a resource type. Available resource types are **CPU** and **GPU**. | - | | | - | | The GPU resource delivers better performance, and the CPU resource is more cost effective. If the selected algorithm has been defined to use the CPU or GPU, the resource type is automatically displayed on the page. Select the resource type as required. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Specifications | Select a resource flavor based on the resource type. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Compute Nodes | Set the number of compute nodes. If you set **Compute Nodes** to **1**, the standalone computing mode is used. If you set **Compute Nodes** to a value greater than **1**, the distributed computing mode is used. Select a computing mode based on the actual requirements. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - d. Configure **Notification** and select whether to save the parameters of the training job. - - .. table:: **Table 3** Parameters related to notification and parameter configuration saving - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+================================================================================================================================================================================================================================================================================================+ - | Notification | Select the resource pool status to be monitored from the event list, and SMN sends a notification message when the event occurs. | - | | | - | | This parameter is optional. You can choose whether to enable subscription based on actual requirements. If you enable subscription, set the following parameters as required: | - | | | - | | - **Topic**: indicates the topic name. You can create a topic on the SMN console. | - | | - **Event**: indicates the event to be subscribed to. The options are **OnJobRunning**, **OnJobSucceeded**, and **OnJobFailed**, indicating that training is in progress, successful, and failed, respectively. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Saving Training Parameters | If you select this option, the parameter settings of the current job will be saved to facilitate subsequent job creation. | - | | | - | | Select **Save Training Parameters** and specify **Configuration Name** and **Description**. After a training job is created, you can switch to the **Job Parameters** tab page to view your saved job parameter settings. For details, see :ref:`Managing Job Parameters `. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - e. After setting the parameters, click **Next**. - -#. Confirm that the information is correct on the **Confirm** page that is displayed and click **Submit**. Generally, training jobs run for a period of time, which may be several minutes or tens of minutes depending on the amount of your selected data and resources. - - After a custom image job is created, the system authorizes ModelArts to obtain and run the image by default. When you run a custom image job for the first time, ModelArts checks the custom image. For details about the check, see :ref:`Specifications for Custom Images Used for Training Jobs `. You can view the cause of the check failure in the log and modify the custom image based on the log. - - After the image is checked, the background starts the custom image container to run the custom image training job. You can switch to the training job list to view the basic information about training jobs. In the training job list, **Status** of the newly created training job is **Initializing**. If the status changes to **Successful**, the training job ends and the model generated is stored in the location specified by **Training Output Path**. If the status of a training job changes to **Running failed**. Click the name of the training job and view the job logs. Troubleshoot the fault based on the logs. - - .. note:: - - - After an image is reviewed, the image does not need to be reviewed again when being used to create training jobs again. - - The default user of a custom image must be the user whose UID is **1101**. diff --git a/modelarts/umn/result/training_management/creating_a_training_job/using_frequently-used_frameworks_to_train_models.rst b/modelarts/umn/result/training_management/creating_a_training_job/using_frequently-used_frameworks_to_train_models.rst deleted file mode 100644 index 41999a0e..00000000 --- a/modelarts/umn/result/training_management/creating_a_training_job/using_frequently-used_frameworks_to_train_models.rst +++ /dev/null @@ -1,157 +0,0 @@ -.. _modelarts_23_0238: - -Using Frequently-used Frameworks to Train Models -================================================ - -If you use frequently-used frameworks, such as TensorFlow and MXNet, to develop algorithms locally, you can select **Frequently-used** to create training jobs and build models. - -Prerequisites -------------- - -- Data has been prepared. Specifically, you have created an available dataset in ModelArts, or you have uploaded the dataset used for training to the OBS directory. -- If you select **Frequently-used** for **Algorithm Source**, prepare the training script and upload it to the OBS directory. -- At least one empty folder has been created on OBS for storing the training output. -- The account is not in arrears because resources are consumed when training jobs are running. -- The OBS directory you use and ModelArts are in the same region. - -Precautions ------------ - -- In the dataset directory specified for a training job, the names of the files (such as the image file, audio file, and label file) containing data used for training contain 0 to 255 characters. If the names of certain files in the dataset directory contain over 255 characters, the training job will ignore these files and use data in the valid files for training. If the names of all files in the dataset directory contain over 255 characters, no data is available for the training job and the training job fails. -- In the training script, the **Data Source** and **Training Output Path** parameters must be set to the OBS path. Use the to perform read and write operations in the path. - -.. _modelarts_23_0238__en-us_topic_0216621183_section12188201115920: - -Frequently-used AI Frameworks for Training Management ------------------------------------------------------ - -ModelArts supports the following AI engines and versions. - -.. table:: **Table 1** AI engines supported by training jobs - - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Environment | Supported Chip | System Architecture | System Version | AI Engine and Version | Supported CUDA or Ascend Version | - +=======================+================+=====================+================+===================================+==================================+ - | TensorFlow | CPU and GPU | x86_64 | Ubuntu 16.04 | TF-1.13.1-python3.6 | CUDA 10.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | TF-2.1.0-python3.6 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Caffe | CPU and GPU | x86_64 | Ubuntu 16.04 | Caffe-1.0.0-python2.7 | CUDA 8.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Spark_MLlib | CPU | x86_64 | Ubuntu 16.04 | Spark-2.3.2-python3.6 | N/A | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | XGBoost-Sklearn | CPU | x86_64 | Ubuntu 16.04 | Scikit_Learn-0.18.1-python3.6 | N/A | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | PyTorch | CPU and GPU | x86_64 | Ubuntu 16.04 | PyTorch-1.3.0-python3.6 | CUDA 10.0 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | PyTorch-1.4.0-python3.6 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | Ascend-Powered-Engine | Ascend 910 | AArch64 | EulerOS 2.8 | Mindspore-1.1.1-python3.7-aarch64 | C76 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | | | | | TF-1.15-python3.7-aarch64 | C76 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - | MindSpore-GPU | CPU and GPU | x86_64 | Ubuntu 18.04 | MindSpore-1.1.0-python3.7 | CUDA 10.1 | - +-----------------------+----------------+---------------------+----------------+-----------------------------------+----------------------------------+ - -Creating a Training Job ------------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. By default, the system switches to the **Training Jobs** page. - -#. In the upper left corner of the training job list, click **Create** to switch to the **Create Training Job** page. - -#. Set related parameters. - - a. Set the basic information, including **Name**, **Version**, and **Description**. The **Version** information is automatically generated by the system and named in an ascending order of **V001**, **V002**, and so on. You cannot manually modify it. - - Specify **Name** and **Description** according to actual requirements. - - b. Set job parameters, including the data source, algorithm source, and more. For details, see :ref:`Table 2 `. - - .. _modelarts_23_0238__en-us_topic_0216621183_table1819364517144: - - .. table:: **Table 2** Job parameters - - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Sub-Parameter | Description | - +=========================+=======================+======================================================================================================================================================================================================================================================================================================================+ - | One-Click Configuration | - | If you have saved job parameter configurations in ModelArts, click **One-Click Configuration** and select an existing job parameter configuration as prompted to quickly complete parameter setting for the job. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Algorithm Source | Frequently-used | Select an AI engine and its version and specify **Code Directory** and **Boot File**. The framework selected for the AI engine must be the same as the one you select when compiling training code. For example, if TensorFlow is used in your training code, select TensorFlow when you create a training job. | - | | | | - | | | For details about the supported AI engines and versions, see :ref:`Frequently-used AI Frameworks for Training Management `. | - | | | | - | | | If your model requires Python dependency packages, place the dependency packages and their configuration files in the code directory based on the requirements defined in ModelArts. For details, see :ref:`How Do I Create a Training Job When a Dependency Package Is Referenced in a Model? `. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Data Source | Dataset | Select an available dataset and its version from the ModelArts **Data Management** module. | - | | | | - | | | - **Dataset**: Select an existing dataset from the drop-down list. If no dataset is available in ModelArts, no result will be displayed in the drop-down list. | - | | | - **Version**: Select a version according to the **Dataset** setting. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | | Data path | Select the training data from your OBS bucket. On the right of the **Data path** text box, click **Select**. In the dialog box that is displayed, select an OBS folder for storing data. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Training Output Path | - | Select a path for storing the training result. | - | | | | - | | | .. note:: | - | | | | - | | | To minimize errors, select an empty directory for **Training Output Path**. Do not select the directory used for storing the dataset for **Training Output Path**. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Running Parameter | - | Set the command line parameters in the code based on the algorithm code logic. Make sure that the parameter names are the same as those in the code. | - | | | | - | | | For example, **train_steps = 10000**, where **train_steps** is a passing parameter in code. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Job Log Path | - | Select a path for storing log files generated during job running. | - +-------------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - c. Select resources for the training job. - - .. table:: **Table 3** Resource parameters - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+==========================================================================================================================================================================================================================================================================================+ - | Resource Pool | Select resource pools for the job. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Type | If **Resource Pool** is set to **Public resource pools**, select a resource type. Available resource types are **CPU** and **GPU**. | - | | | - | | The GPU resource delivers better performance, and the CPU resource is more cost effective. If the selected algorithm has been defined to use the CPU or GPU, the resource type is automatically displayed on the page. Select the resource type as required. | - | | | - | | .. note:: | - | | | - | | If GPU resources are used in training code, you must select a GPU cluster when selecting a resource pool. Otherwise, the training job may fail. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Specifications | Select a resource flavor based on the resource type. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Compute Nodes | Set the number of compute nodes. If you set **Compute Nodes** to **1**, the standalone computing mode is used. If you set **Compute Nodes** to a value greater than 1, the distributed computing mode is used. Select a computing mode based on the actual requirements. | - | | | - | | When **Frequently-used** of **Algorithm Source** is set to **Caffe**, only standalone training is supported, that is, **Compute Nodes** must be set to **1**. For other options of **Frequently-used**, you can select the standalone or distributed mode based on service requirements. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - d. Configure **Notification** and select whether to save the parameters of the training job. - - .. table:: **Table 4** Parameters related to notification and parameter configuration saving - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +===================================+================================================================================================================================================================================================================================================================================================+ - | Notification | Select the resource pool status to be monitored from the event list, and SMN sends a notification message when the event occurs. | - | | | - | | This parameter is optional. You can choose whether to enable subscription based on actual requirements. If you enable subscription, set the following parameters as required: | - | | | - | | - **Topic**: indicates the topic name. You can create a topic on the SMN console. | - | | - **Event**: indicates the event to be subscribed to. The options are **OnJobRunning**, **OnJobSucceeded**, and **OnJobFailed**, indicating that training is in progress, successful, and failed, respectively. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Saving Training Parameters | If you select this option, the parameter settings of the current job will be saved to facilitate subsequent job creation. | - | | | - | | Select **Save Training Parameters** and specify **Configuration Name** and **Description**. After a training job is created, you can switch to the **Job Parameters** tab page to view your saved job parameter settings. For details, see :ref:`Managing Job Parameters `. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - - e. After setting the parameters, click **Next**. - -#. Confirm that the information is correct on the **Confirm** page that is displayed and click **Submit**. Generally, training jobs run for a period of time, which may be several minutes or tens of minutes depending on the amount of your selected data and resources. - - .. note:: - - After a training job is created, it is started immediately. - - You can switch to the training job list to view the basic information about training jobs. In the training job list, **Status** of the newly created training job is **Initializing**. If the status changes to **Successful**, the training job ends and the model generated is stored in the location specified by **Training Output Path**. If the status of a training job changes to **Running failed**, click the name of the training job and view the job logs. Troubleshoot the fault based on the logs. diff --git a/modelarts/umn/result/training_management/index.rst b/modelarts/umn/result/training_management/index.rst deleted file mode 100644 index 38d8cdf9..00000000 --- a/modelarts/umn/result/training_management/index.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. _modelarts_23_0043: - -=================== -Training Management -=================== - -.. toctree:: - :maxdepth: 1 - - introduction_to_model_training - creating_a_training_job/index - stopping_or_deleting_a_job - managing_training_job_versions - viewing_job_details - managing_job_parameters - managing_visualization_jobs diff --git a/modelarts/umn/result/training_management/introduction_to_model_training.rst b/modelarts/umn/result/training_management/introduction_to_model_training.rst deleted file mode 100644 index 79231b1a..00000000 --- a/modelarts/umn/result/training_management/introduction_to_model_training.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. _modelarts_23_0044: - -Introduction to Model Training -============================== - -ModelArts provides model training for you to view the training effect, based on which you can adjust your model parameters. You can select resource pools (CPU or GPU) with different instance flavors for model training. In addition to the models developed by users, ModelArts also provides built-in algorithms. You can directly adjust parameters of the built-in algorithms, instead of developing a model by yourself, to obtain a satisfactory model. - -Description of the Model Training Function ------------------------------------------- - -.. table:: **Table 1** Function description - - +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Function | Description | Reference | - +==============================+==============================================================================================================================================================================================================================================================================================================================================================+===========================================================+ - | Training job management | You can create training jobs, manage training job versions, and view details of training jobs, and evaluation details. | :ref:`Creating a Training Job ` | - | | | | - | | | :ref:`Managing Training Job Versions ` | - | | | | - | | | :ref:`Viewing Job Details ` | - +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Job parameter management | You can save the parameter settings of a training job (including the data source, algorithm source, running parameters, resource pool parameters, and more) as a job parameter, which can be directly used when you create a training job, eliminating the need to set parameters one by one. As such, the configuration efficiency can be greatly improved. | :ref:`Managing Job Parameters ` | - +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ - | Model training visualization | TensorBoard and MindInsight effectively display the computational graph of a model in the running process, the trend of all metrics in time, and the data used in the training. | :ref:`Managing Visualization Jobs ` | - +------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-----------------------------------------------------------+ diff --git a/modelarts/umn/result/training_management/managing_job_parameters.rst b/modelarts/umn/result/training_management/managing_job_parameters.rst deleted file mode 100644 index ef29bcaf..00000000 --- a/modelarts/umn/result/training_management/managing_job_parameters.rst +++ /dev/null @@ -1,41 +0,0 @@ -.. _modelarts_23_0049: - -Managing Job Parameters -======================= - -You can store the parameter settings in ModelArts during job creation so that you can use the stored settings to create follow-up training jobs, which makes job creation more efficient. - -During the operations of creating, editing, and viewing training jobs, the saved job parameter settings are displayed on the **Job Parameter Mgmt** page. - -Using a Job Parameter Configuration ------------------------------------ - -- Method 1: Using a job parameter configuration on the **Job Parameter Mgmt** page - - Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. On the displayed page, click the **Job Parameter Mgmt** tab. In the job parameter list, click **Creating Training Job** for a job parameter configuration to create a training job based on the job parameter configuration. - -- Method 2: Using a job parameter configuration on the **Creating Training Job** page - - On the **Creating Training Job** page, click **One-Click Configuration**. In the displayed dialog box, select the required job parameter configuration to quickly create an available training job. - -Editing a Job Parameter Configuration -------------------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. On the displayed page, click the **Job Parameter Mgmt** tab. - -#. In the job parameter configuration list, click **Edit** in the **Operation** column in a row. - -#. On the displayed page, modify related parameters by referring to "Creating a Training Job" and click **OK** to save the job parameter settings. - - In the existing job parameter settings, the job name cannot be changed. - -Deleting a Training Job Parameter Configuration ------------------------------------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. On the displayed page, click the **Job Parameter Mgmt** tab. -#. In the job parameter list, click **Delete** in the **Operation** column in a row. -#. In the displayed dialog box, click **OK**. - - .. note:: - - Deleted job parameter configurations cannot be recovered. Therefore, exercise caution when performing this operation. diff --git a/modelarts/umn/result/training_management/managing_training_job_versions.rst b/modelarts/umn/result/training_management/managing_training_job_versions.rst deleted file mode 100644 index 9f9452a6..00000000 --- a/modelarts/umn/result/training_management/managing_training_job_versions.rst +++ /dev/null @@ -1,51 +0,0 @@ -.. _modelarts_23_0047: - -Managing Training Job Versions -============================== - -During model building, you may need to frequently tune the data, training parameters, or the model based on the training results to obtain a satisfactory model. ModelArts allows you to manage training job versions to effectively train your model after the tuning. Specifically, ModelArts generates a version each time when a training is performed. You can quickly get the difference between different versions. - -Viewing Training Job Versions ------------------------------ - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Management** > **Training Jobs**. By default, the system switches to the **Training Jobs** page. - -#. In the training job list, click the name of a training job. - - By default, the basic information about the latest version is displayed. If there are multiple available versions, click **Select Version** in the upper left corner to view a certain version. Click the downward arrow to the left of the version to display job details. - -Comparing Versions of a Training Job ------------------------------------- - -On the **Version Manager** page, click **View Comparison Result** to view the comparison of all or selected versions of the current training job. The comparison result involves the following information: **Running Parameter**, **F1 Score**, **Recall**, **Precision**, and **Accuracy**. - -.. note:: - - The **F1 Score**, **Recall**, **Precision**, and **Accuracy** parameters of a training job are displayed only when the job is created using a built-in algorithm. For training jobs created using frequently-used frameworks or custom images, define the output of these parameters in your training script code. These parameters cannot be viewed on the GUI. - -Shortcut Operations Based on Training Job Versions --------------------------------------------------- - -On the **Version Manager** page, ModelArts provides certain shortcut operation buttons for you to quickly enter the subsequent steps after model training is complete. - -.. table:: **Table 1** Shortcut operation button description - - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Shortcut Operation Button | Description | - +===================================+====================================================================================================================================================================================================================================================================================================================================================================================================================================+ - | Creating Visualization Job | Creates a visualization job (TensorBoard) for the current training version. For details, see :ref:`Managing Visualization Jobs `. | - | | | - | | .. note:: | - | | | - | | TensorBoard supports only the TensorFlow and MXNet engines. Therefore, you can create the TensorBoard jobs only when the AI engine is TensorFlow or MXNet. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Create Model | Creates a model for the current training version. For details about how to create a model, see :ref:`Importing a Model `. You can only create models for training jobs in the **Running** status. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Modify | If the training result of the current version does not meet service requirements or the training job fails, click **Modify** to switch to the page where you can modify the job parameter settings. For details about the parameters of the training job, see :ref:`Creating a Training Job `. After modifying the job parameter settings as required, click **OK** to start the training job of a new version. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Save Training Parameters | You can save the job parameter settings of this version as a job parameter configuration, which will be displayed on the **Job Parameter Mgmt** page. Click **More > Save Training Parameters** to switch to the **Training Parameter** page. After confirming that the settings are correct, click **OK**. For details about training parameter management, see :ref:`Managing Job Parameters `. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Stop | Click **More > Stop** to stop the training job of the current version. Only training jobs in the **Running** state can be stopped. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Delete | Click **More > Delete** to delete the training job of the current version. | - +-----------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/modelarts/umn/result/training_management/managing_visualization_jobs.rst b/modelarts/umn/result/training_management/managing_visualization_jobs.rst deleted file mode 100644 index a8467f79..00000000 --- a/modelarts/umn/result/training_management/managing_visualization_jobs.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _modelarts_23_0050: - -Managing Visualization Jobs -=========================== - -You can create visualization jobs of TensorBoard and MindInsight types on ModelArts. - -TensorBoard supports training jobs based on the TensorFlow engine, and MindInsight supports training jobs based on the MindSpore engine. - -TensorBoard and MindInsight can effectively display the change trend of a training job and the data used in the training. - -You can use the **summary** file generated during model training to create a visualization job. - -Prerequisites -------------- - -To ensure that the **summary** file is generated in the training result, you need to add the related code to the training script. - -- Using the TensorFlow engine: - - When using the TensorFlow-based MoXing, in **mox.run**, set **save_summary_steps>0** and **summary_verbosity≥1**. - - If you want to display other metrics, add tensors to **log_info** in the return value **mox.ModelSpec** of **model_fn**. Only the rank-0 tensors (scalars) are supported. The added tensors are written into the **summary** file. If you want to write tensors of higher ranks in the **summary** file, use the native **tf.summary** of TensorFlow in **model_fn**. - -- Using the MindSpore engine: - - MindSpore allows you to save data to the **summary** log file and display the data on the GUI. For details, see the `MindSpore official website `__. - -Creating a Visualization Job ----------------------------- - -#. Log in to the ModelArts management console. In the left navigation pane, choose **Training Jobs**. On the displayed page, click the **Visualization Jobs** tab. - -#. In the upper left corner of the visualization job list, click **Create** to switch to the **Create Visualization Job** page. - -#. Set **Job Type** to **TensorBoard** and **MindInsight**. Enter the visualization job name and description as required, set the **Training Output Path** and **Auto Stop** parameters. - - - **Training Output Path**: Select the training output path specified when the training job is created. - - **Auto Stop**: Enable or disable the auto stop function. The options are **1 hour later**, **2 hours later**, **4 hours later**, **6 hours later**, and **Custom**. If you select **Custom**, you can enter any integer within 1 to 24 hours in the textbox on the right. - -#. After confirming the specifications, click **Next**. - - In the visualization job list, when the status changes to **Running**, the virtualization job has been created. You can click the name of the visualization job to view its details. - -Opening a Visualization Job ---------------------------- - -In the visualization job list, click the name of the target visualization job. The **TensorBoard** page is displayed. Only the visualization job in the **Running** status can be opened. - -Running or Stopping a Visualization Job ---------------------------------------- - -- **Stopping a visualization job**: In the visualization job list, click **Stop** in the **Operation** column to stop the visualization job. -- **Running a visualization job**: You can run and use a visualization job in the **Canceled** status again. In the visualization job list, click **Run** in the **Operation** column to run the visualization job. - -Deleting a Visualization Job ----------------------------- - -If your visualization job is no longer used, you can delete it to release resources. In the visualization job list, click **Delete** in the **Operation** column to delete the visualization job. - -.. note:: - - A deleted visualized job cannot be recovered. You need to create a new visualization job if you want to use it. Exercise caution when performing this operation. diff --git a/modelarts/umn/result/training_management/stopping_or_deleting_a_job.rst b/modelarts/umn/result/training_management/stopping_or_deleting_a_job.rst deleted file mode 100644 index 814afda0..00000000 --- a/modelarts/umn/result/training_management/stopping_or_deleting_a_job.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. _modelarts_23_0159: - -Stopping or Deleting a Job -========================== - -Stopping a Training Job ------------------------ - -In the training job list, click **Stop** in the **Operation** column for a training job in the **Running** state to stop a running training job. - -If you have selected **Save Training Parameters** for a stopped training job, the job's parameter settings will be saved to the **Job Parameter Mgmt** page. - -You cannot stop a training job that has stopped running, for example the job in the **Successful** or **Running failed** state. Only training jobs in the **Running** state can be stopped. - -Deleting a Training Job ------------------------ - -If an existing training job is no longer used, you can delete it. - -For a training job in the **Running**, **Successful**, **Running failed**, **Canceled**, or **Deploying** state, click **Delete** in the **Operation** column to delete it. - -If you have selected **Save Training Parameters** for a deleted training job, the job's parameter settings will be saved to the **Job Parameter Mgmt** page. diff --git a/modelarts/umn/result/training_management/viewing_job_details.rst b/modelarts/umn/result/training_management/viewing_job_details.rst deleted file mode 100644 index 8ccc309b..00000000 --- a/modelarts/umn/result/training_management/viewing_job_details.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _modelarts_23_0048: - -Viewing Job Details -=================== - -After a training job finishes, you can manage the training job versions and check whether the training result of the job is satisfactory by viewing the :ref:`job details `. - -.. _modelarts_23_0048__en-us_topic_0171858286_section15518121114018: - -Training Job Details --------------------- - -In the left navigation pane of the ModelArts management console, choose **Training Management** > **Training Jobs** to switch to the **Training Jobs** page. In the training job list, click a job name to view the job details. - -:ref:`Table 1 ` lists parameters of the training job of each version. - -.. _modelarts_23_0048__en-us_topic_0171858286_table43451384323: - -.. table:: **Table 1** Training job details - - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Description | - +=================+====================================================================================================================================================================================================================================+ - | Version | Version of a training job, which is automatically defined by the system, for example, **V0001** and **V0002**. | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Status | Status of a training job, | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Duration | Running duration of a training job | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Configurations | Details about the parameters of the current training job version | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Logs | Logs of the current training job version. If you set **Log Output Path** when creating a training job, you can click the download button on the **Logs** tab page to download the logs stored in the OBS bucket to the local host. | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Resource Usages | Usage of resources of the current training version, including the CPU, GPU, and memory. | - +-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+